We recommend new projects start with resources from the AWS provider.
aws-native.rds.DbSubnetGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::RDS::DBSubnetGroup
resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
For more information, see Working with DB subnet groups in the Amazon RDS User Guide.
Create DbSubnetGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbSubnetGroup(name: string, args: DbSubnetGroupArgs, opts?: CustomResourceOptions);
@overload
def DbSubnetGroup(resource_name: str,
args: DbSubnetGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbSubnetGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_subnet_group_description: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
db_subnet_group_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDbSubnetGroup(ctx *Context, name string, args DbSubnetGroupArgs, opts ...ResourceOption) (*DbSubnetGroup, error)
public DbSubnetGroup(string name, DbSubnetGroupArgs args, CustomResourceOptions? opts = null)
public DbSubnetGroup(String name, DbSubnetGroupArgs args)
public DbSubnetGroup(String name, DbSubnetGroupArgs args, CustomResourceOptions options)
type: aws-native:rds:DbSubnetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DbSubnetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DbSubnetGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DbSubnetGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbSubnetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbSubnetGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DbSubnetGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DbSubnetGroup resource accepts the following input properties:
- Db
Subnet stringGroup Description - The description for the DB subnet group.
- Subnet
Ids List<string> - The EC2 Subnet IDs for the DB subnet group.
- Db
Subnet stringGroup Name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- List<Pulumi.
Aws Native. Inputs. Tag> - Tags to assign to the DB subnet group.
- Db
Subnet stringGroup Description - The description for the DB subnet group.
- Subnet
Ids []string - The EC2 Subnet IDs for the DB subnet group.
- Db
Subnet stringGroup Name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- Tag
Args - Tags to assign to the DB subnet group.
- db
Subnet StringGroup Description - The description for the DB subnet group.
- subnet
Ids List<String> - The EC2 Subnet IDs for the DB subnet group.
- db
Subnet StringGroup Name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- List<Tag>
- Tags to assign to the DB subnet group.
- db
Subnet stringGroup Description - The description for the DB subnet group.
- subnet
Ids string[] - The EC2 Subnet IDs for the DB subnet group.
- db
Subnet stringGroup Name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- Tag[]
- Tags to assign to the DB subnet group.
- db_
subnet_ strgroup_ description - The description for the DB subnet group.
- subnet_
ids Sequence[str] - The EC2 Subnet IDs for the DB subnet group.
- db_
subnet_ strgroup_ name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- Sequence[Tag
Args] - Tags to assign to the DB subnet group.
- db
Subnet StringGroup Description - The description for the DB subnet group.
- subnet
Ids List<String> - The EC2 Subnet IDs for the DB subnet group.
- db
Subnet StringGroup Name The name for the DB subnet group. This value is stored as a lowercase string. Constraints:
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
- Must not be default.
- First character must be a letter.
Example:
mydbsubnetgroup
- List<Property Map>
- Tags to assign to the DB subnet group.
Outputs
All input properties are implicitly available as output properties. Additionally, the DbSubnetGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.