Skip to content

Modify Db Subnet Group

docdb_modify_db_subnet_group R Documentation

Modifies an existing subnet group

Description

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

Usage

docdb_modify_db_subnet_group(DBSubnetGroupName,
  DBSubnetGroupDescription, SubnetIds)

Arguments

DBSubnetGroupName

[required] The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

DBSubnetGroupDescription

The description for the subnet group.

SubnetIds

[required] The Amazon EC2 subnet IDs for the subnet group.

Value

A list with the following syntax:

list(
  DBSubnetGroup = list(
    DBSubnetGroupName = "string",
    DBSubnetGroupDescription = "string",
    VpcId = "string",
    SubnetGroupStatus = "string",
    Subnets = list(
      list(
        SubnetIdentifier = "string",
        SubnetAvailabilityZone = list(
          Name = "string"
        ),
        SubnetStatus = "string"
      )
    ),
    DBSubnetGroupArn = "string"
  )
)

Request syntax

svc$modify_db_subnet_group(
  DBSubnetGroupName = "string",
  DBSubnetGroupDescription = "string",
  SubnetIds = list(
    "string"
  )
)