Package software.amazon.awscdk.services.dax

Class CfnSubnetGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dax.CfnSubnetGroup

All Implemented Interfaces:

IInspectable, ISubnetGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:18.158Z")
@Stability(Stable)
public class CfnSubnetGroup
extends CfnResource
implements IInspectable, ISubnetGroupRef

Creates a new 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.dax.*;
 CfnSubnetGroup cfnSubnetGroup = CfnSubnetGroup.Builder.create(this, "MyCfnSubnetGroup")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .description("description")
         .subnetGroupName("subnetGroupName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.dax.ISubnetGroupRef

ISubnetGroupRef.Jsii$Default, ISubnetGroupRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSubnetGroup(software.constructs.Construct scope, String id, CfnSubnetGroupProps props)	Create a new AWS::DAX::SubnetGroup.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the subnet group.
String	getSubnetGroupName()	The name of the subnet group.
SubnetGroupReference	getSubnetGroupRef()	A reference to a SubnetGroup resource.
List<String>	getSubnetIds()	A list of VPC subnet IDs for the subnet group.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnSubnetGroup(Object x)	Checks whether the given object is a CfnSubnetGroup.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the subnet group.
void	setSubnetGroupName(String value)	The name of the subnet group.
void	setSubnetIds(List<String> value)	A list of VPC subnet IDs for the subnet group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnSubnetGroup

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

CfnSubnetGroup

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

CfnSubnetGroup

@Stability(Stable)
public CfnSubnetGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSubnetGroupProps props)

Create a new AWS::DAX::SubnetGroup.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnSubnetGroup

@Stability(Stable)
@NotNull
public static Boolean isCfnSubnetGroup(@NotNull
 Object x)

Checks whether the given object is a CfnSubnetGroup.

Parameters:

x - This parameter is required.

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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSubnetGroupRef

@Stability(Stable)
@NotNull
public SubnetGroupReference getSubnetGroupRef()

A reference to a SubnetGroup resource.

Specified by:

getSubnetGroupRef in interface ISubnetGroupRef

getSubnetIds

@Stability(Stable)
@NotNull
public List<String> getSubnetIds()

A list of VPC subnet IDs for the subnet group.

setSubnetIds

@Stability(Stable)
public void setSubnetIds(@NotNull
 List<String> value)

A list of VPC subnet IDs for the subnet group.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the subnet group.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the subnet group.

getSubnetGroupName

@Stability(Stable)
@Nullable
public String getSubnetGroupName()

The name of the subnet group.

setSubnetGroupName

@Stability(Stable)
public void setSubnetGroupName(@Nullable
 String value)

The name of the subnet group.