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

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

Constructors

CreateVpcLink'

Fields

• description :: Maybe Text

  The description of the VPC link.

• tags :: Maybe (HashMap Text Text)

  The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

• name :: Text

  The name used to label and identify the VPC link.

• targetArns :: [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

ToJSON CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

toJSON :: CreateVpcLink -> Value

toEncoding :: CreateVpcLink -> Encoding

toJSONList :: [CreateVpcLink] -> Value

toEncodingList :: [CreateVpcLink] -> Encoding

ToHeaders CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

toHeaders :: CreateVpcLink -> [Header]

ToPath CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

toPath :: CreateVpcLink -> ByteString

ToQuery CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

toQuery :: CreateVpcLink -> QueryString

AWSRequest CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Associated Types

type AWSResponse CreateVpcLink

Methods

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

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

Generic CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Associated Types

type Rep CreateVpcLink :: Type -> Type

Methods

from :: CreateVpcLink -> Rep CreateVpcLink x

to :: Rep CreateVpcLink x -> CreateVpcLink

Read CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

readsPrec :: Int -> ReadS CreateVpcLink

readList :: ReadS [CreateVpcLink]

readPrec :: ReadPrec CreateVpcLink

readListPrec :: ReadPrec [CreateVpcLink]

Show CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

showsPrec :: Int -> CreateVpcLink -> ShowS

show :: CreateVpcLink -> String

showList :: [CreateVpcLink] -> ShowS

NFData CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

rnf :: CreateVpcLink -> ()

Eq CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

(==) :: CreateVpcLink -> CreateVpcLink -> Bool

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

Hashable CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

Methods

hashWithSalt :: Int -> CreateVpcLink -> Int

hash :: CreateVpcLink -> Int

type AWSResponse CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

type AWSResponse CreateVpcLink = VpcLink

type Rep CreateVpcLink

Defined in Amazonka.APIGateway.CreateVpcLink

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

newCreateVpcLink

Arguments

:: Text

CreateVpcLink

-> CreateVpcLink

Create a value of CreateVpcLink 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:

CreateVpcLink, createVpcLink_description - The description of the VPC link.

CreateVpcLink, createVpcLink_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateVpcLink, createVpcLink_name - The name used to label and identify the VPC link.

CreateVpcLink, createVpcLink_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.

Request Lenses

createVpcLink_description :: Lens' CreateVpcLink (Maybe Text)

The description of the VPC link.

createVpcLink_tags :: Lens' CreateVpcLink (Maybe (HashMap Text Text))

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createVpcLink_name :: Lens' CreateVpcLink Text

The name used to label and identify the VPC link.

createVpcLink_targetArns :: Lens' CreateVpcLink [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.

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.