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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a specified VPC link under the caller's account in a region.

Synopsis

data GetVpcLink = GetVpcLink' {
- vpcLinkId :: Text
}
newGetVpcLink :: Text -> GetVpcLink
getVpcLink_vpcLinkId :: Lens' GetVpcLink Text
data VpcLink = VpcLink' {
- status :: Maybe VpcLinkStatus
- targetArns :: Maybe [Text]
- name :: Maybe Text
- statusMessage :: Maybe Text
- id :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
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))

Creating a Request

data GetVpcLink Source #

Gets a specified VPC link under the caller's account in a region.

See: newGetVpcLink smart constructor.

Constructors

GetVpcLink'
Fields vpcLinkId :: Text Required The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Instances

Instances details

Eq GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods (==) :: GetVpcLink -> GetVpcLink -> Bool # (/=) :: GetVpcLink -> GetVpcLink -> Bool #
Read GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods readsPrec :: Int -> ReadS GetVpcLink # readList :: ReadS [GetVpcLink] # readPrec :: ReadPrec GetVpcLink # readListPrec :: ReadPrec [GetVpcLink] #
Show GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods showsPrec :: Int -> GetVpcLink -> ShowS # show :: GetVpcLink -> String # showList :: [GetVpcLink] -> ShowS #
Generic GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Associated Types type Rep GetVpcLink :: Type -> Type # Methods from :: GetVpcLink -> Rep GetVpcLink x # to :: Rep GetVpcLink x -> GetVpcLink #
NFData GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods rnf :: GetVpcLink -> () #
Hashable GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods hashWithSalt :: Int -> GetVpcLink -> Int # hash :: GetVpcLink -> Int #
AWSRequest GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Associated Types type AWSResponse GetVpcLink # Methods request :: GetVpcLink -> Request GetVpcLink # response :: MonadResource m => Logger -> Service -> Proxy GetVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVpcLink))) #
ToHeaders GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toHeaders :: GetVpcLink -> [Header] #
ToPath GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toPath :: GetVpcLink -> ByteString #
ToQuery GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toQuery :: GetVpcLink -> QueryString #
type Rep GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink type Rep GetVpcLink = D1 ('MetaData "GetVpcLink" "Amazonka.APIGateway.GetVpcLink" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetVpcLink'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcLinkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink type AWSResponse GetVpcLink = VpcLink

newGetVpcLink Source #

Arguments

:: Text	`$sel:vpcLinkId:GetVpcLink'`
-> GetVpcLink

Create a value of GetVpcLink 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:vpcLinkId:GetVpcLink', getVpcLink_vpcLinkId - [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Request Lenses

getVpcLink_vpcLinkId :: Lens' GetVpcLink Text Source #

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

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

Instances details

Eq VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods (==) :: VpcLink -> VpcLink -> Bool # (/=) :: VpcLink -> VpcLink -> Bool #
Read VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods readsPrec :: Int -> ReadS VpcLink # readList :: ReadS [VpcLink] # readPrec :: ReadPrec VpcLink # readListPrec :: ReadPrec [VpcLink] #
Show VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods showsPrec :: Int -> VpcLink -> ShowS # show :: VpcLink -> String # showList :: [VpcLink] -> ShowS #
Generic VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Associated Types type Rep VpcLink :: Type -> Type # Methods from :: VpcLink -> Rep VpcLink x # to :: Rep VpcLink x -> VpcLink #
NFData VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods rnf :: VpcLink -> () #
Hashable VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods hashWithSalt :: Int -> VpcLink -> Int # hash :: VpcLink -> Int #
FromJSON VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods parseJSON :: Value -> Parser VpcLink # parseJSONList :: Value -> Parser [VpcLink] #
type Rep VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :: (S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

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.