This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-apigateway/include/aws/apigateway/model/CreateVpcLinkResult.h

393 lines
14 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/apigateway/APIGateway_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/apigateway/model/VpcLinkStatus.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <utility>
namespace Aws
{
template<typename RESULT_TYPE>
class AmazonWebServiceResult;
namespace Utils
{
namespace Json
{
class JsonValue;
} // namespace Json
} // namespace Utils
namespace APIGateway
{
namespace Model
{
/**
* <p>An API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon
* Virtual Private Cloud (VPC).</p> <div class="remarks"> <p><p>To enable access to
* a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you,
* as an API developer, create a <a>VpcLink</a> resource targeted for one or more
* network load balancers of the VPC and then integrate an API method with a
* private integration that uses the <a>VpcLink</a>. The private integration has an
* integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a
* connection type of <code>VPC_LINK</code>. The integration uses the
* <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p>
* </div><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/VpcLink">AWS
* API Reference</a></p>
*/
class AWS_APIGATEWAY_API CreateVpcLinkResult
{
public:
CreateVpcLinkResult();
CreateVpcLinkResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
CreateVpcLinkResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline const Aws::String& GetId() const{ return m_id; }
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline void SetId(const Aws::String& value) { m_id = value; }
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline void SetId(Aws::String&& value) { m_id = std::move(value); }
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline void SetId(const char* value) { m_id.assign(value); }
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline CreateVpcLinkResult& WithId(const Aws::String& value) { SetId(value); return *this;}
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline CreateVpcLinkResult& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;}
/**
* <p>The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to
* reference this <a>VpcLink</a>.</p>
*/
inline CreateVpcLinkResult& WithId(const char* value) { SetId(value); return *this;}
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline void SetName(const Aws::String& value) { m_name = value; }
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline void SetName(Aws::String&& value) { m_name = std::move(value); }
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline void SetName(const char* value) { m_name.assign(value); }
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline CreateVpcLinkResult& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline CreateVpcLinkResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name used to label and identify the VPC link.</p>
*/
inline CreateVpcLinkResult& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The description of the VPC link.</p>
*/
inline const Aws::String& GetDescription() const{ return m_description; }
/**
* <p>The description of the VPC link.</p>
*/
inline void SetDescription(const Aws::String& value) { m_description = value; }
/**
* <p>The description of the VPC link.</p>
*/
inline void SetDescription(Aws::String&& value) { m_description = std::move(value); }
/**
* <p>The description of the VPC link.</p>
*/
inline void SetDescription(const char* value) { m_description.assign(value); }
/**
* <p>The description of the VPC link.</p>
*/
inline CreateVpcLinkResult& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
/**
* <p>The description of the VPC link.</p>
*/
inline CreateVpcLinkResult& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
/**
* <p>The description of the VPC link.</p>
*/
inline CreateVpcLinkResult& WithDescription(const char* value) { SetDescription(value); return *this;}
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline const Aws::Vector<Aws::String>& GetTargetArns() const{ return m_targetArns; }
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline void SetTargetArns(const Aws::Vector<Aws::String>& value) { m_targetArns = value; }
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline void SetTargetArns(Aws::Vector<Aws::String>&& value) { m_targetArns = std::move(value); }
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline CreateVpcLinkResult& WithTargetArns(const Aws::Vector<Aws::String>& value) { SetTargetArns(value); return *this;}
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline CreateVpcLinkResult& WithTargetArns(Aws::Vector<Aws::String>&& value) { SetTargetArns(std::move(value)); return *this;}
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline CreateVpcLinkResult& AddTargetArns(const Aws::String& value) { m_targetArns.push_back(value); return *this; }
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline CreateVpcLinkResult& AddTargetArns(Aws::String&& value) { m_targetArns.push_back(std::move(value)); return *this; }
/**
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The
* network load balancer must be owned by the same AWS account of the API
* owner.</p>
*/
inline CreateVpcLinkResult& AddTargetArns(const char* value) { m_targetArns.push_back(value); return *this; }
/**
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>,
* <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying
* an API will wait if the status is <code>PENDING</code> and will fail if the
* status is <code>DELETING</code>. </p>
*/
inline const VpcLinkStatus& GetStatus() const{ return m_status; }
/**
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>,
* <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying
* an API will wait if the status is <code>PENDING</code> and will fail if the
* status is <code>DELETING</code>. </p>
*/
inline void SetStatus(const VpcLinkStatus& value) { m_status = value; }
/**
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>,
* <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying
* an API will wait if the status is <code>PENDING</code> and will fail if the
* status is <code>DELETING</code>. </p>
*/
inline void SetStatus(VpcLinkStatus&& value) { m_status = std::move(value); }
/**
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>,
* <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying
* an API will wait if the status is <code>PENDING</code> and will fail if the
* status is <code>DELETING</code>. </p>
*/
inline CreateVpcLinkResult& WithStatus(const VpcLinkStatus& value) { SetStatus(value); return *this;}
/**
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>,
* <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying
* an API will wait if the status is <code>PENDING</code> and will fail if the
* status is <code>DELETING</code>. </p>
*/
inline CreateVpcLinkResult& WithStatus(VpcLinkStatus&& value) { SetStatus(std::move(value)); return *this;}
/**
* <p>A description about the VPC link status.</p>
*/
inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; }
/**
* <p>A description about the VPC link status.</p>
*/
inline void SetStatusMessage(const Aws::String& value) { m_statusMessage = value; }
/**
* <p>A description about the VPC link status.</p>
*/
inline void SetStatusMessage(Aws::String&& value) { m_statusMessage = std::move(value); }
/**
* <p>A description about the VPC link status.</p>
*/
inline void SetStatusMessage(const char* value) { m_statusMessage.assign(value); }
/**
* <p>A description about the VPC link status.</p>
*/
inline CreateVpcLinkResult& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;}
/**
* <p>A description about the VPC link status.</p>
*/
inline CreateVpcLinkResult& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;}
/**
* <p>A description about the VPC link status.</p>
*/
inline CreateVpcLinkResult& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;}
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tags = value; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tags = std::move(value); }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; }
/**
* <p>The collection of tags. Each tag element is associated with a given
* resource.</p>
*/
inline CreateVpcLinkResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; }
private:
Aws::String m_id;
Aws::String m_name;
Aws::String m_description;
Aws::Vector<Aws::String> m_targetArns;
VpcLinkStatus m_status;
Aws::String m_statusMessage;
Aws::Map<Aws::String, Aws::String> m_tags;
};
} // namespace Model
} // namespace APIGateway
} // namespace Aws