Amazonka.APIGateway.UpdateVpcLink

Updates an existing VpcLink of a specified identifier.

Creating a Request

data UpdateVpcLink

Updates an existing VpcLink of a specified identifier.

See: newUpdateVpcLink smart constructor.

Constructors

UpdateVpcLink'

Fields

• patchOperations :: Maybe [PatchOperation]

  For more information about supported patch operations, see Patch Operations.

• vpcLinkId :: Text

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

Instances

ToJSON UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

toJSON :: UpdateVpcLink -> Value

toEncoding :: UpdateVpcLink -> Encoding

toJSONList :: [UpdateVpcLink] -> Value

toEncodingList :: [UpdateVpcLink] -> Encoding

ToHeaders UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

toHeaders :: UpdateVpcLink -> [Header]

ToPath UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

toPath :: UpdateVpcLink -> ByteString

ToQuery UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

toQuery :: UpdateVpcLink -> QueryString

AWSRequest UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Associated Types

type AWSResponse UpdateVpcLink

Methods

request :: (Service -> Service) -> UpdateVpcLink -> Request UpdateVpcLink

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateVpcLink)))

Generic UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Associated Types

type Rep UpdateVpcLink :: Type -> Type

Methods

from :: UpdateVpcLink -> Rep UpdateVpcLink x

to :: Rep UpdateVpcLink x -> UpdateVpcLink

Read UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

readsPrec :: Int -> ReadS UpdateVpcLink

readList :: ReadS [UpdateVpcLink]

readPrec :: ReadPrec UpdateVpcLink

readListPrec :: ReadPrec [UpdateVpcLink]

Show UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

showsPrec :: Int -> UpdateVpcLink -> ShowS

show :: UpdateVpcLink -> String

showList :: [UpdateVpcLink] -> ShowS

NFData UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

rnf :: UpdateVpcLink -> ()

Eq UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

(==) :: UpdateVpcLink -> UpdateVpcLink -> Bool

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

Hashable UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

Methods

hashWithSalt :: Int -> UpdateVpcLink -> Int

hash :: UpdateVpcLink -> Int

type AWSResponse UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

type AWSResponse UpdateVpcLink = VpcLink

type Rep UpdateVpcLink

Defined in Amazonka.APIGateway.UpdateVpcLink

type Rep UpdateVpcLink = D1 ('MetaData "UpdateVpcLink" "Amazonka.APIGateway.UpdateVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateVpcLink'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "vpcLinkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateVpcLink

Arguments

:: Text

$sel:vpcLinkId:UpdateVpcLink'

-> UpdateVpcLink

Create a value of UpdateVpcLink 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:patchOperations:UpdateVpcLink', updateVpcLink_patchOperations - For more information about supported patch operations, see Patch Operations.

$sel:vpcLinkId:UpdateVpcLink', updateVpcLink_vpcLinkId - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Request Lenses

updateVpcLink_patchOperations :: Lens' UpdateVpcLink (Maybe [PatchOperation])

For more information about supported patch operations, see Patch Operations.

updateVpcLink_vpcLinkId :: Lens' UpdateVpcLink Text

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

Destructuring the Response

data VpcLink

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See: newVpcLink smart constructor.

Constructors

VpcLink'

Fields

• description :: Maybe Text

  The description of the VPC link.

• id :: Maybe Text

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

• name :: Maybe Text

  The name used to label and identify the VPC link.

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

• statusMessage :: Maybe Text

  A description about the VPC link status.

• tags :: Maybe (HashMap Text Text)

  The collection of tags. Each tag element is associated with a given resource.

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

Instances

FromJSON VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

parseJSON :: Value -> Parser VpcLink

parseJSONList :: Value -> Parser [VpcLink]

Generic VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Associated Types

type Rep VpcLink :: Type -> Type

Methods

from :: VpcLink -> Rep VpcLink x

to :: Rep VpcLink x -> VpcLink

Read VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

readsPrec :: Int -> ReadS VpcLink

readList :: ReadS [VpcLink]

readPrec :: ReadPrec VpcLink

readListPrec :: ReadPrec [VpcLink]

Show VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

showsPrec :: Int -> VpcLink -> ShowS

show :: VpcLink -> String

showList :: [VpcLink] -> ShowS

NFData VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

rnf :: VpcLink -> ()

Eq VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

(==) :: VpcLink -> VpcLink -> Bool

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

Hashable VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

Methods

hashWithSalt :: Int -> VpcLink -> Int

hash :: VpcLink -> Int

type Rep VpcLink

Defined in Amazonka.APIGateway.Types.VpcLink

type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newVpcLink :: VpcLink

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:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$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:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

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

Response Lenses

vpcLink_description :: Lens' VpcLink (Maybe Text)

The description of the VPC link.

vpcLink_id :: Lens' VpcLink (Maybe Text)

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

vpcLink_name :: Lens' VpcLink (Maybe Text)

The name used to label and identify the VPC link.

vpcLink_status :: 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.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text)

A description about the VPC link status.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text))

The collection of tags. Each tag element is associated with a given resource.

vpcLink_targetArns :: Lens' VpcLink (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.