libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.CreateVpcLink

Description

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

Synopsis

Creating a Request

data CreateVpcLink Source #

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

See: newCreateVpcLink smart constructor.

Constructors

CreateVpcLink' 

Fields

  • description :: Maybe Text

    The description of the VPC link.

  • tags :: Maybe (HashMap Text Text)

    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

  • name :: Text
    Required
    The name used to label and identify the VPC link.
  • targetArns :: [Text]
    Required
    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.

Instances

newCreateVpcLink Source #

Create a value of CreateVpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:CreateVpcLink', createVpcLink_description - The description of the VPC link.

$sel:tags:CreateVpcLink', createVpcLink_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

$sel:name:CreateVpcLink', createVpcLink_name - [Required] The name used to label and identify the VPC link.

$sel:targetArns:CreateVpcLink', createVpcLink_targetArns - [Required] 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.

Request Lenses

createVpcLink_description :: Lens' CreateVpcLink (Maybe Text) Source #

The description of the VPC link.

createVpcLink_tags :: Lens' CreateVpcLink (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createVpcLink_name :: Lens' CreateVpcLink Text Source #

Required
The name used to label and identify the VPC link.

createVpcLink_targetArns :: Lens' CreateVpcLink [Text] Source #

Required
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.

Destructuring the Response

data VpcLink Source #

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink 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 VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

See: newVpcLink smart constructor.

Constructors

VpcLink' 

Fields

  • status :: Maybe VpcLinkStatus

    The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

  • targetArns :: Maybe [Text]

    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.

  • name :: Maybe Text

    The name used to label and identify the VPC link.

  • statusMessage :: Maybe Text

    A description about the VPC link status.

  • id :: Maybe Text

    The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

  • description :: Maybe Text

    The description of the VPC link.

  • tags :: Maybe (HashMap Text Text)

    The collection of tags. Each tag element is associated with a given resource.

Instances

newVpcLink :: VpcLink Source #

Create a value of VpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:VpcLink', vpcLink_status - The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

$sel:targetArns:VpcLink', vpcLink_targetArns - 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.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

vpcLink_targetArns :: Lens' VpcLink (Maybe [Text]) Source #

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.

vpcLink_name :: Lens' VpcLink (Maybe Text) Source #

The name used to label and identify the VPC link.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #

A description about the VPC link status.

vpcLink_id :: Lens' VpcLink (Maybe Text) Source #

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_description :: Lens' VpcLink (Maybe Text) Source #

The description of the VPC link.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.