Describe Db Security Groups

rds_describe_db_security_groups

R Documentation

Returns a list of DBSecurityGroup descriptions¶

Description¶

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Usage¶

rds_describe_db_security_groups(DBSecurityGroupName, Filters,
  MaxRecords, Marker)

Arguments¶

DBSecurityGroupName

The name of the DB security group to return details for.

Filters

This parameter isn't currently supported.

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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous describe_db_security_groups request. 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",
  DBSecurityGroups = list(
    list(
      OwnerId = "string",
      DBSecurityGroupName = "string",
      DBSecurityGroupDescription = "string",
      VpcId = "string",
      EC2SecurityGroups = list(
        list(
          Status = "string",
          EC2SecurityGroupName = "string",
          EC2SecurityGroupId = "string",
          EC2SecurityGroupOwnerId = "string"
        )
      ),
      IPRanges = list(
        list(
          Status = "string",
          CIDRIP = "string"
        )
      ),
      DBSecurityGroupArn = "string"
    )
  )
)

Request syntax¶

svc$describe_db_security_groups(
  DBSecurityGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples¶

## Not run: 
# This example lists settings for the specified security group.
svc$describe_db_security_groups(
  DBSecurityGroupName = "mydbsecuritygroup"
)

## End(Not run)