Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rds ]

create-custom-availability-zone

Description

Creates a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-custom-availability-zone
--custom-availability-zone-name <value>
[--existing-vpn-id <value>]
[--new-vpn-tunnel-name <value>]
[--vpn-tunnel-originator-ip <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--custom-availability-zone-name (string)

The name of the custom Availability Zone (AZ).

--existing-vpn-id (string)

The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.

--new-vpn-tunnel-name (string)

The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

Specify this parameter only if ExistingVpnId isn't specified.

--vpn-tunnel-originator-ip (string)

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

Specify this parameter only if ExistingVpnId isn't specified.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

CustomAvailabilityZone -> (structure)

A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__

CustomAvailabilityZoneId -> (string)

The identifier of the custom AZ.

Amazon RDS generates a unique identifier when a custom AZ is created.

CustomAvailabilityZoneName -> (string)

The name of the custom AZ.

CustomAvailabilityZoneStatus -> (string)

The status of the custom AZ.

VpnDetails -> (structure)

Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

VpnId -> (string)

The ID of the VPN.

VpnTunnelOriginatorIP -> (string)

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

VpnGatewayIp -> (string)

The IP address of network traffic from AWS to your on-premises data center.

VpnPSK -> (string)

The preshared key (PSK) for the VPN.

VpnName -> (string)

The name of the VPN.

VpnState -> (string)

The state of the VPN.