Network.AWS.APIGateway.GetVPCLink

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

Creating a Request

getVPCLink

Arguments

:: Text

gvlVpcLinkId

-> GetVPCLink

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 the VpcLink . It is used in an Integration to reference this VpcLink .

data GetVPCLink

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

See: getVPCLink smart constructor.

Instances

Eq GetVPCLink

Methods

(==) :: GetVPCLink -> GetVPCLink -> Bool

(/=) :: GetVPCLink -> GetVPCLink -> Bool

Data GetVPCLink

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetVPCLink -> c GetVPCLink

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetVPCLink

toConstr :: GetVPCLink -> Constr

dataTypeOf :: GetVPCLink -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetVPCLink)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetVPCLink)

gmapT :: (forall b. Data b => b -> b) -> GetVPCLink -> GetVPCLink

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetVPCLink -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetVPCLink -> r

gmapQ :: (forall d. Data d => d -> u) -> GetVPCLink -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetVPCLink -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetVPCLink -> m GetVPCLink

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetVPCLink -> m GetVPCLink

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetVPCLink -> m GetVPCLink

Read GetVPCLink

Methods

readsPrec :: Int -> ReadS GetVPCLink

readList :: ReadS [GetVPCLink]

readPrec :: ReadPrec GetVPCLink

readListPrec :: ReadPrec [GetVPCLink]

Show GetVPCLink

Methods

showsPrec :: Int -> GetVPCLink -> ShowS

show :: GetVPCLink -> String

showList :: [GetVPCLink] -> ShowS

Generic GetVPCLink

Associated Types

type Rep GetVPCLink :: * -> *

Methods

from :: GetVPCLink -> Rep GetVPCLink x

to :: Rep GetVPCLink x -> GetVPCLink

Hashable GetVPCLink

Methods

hashWithSalt :: Int -> GetVPCLink -> Int

hash :: GetVPCLink -> Int

NFData GetVPCLink

Methods

rnf :: GetVPCLink -> ()

AWSRequest GetVPCLink

Associated Types

type Rs GetVPCLink :: *

Methods

request :: GetVPCLink -> Request GetVPCLink

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetVPCLink -> ClientResponse -> m (Response GetVPCLink)

ToHeaders GetVPCLink

Methods

toHeaders :: GetVPCLink -> [Header]

ToPath GetVPCLink

Methods

toPath :: GetVPCLink -> ByteString

ToQuery GetVPCLink

Methods

toQuery :: GetVPCLink -> QueryString

type Rep GetVPCLink

type Rep GetVPCLink = D1 * (MetaData "GetVPCLink" "Network.AWS.APIGateway.GetVPCLink" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" True) (C1 * (MetaCons "GetVPCLink'" PrefixI True) (S1 * (MetaSel (Just Symbol "_gvlVpcLinkId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs GetVPCLink

type Rs GetVPCLink = VPCLink

Request Lenses

gvlVpcLinkId :: Lens' GetVPCLink Text

Required

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

Destructuring the Response

vpcLink :: VPCLink

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 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 - 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 the VpcLink . It is used in an Integration to reference this VpcLink .
• vlDescription - The description of the VPC link.

data VPCLink

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

Eq VPCLink

Methods

(==) :: VPCLink -> VPCLink -> Bool

(/=) :: VPCLink -> VPCLink -> Bool

Data VPCLink

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VPCLink -> c VPCLink

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VPCLink

toConstr :: VPCLink -> Constr

dataTypeOf :: VPCLink -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c VPCLink)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VPCLink)

gmapT :: (forall b. Data b => b -> b) -> VPCLink -> VPCLink

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VPCLink -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VPCLink -> r

gmapQ :: (forall d. Data d => d -> u) -> VPCLink -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> VPCLink -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VPCLink -> m VPCLink

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VPCLink -> m VPCLink

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VPCLink -> m VPCLink

Read VPCLink

Methods

readsPrec :: Int -> ReadS VPCLink

readList :: ReadS [VPCLink]

readPrec :: ReadPrec VPCLink

readListPrec :: ReadPrec [VPCLink]

Show VPCLink

Methods

showsPrec :: Int -> VPCLink -> ShowS

show :: VPCLink -> String

showList :: [VPCLink] -> ShowS

Generic VPCLink

Associated Types

type Rep VPCLink :: * -> *

Methods

from :: VPCLink -> Rep VPCLink x

to :: Rep VPCLink x -> VPCLink

Hashable VPCLink

Methods

hashWithSalt :: Int -> VPCLink -> Int

hash :: VPCLink -> Int

FromJSON VPCLink

Methods

parseJSON :: Value -> Parser VPCLink

parseJSONList :: Value -> Parser [VPCLink]

NFData VPCLink

Methods

rnf :: VPCLink -> ()

type Rep VPCLink

type Rep VPCLink = D1 * (MetaData "VPCLink" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "VPCLink'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_vlStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VPCLinkStatus))) ((:*:) * (S1 * (MetaSel (Just Symbol "_vlTargetARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_vlName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_vlStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_vlId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_vlDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

Response Lenses

vlStatus :: Lens' VPCLink (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 .

vlTargetARNs :: Lens' VPCLink [Text]

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 :: Lens' VPCLink (Maybe Text)

The name used to label and identify the VPC link.

vlStatusMessage :: Lens' VPCLink (Maybe Text)

A description about the VPC link status.

vlId :: Lens' VPCLink (Maybe Text)

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

vlDescription :: Lens' VPCLink (Maybe Text)

The description of the VPC link.