amazonka-route53-2.0: Amazon Route 53 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53.AssociateVPCWithHostedZone

Description

Associates an Amazon VPC with a private hosted zone.

To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

  • aws - Amazon Web Services Regions
  • aws-cn - China Regions
  • aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

Synopsis

Creating a Request

data AssociateVPCWithHostedZone Source #

A complex type that contains information about the request to associate a VPC with a private hosted zone.

See: newAssociateVPCWithHostedZone smart constructor.

Constructors

AssociateVPCWithHostedZone' 

Fields

  • comment :: Maybe Text

    Optional: A comment about the association request.

  • hostedZoneId :: ResourceId

    The ID of the private hosted zone that you want to associate an Amazon VPC with.

    Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

  • vpc :: VPC

    A complex type that contains information about the VPC that you want to associate with a private hosted zone.

Instances

Instances details
ToHeaders AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

ToPath AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

ToQuery AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

ToElement AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

ToXML AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

AWSRequest AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Generic AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Associated Types

type Rep AssociateVPCWithHostedZone :: Type -> Type #

Read AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Show AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

NFData AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Eq AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Hashable AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

type AWSResponse AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

type Rep AssociateVPCWithHostedZone Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

type Rep AssociateVPCWithHostedZone = D1 ('MetaData "AssociateVPCWithHostedZone" "Amazonka.Route53.AssociateVPCWithHostedZone" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "AssociateVPCWithHostedZone'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceId) :*: S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VPC))))

newAssociateVPCWithHostedZone Source #

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

AssociateVPCWithHostedZone, associateVPCWithHostedZone_comment - Optional: A comment about the association request.

AssociateVPCWithHostedZone, associateVPCWithHostedZone_hostedZoneId - The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

$sel:vpc:AssociateVPCWithHostedZone', associateVPCWithHostedZone_vpc - A complex type that contains information about the VPC that you want to associate with a private hosted zone.

Request Lenses

associateVPCWithHostedZone_comment :: Lens' AssociateVPCWithHostedZone (Maybe Text) Source #

Optional: A comment about the association request.

associateVPCWithHostedZone_hostedZoneId :: Lens' AssociateVPCWithHostedZone ResourceId Source #

The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

associateVPCWithHostedZone_vpc :: Lens' AssociateVPCWithHostedZone VPC Source #

A complex type that contains information about the VPC that you want to associate with a private hosted zone.

Destructuring the Response

data AssociateVPCWithHostedZoneResponse Source #

A complex type that contains the response information for the AssociateVPCWithHostedZone request.

See: newAssociateVPCWithHostedZoneResponse smart constructor.

Constructors

AssociateVPCWithHostedZoneResponse' 

Fields

Instances

Instances details
Generic AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Associated Types

type Rep AssociateVPCWithHostedZoneResponse :: Type -> Type #

Read AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Show AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

NFData AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

Eq AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

type Rep AssociateVPCWithHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.AssociateVPCWithHostedZone

type Rep AssociateVPCWithHostedZoneResponse = D1 ('MetaData "AssociateVPCWithHostedZoneResponse" "Amazonka.Route53.AssociateVPCWithHostedZone" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "AssociateVPCWithHostedZoneResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "changeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChangeInfo)))

newAssociateVPCWithHostedZoneResponse Source #

Create a value of AssociateVPCWithHostedZoneResponse 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:httpStatus:AssociateVPCWithHostedZoneResponse', associateVPCWithHostedZoneResponse_httpStatus - The response's http status code.

$sel:changeInfo:AssociateVPCWithHostedZoneResponse', associateVPCWithHostedZoneResponse_changeInfo - A complex type that describes the changes made to your hosted zone.

Response Lenses

associateVPCWithHostedZoneResponse_changeInfo :: Lens' AssociateVPCWithHostedZoneResponse ChangeInfo Source #

A complex type that describes the changes made to your hosted zone.