SubnetGroup

class aws_cdk.aws_rds.SubnetGroup(scope, id, *, description, vpc, removal_policy=None, subnet_group_name=None, vpc_subnets=None)

Bases: Resource

Class for creating a RDS DB subnet group.

Resource:: AWS::RDS::DBSubnetGroup
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_rds as rds
import aws_cdk.core as cdk

# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

subnet_group = rds.SubnetGroup(self, "MySubnetGroup",
    description="description",
    vpc=vpc,

    # the properties below are optional
    removal_policy=cdk.RemovalPolicy.DESTROY,
    subnet_group_name="subnetGroupName",
    vpc_subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnet_name="subnetName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.ISOLATED
    )
)

Parameters:

scope (Construct)
id (str)
description (str) – Description of the subnet group.
vpc (IVpc) – The VPC to place the subnet group in.
removal_policy (Optional[RemovalPolicy]) – The removal policy to apply when the subnet group are removed from the stack or replaced during an update. Default: RemovalPolicy.DESTROY
subnet_group_name (Optional[str]) – The name of the subnet group. Default: - a name is generated
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Which subnets within the VPC to associate with this group. Default: - private subnets

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

subnet_group_name: The name of the subnet group.

Static Methods

classmethod from_subnet_group_name(scope, id, subnet_group_name)

Imports an existing subnet group by name.

Parameters:

scope (Construct)
id (str)
subnet_group_name (str)

Return type:

ISubnetGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool