software.amazon.awscdk.services.docdb

Class CfnDBSubnetGroup

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.docdb.CfnDBSubnetGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.018Z")
 @Stability(value=Stable)
public class CfnDBSubnetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDB::DBSubnetGroup`.

The AWS::DocDB::DBSubnetGroup Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region . For more information, see DBSubnetGroup in the Amazon DocumentDB Developer 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.docdb.*;
 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();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBSubnetGroup(software.constructs.Construct scope, String id, CfnDBSubnetGroupProps props) Create a new `AWS::DocDB::DBSubnetGroup`.
protected	CfnDBSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDbSubnetGroupDescription() The description for the subnet group.
String	getDbSubnetGroupName() The name for the subnet group.
List<String>	getSubnetIds() The Amazon EC2 subnet IDs for the subnet group.
TagManager	getTags() The tags to be assigned to the subnet group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDbSubnetGroupDescription(String value) The description for the subnet group.
void	setDbSubnetGroupName(String value) The name for the subnet group.
void	setSubnetIds(List<String> value) The Amazon EC2 subnet IDs for the subnet group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBSubnetGroup

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

CfnDBSubnetGroup

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

CfnDBSubnetGroup

@Stability(value=Stable)
public CfnDBSubnetGroup(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnDBSubnetGroupProps props)

Create a new `AWS::DocDB::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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to be assigned to the subnet group.

getDbSubnetGroupDescription

@Stability(value=Stable)
 @NotNull
public String getDbSubnetGroupDescription()

The description for the subnet group.

setDbSubnetGroupDescription

@Stability(value=Stable)
public void setDbSubnetGroupDescription(@NotNull
                                                                 String value)

The description for the subnet group.

getSubnetIds

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

The Amazon EC2 subnet IDs for the subnet group.

setSubnetIds

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

The Amazon EC2 subnet IDs for the subnet group.

getDbSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getDbSubnetGroupName()

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

setDbSubnetGroupName

@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
                                                          String value)

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup