Class SubnetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.rds.SubnetGroup
All Implemented Interfaces:
IResource, ISubnetGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:23.626Z") @Stability(Stable) public class SubnetGroup extends Resource implements ISubnetGroup
Class for creating a RDS DB subnet group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 SubnetGroup subnetGroup = SubnetGroup.Builder.create(this, "MySubnetGroup")
         .description("description")
         .vpc(vpc)
         // the properties below are optional
         .removalPolicy(RemovalPolicy.DESTROY)
         .subnetGroupName("subnetGroupName")
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 
  • Constructor Details

    • SubnetGroup

      protected SubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)
    • SubnetGroup

      protected SubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • SubnetGroup

      @Stability(Stable) public SubnetGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull SubnetGroupProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • fromSubnetGroupName

      @Stability(Stable) @NotNull public static ISubnetGroup fromSubnetGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String subnetGroupName)
      Imports an existing subnet group by name.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      subnetGroupName - This parameter is required.
    • getSubnetGroupName

      @Stability(Stable) @NotNull public String getSubnetGroupName()
      The name of the subnet group.
      Specified by:
      getSubnetGroupName in interface ISubnetGroup