rds_describe_custom_availability_zones: Returns information about custom Availability Zones (AZs)

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.

Usage

rds_describe_custom_availability_zones(CustomAvailabilityZoneId,
  Filters, MaxRecords, Marker)

Value

A list with the following syntax:

list(
  Marker = "string",
  CustomAvailabilityZones = list(
    list(
      CustomAvailabilityZoneId = "string",
      CustomAvailabilityZoneName = "string",
      CustomAvailabilityZoneStatus = "string",
      VpnDetails = list(
        VpnId = "string",
        VpnTunnelOriginatorIP = "string",
        VpnGatewayIp = "string",
        VpnPSK = "string",
        VpnName = "string",
        VpnState = "string"
      )
    )
  )
)

Arguments

CustomAvailabilityZoneId

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

Filters

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

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

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

Request syntax

svc$describe_custom_availability_zones(
  CustomAvailabilityZoneId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)