describe-custom-availability-zones¶

Description¶

Returns information about custom Availability Zones (AZs).

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.

Synopsis¶

  describe-custom-availability-zones
[--custom-availability-zone-id <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--custom-availability-zone-id (string)

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

--filters (list)

A filter that specifies one or more custom AZs to describe.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

DescribeDBClusterBacktracks

DescribeDBClusterEndpoints

DescribeDBClusters

DescribeDBInstances

DescribePendingMaintenanceActions

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

One or more filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples¶

To describe the custom Availability Zones

The following describe-custom-availability-zones example retrieves the details of the custom Availability Zones in the AWS Region.

aws rds describe-custom-availability-zones

Output:

{
    "CustomAvailabilityZones": [
        {
            "CustomAvailabilityZoneId": "rds-caz-EXAMPLE1",
            "CustomAvailabilityZoneName": "custom-az-1",
            "CustomAvailabilityZoneStatus": "CREATING",
            "VpnDetails": {
                "VpnId": "3604EXAMPLE-7bdEXAMPLE",
                "VpnTunnelOriginatorIP": "198.51.100.0",
                "VpnGatewayIp": "192.0.2.0",
                "VpnPSK": "388cEXAMPLE8",
                "VpnName": "vpn-EXAMPLE1",
                "VpnState": "AVAILABLE"
            }
        },
        {
            "CustomAvailabilityZoneId": "rds-caz-EXAMPLE2",
            "CustomAvailabilityZoneName": "custom-az-2",
            "CustomAvailabilityZoneStatus": "CREATING",
            "VpnDetails": {
                "VpnId": "360EXAMPLE-82EXAMPLE",
                "VpnTunnelOriginatorIP": "203.0.113.0",
                "VpnGatewayIp": "198.51.100.0",
                "VpnPSK": "c95cEXAMPLE",
                "VpnName": "vpn-EXAMPLE2",
                "VpnState": "AVAILABLE"
            }
        }
    ]
}

For more information, see What is Amazon RDS on VMware? in the Amazon RDS on VMware User Guide.

Output¶

Marker -> (string)

An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

CustomAvailabilityZones -> (list)

The list of CustomAvailabilityZone objects for the Amazon Web Services account.

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

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 Amazon Web Services 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 Amazon Web Services 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.

Table of Contents

Feedback

User Guide