Describe Cluster Subnet Groups

redshift_describe_cluster_subnet_groups

R Documentation

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups

Description

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Usage

redshift_describe_cluster_subnet_groups(ClusterSubnetGroupName,
  MaxRecords, Marker, TagKeys, TagValues)

Arguments

ClusterSubnetGroupName

The name of the cluster subnet group for which information is requested.

MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_cluster_subnet_groups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

TagKeys

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

TagValues

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

Value

A list with the following syntax:

list(
  Marker = "string",
  ClusterSubnetGroups = list(
    list(
      ClusterSubnetGroupName = "string",
      Description = "string",
      VpcId = "string",
      SubnetGroupStatus = "string",
      Subnets = list(
        list(
          SubnetIdentifier = "string",
          SubnetAvailabilityZone = list(
            Name = "string",
            SupportedPlatforms = list(
              list(
                Name = "string"
              )
            )
          ),
          SubnetStatus = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      SupportedClusterIpAddressTypes = list(
        "string"
      )
    )
  )
)

Request syntax

svc$describe_cluster_subnet_groups(
  ClusterSubnetGroupName = "string",
  MaxRecords = 123,
  Marker = "string",
  TagKeys = list(
    "string"
  ),
  TagValues = list(
    "string"
  )
)