Network.AWS.APIGateway.CreateVPCLink

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.

Creating a Request

createVPCLink

Arguments

:: Text

cvlName

-> CreateVPCLink

Creates a value of CreateVPCLink with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cvlDescription - The description of the VPC link.
• cvlName - [Required] The name used to label and identify the VPC link.
• cvlTargetARNs - [Required] 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.

data CreateVPCLink

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: createVPCLink smart constructor.

Instances

Eq CreateVPCLink

Methods

(==) :: CreateVPCLink -> CreateVPCLink -> Bool

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

Data CreateVPCLink

Methods

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

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

toConstr :: CreateVPCLink -> Constr

dataTypeOf :: CreateVPCLink -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateVPCLink

Methods

readsPrec :: Int -> ReadS CreateVPCLink

readList :: ReadS [CreateVPCLink]

readPrec :: ReadPrec CreateVPCLink

readListPrec :: ReadPrec [CreateVPCLink]

Show CreateVPCLink

Methods

showsPrec :: Int -> CreateVPCLink -> ShowS

show :: CreateVPCLink -> String

showList :: [CreateVPCLink] -> ShowS

Generic CreateVPCLink

Associated Types

type Rep CreateVPCLink :: * -> *

Methods

from :: CreateVPCLink -> Rep CreateVPCLink x

to :: Rep CreateVPCLink x -> CreateVPCLink

Hashable CreateVPCLink

Methods

hashWithSalt :: Int -> CreateVPCLink -> Int

hash :: CreateVPCLink -> Int

ToJSON CreateVPCLink

Methods

toJSON :: CreateVPCLink -> Value

toEncoding :: CreateVPCLink -> Encoding

toJSONList :: [CreateVPCLink] -> Value

toEncodingList :: [CreateVPCLink] -> Encoding

NFData CreateVPCLink

Methods

rnf :: CreateVPCLink -> ()

AWSRequest CreateVPCLink

Associated Types

type Rs CreateVPCLink :: *

Methods

request :: CreateVPCLink -> Request CreateVPCLink

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

ToHeaders CreateVPCLink

Methods

toHeaders :: CreateVPCLink -> [Header]

ToPath CreateVPCLink

Methods

toPath :: CreateVPCLink -> ByteString

ToQuery CreateVPCLink

Methods

toQuery :: CreateVPCLink -> QueryString

type Rep CreateVPCLink

type Rep CreateVPCLink = D1 * (MetaData "CreateVPCLink" "Network.AWS.APIGateway.CreateVPCLink" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "CreateVPCLink'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cvlDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cvlName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cvlTargetARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])))))

type Rs CreateVPCLink

type Rs CreateVPCLink = VPCLink

Request Lenses

cvlDescription :: Lens' CreateVPCLink (Maybe Text)

The description of the VPC link.

cvlName :: Lens' CreateVPCLink Text

Required

The name used to label and identify the VPC link.

cvlTargetARNs :: Lens' CreateVPCLink [Text]

Required

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.

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.