Package software.amazon.awscdk.services.rds

Class CfnDBSubnetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnDBSubnetGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.060Z") @Stability(Stable) public class CfnDBSubnetGroup extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::DBSubnetGroup.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnDBSubnetGroup cfnDBSubnetGroup = CfnDBSubnetGroup.Builder.create(this, "MyCfnDBSubnetGroup")
         .dbSubnetGroupDescription("dbSubnetGroupDescription")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .dbSubnetGroupName("dbSubnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDBSubnetGroup

      protected CfnDBSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDBSubnetGroup

      protected CfnDBSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDBSubnetGroup

      @Stability(Stable) public CfnDBSubnetGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnDBSubnetGroupProps props)
      Create a new AWS::RDS::DBSubnetGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional array of key-value pairs to apply to this DB subnet group.

    • getDbSubnetGroupDescription

      @Stability(Stable) @NotNull public String getDbSubnetGroupDescription()
      The description for the DB subnet group.

    • setDbSubnetGroupDescription

      @Stability(Stable) public void setDbSubnetGroupDescription(@NotNull String value)
      The description for the DB subnet group.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The EC2 Subnet IDs for the DB subnet group.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The EC2 Subnet IDs for the DB subnet group.

    • getDbSubnetGroupName

      @Stability(Stable) @Nullable public String getDbSubnetGroupName()
      The name for the DB subnet group. This value is stored as a lowercase string.

      Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".

      Example: mysubnetgroup

    • setDbSubnetGroupName

      @Stability(Stable) public void setDbSubnetGroupName(@Nullable String value)
      The name for the DB subnet group. This value is stored as a lowercase string.

      Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".

      Example: mysubnetgroup