| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.APIGateway.Types.VpcLink
Description
Synopsis
- data VpcLink = VpcLink' {}
- newVpcLink :: VpcLink
- vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus)
- vpcLink_targetArns :: Lens' VpcLink (Maybe [Text])
- vpcLink_name :: Lens' VpcLink (Maybe Text)
- vpcLink_statusMessage :: Lens' VpcLink (Maybe Text)
- vpcLink_id :: Lens' VpcLink (Maybe Text)
- vpcLink_description :: Lens' VpcLink (Maybe Text)
- vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text))
Documentation
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
| |
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.
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.