Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Gets a specified VPC link under the caller's account in a region.
Synopsis
- getVPCLink :: Text -> GetVPCLink
- data GetVPCLink
- gvlVpcLinkId :: Lens' GetVPCLink Text
- vpcLink :: VPCLink
- data VPCLink
- vlStatus :: Lens' VPCLink (Maybe VPCLinkStatus)
- vlTargetARNs :: Lens' VPCLink [Text]
- vlName :: Lens' VPCLink (Maybe Text)
- vlStatusMessage :: Lens' VPCLink (Maybe Text)
- vlId :: Lens' VPCLink (Maybe Text)
- vlDescription :: Lens' VPCLink (Maybe Text)
Creating a Request
Creates a value of GetVPCLink
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gvlVpcLinkId
- [Required] The identifier of theVpcLink
. It is used in anIntegration
to reference thisVpcLink
.
data GetVPCLink Source #
Gets a specified VPC link under the caller's account in a region.
See: getVPCLink
smart constructor.
Instances
Request Lenses
gvlVpcLinkId :: Lens' GetVPCLink Text Source #
- Required
- The identifier of the
VpcLink
. It is used in anIntegration
to reference thisVpcLink
.
Destructuring the Response
Creates a value of VPCLink
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vlStatus
- The status of the VPC link. The valid values areAVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
.vlTargetARNs
- The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.vlName
- The name used to label and identify the VPC link.vlStatusMessage
- A description about the VPC link status.vlId
- The identifier of theVpcLink
. It is used in anIntegration
to reference thisVpcLink
.vlDescription
- The description of the VPC link.
A 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: vpcLink
smart constructor.
Instances
Response Lenses
vlStatus :: 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
.
vlTargetARNs :: Lens' VPCLink [Text] Source #
The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.