software.amazon.awscdk.services.dms

Class CfnReplicationSubnetGroup

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.dms.CfnReplicationSubnetGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:05.644Z")
 @Stability(value=Stable)
public class CfnReplicationSubnetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::ReplicationSubnetGroup`.

The AWS::DMS::ReplicationSubnetGroup resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.

Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. For more information, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API in the AWS Database Migration Service 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.dms.*;
 CfnReplicationSubnetGroup cfnReplicationSubnetGroup = CfnReplicationSubnetGroup.Builder.create(this, "MyCfnReplicationSubnetGroup")
         .replicationSubnetGroupDescription("replicationSubnetGroupDescription")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .replicationSubnetGroupIdentifier("replicationSubnetGroupIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnReplicationSubnetGroup(Construct scope, String id, CfnReplicationSubnetGroupProps props) Create a new `AWS::DMS::ReplicationSubnetGroup`.
protected	CfnReplicationSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReplicationSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getReplicationSubnetGroupDescription() The description for the subnet group.
String	getReplicationSubnetGroupIdentifier() The identifier for the replication subnet group.
List<String>	getSubnetIds() One or more subnet IDs to be assigned to the subnet group.
TagManager	getTags() One or more 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	setReplicationSubnetGroupDescription(String value) The description for the subnet group.
void	setReplicationSubnetGroupIdentifier(String value) The identifier for the replication subnet group.
void	setSubnetIds(List<String> value) One or more subnet IDs to be assigned to the subnet group.

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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

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

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

CfnReplicationSubnetGroup

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

CfnReplicationSubnetGroup

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

CfnReplicationSubnetGroup

@Stability(value=Stable)
public CfnReplicationSubnetGroup(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          CfnReplicationSubnetGroupProps props)

Create a new `AWS::DMS::ReplicationSubnetGroup`.

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()

One or more tags to be assigned to the subnet group.

getReplicationSubnetGroupDescription

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

The description for the subnet group.

setReplicationSubnetGroupDescription

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

The description for the subnet group.

getSubnetIds

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

One or more subnet IDs to be assigned to the subnet group.

setSubnetIds

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

One or more subnet IDs to be assigned to the subnet group.

getReplicationSubnetGroupIdentifier

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

The identifier for the replication subnet group.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier.

setReplicationSubnetGroupIdentifier

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

The identifier for the replication subnet group.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier.