software.amazon.awscdk.services.rds

Class SubnetGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.rds.SubnetGroup

All Implemented Interfaces:

IConstruct, IDependable, IResource, ISubnetGroup

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:02.117Z")
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.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 import software.amazon.awscdk.core.*;
 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")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubnetGroup.Builder A fluent builder for SubnetGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.ISubnetGroup

ISubnetGroup.Jsii$Default, ISubnetGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)
	SubnetGroup(software.constructs.Construct scope, java.lang.String id, SubnetGroupProps props)

Method Summary

Modifier and Type	Method and Description
static ISubnetGroup	fromSubnetGroupName(software.constructs.Construct scope, java.lang.String id, java.lang.String subnetGroupName) Imports an existing subnet group by name.
java.lang.String	getSubnetGroupName() The name of the subnet group.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

SubnetGroup

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

SubnetGroup

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

SubnetGroup

public SubnetGroup(software.constructs.Construct scope,
                   java.lang.String id,
                   SubnetGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromSubnetGroupName

public static ISubnetGroup fromSubnetGroupName(software.constructs.Construct scope,
                                               java.lang.String id,
                                               java.lang.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

public java.lang.String getSubnetGroupName()

The name of the subnet group.

Specified by:

getSubnetGroupName in interface ISubnetGroup