Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . route53 ]

associate-vpc-with-hosted-zone

Description

Associates an Amazon vpc with a private hosted zone.

Warning

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.

Note

If you want to associate a vpc that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a create-vpc-association-authorization request. Then the account that created the vpc must submit an associate-vpc-with-hosted-zone request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  associate-vpc-with-hosted-zone
--hosted-zone-id <value>
--vpc <value>
[--comment <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--hosted-zone-id (string)

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 (structure)

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

Shorthand Syntax:

VPCRegion=string,VPCId=string

JSON Syntax:

{
  "VPCRegion": "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-south-1"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"sa-east-1"|"ca-central-1"|"cn-north-1",
  "VPCId": "string"
}

--comment (string)

Optional: A comment about the association request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ChangeInfo -> (structure)

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

Id -> (string)

The ID of the request.

Status -> (string)

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

SubmittedAt -> (timestamp)

The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

Comment -> (string)

A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a get-change action to get detailed information about the change.