Returns a list of cache subnet group descriptions¶

Description¶

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

Usage¶

elasticache_describe_cache_subnet_groups(CacheSubnetGroupName,
  MaxRecords, Marker)

Arguments¶

• CacheSubnetGroupName

  The name of the cache subnet group to return details for.

• MaxRecords

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: minimum 20; maximum 100.

• Marker

  An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value¶

A list with the following syntax:

list(
  Marker = "string",
  CacheSubnetGroups = list(
    list(
      CacheSubnetGroupName = "string",
      CacheSubnetGroupDescription = "string",
      VpcId = "string",
      Subnets = list(
        list(
          SubnetIdentifier = "string",
          SubnetAvailabilityZone = list(
            Name = "string"
          ),
          SubnetOutpost = list(
            SubnetOutpostArn = "string"
          ),
          SupportedNetworkTypes = list(
            "ipv4"|"ipv6"|"dual_stack"
          )
        )
      ),
      ARN = "string",
      SupportedNetworkTypes = list(
        "ipv4"|"ipv6"|"dual_stack"
      )
    )
  )
)

Request syntax¶

svc$describe_cache_subnet_groups(
  CacheSubnetGroupName = "string",
  MaxRecords = 123,
  Marker = "string"
)

Examples¶

# Describes up to 25 cache subnet groups.
svc$describe_cache_subnet_groups(
  MaxRecords = 25L
)