Network.AWS.APIGateway.UpdateVPCLink

Updates an existing VpcLink of a specified identifier.

Creating a Request

updateVPCLink

Arguments

:: Text

uvlVpcLinkId

-> UpdateVPCLink

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

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

• uvlPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uvlVpcLinkId - [Required] The identifier of the VpcLink . It is used in an Integration to reference this VpcLink .

data UpdateVPCLink

Updates an existing VpcLink of a specified identifier.

See: updateVPCLink smart constructor.

Instances

Eq UpdateVPCLink

Methods

(==) :: UpdateVPCLink -> UpdateVPCLink -> Bool

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

Data UpdateVPCLink

Methods

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

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

toConstr :: UpdateVPCLink -> Constr

dataTypeOf :: UpdateVPCLink -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateVPCLink

Methods

readsPrec :: Int -> ReadS UpdateVPCLink

readList :: ReadS [UpdateVPCLink]

readPrec :: ReadPrec UpdateVPCLink

readListPrec :: ReadPrec [UpdateVPCLink]

Show UpdateVPCLink

Methods

showsPrec :: Int -> UpdateVPCLink -> ShowS

show :: UpdateVPCLink -> String

showList :: [UpdateVPCLink] -> ShowS

Generic UpdateVPCLink

Associated Types

type Rep UpdateVPCLink :: * -> *

Methods

from :: UpdateVPCLink -> Rep UpdateVPCLink x

to :: Rep UpdateVPCLink x -> UpdateVPCLink

Hashable UpdateVPCLink

Methods

hashWithSalt :: Int -> UpdateVPCLink -> Int

hash :: UpdateVPCLink -> Int

ToJSON UpdateVPCLink

Methods

toJSON :: UpdateVPCLink -> Value

toEncoding :: UpdateVPCLink -> Encoding

toJSONList :: [UpdateVPCLink] -> Value

toEncodingList :: [UpdateVPCLink] -> Encoding

NFData UpdateVPCLink

Methods

rnf :: UpdateVPCLink -> ()

AWSRequest UpdateVPCLink

Associated Types

type Rs UpdateVPCLink :: *

Methods

request :: UpdateVPCLink -> Request UpdateVPCLink

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

ToHeaders UpdateVPCLink

Methods

toHeaders :: UpdateVPCLink -> [Header]

ToPath UpdateVPCLink

Methods

toPath :: UpdateVPCLink -> ByteString

ToQuery UpdateVPCLink

Methods

toQuery :: UpdateVPCLink -> QueryString

type Rep UpdateVPCLink

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

type Rs UpdateVPCLink

type Rs UpdateVPCLink = VPCLink

Request Lenses

uvlPatchOperations :: Lens' UpdateVPCLink [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

uvlVpcLinkId :: Lens' UpdateVPCLink 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.