Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.407Z") @Stability(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 AWS Region .

Resource creation fails if the dms-vpc-role AWS Identity and Access Management ( 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();

  • 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

    • CfnReplicationSubnetGroup

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

    • CfnReplicationSubnetGroup

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

    • CfnReplicationSubnetGroup

      @Stability(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 Details

    • 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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      One or more tags to be assigned to the subnet group.

    • getReplicationSubnetGroupDescription

      @Stability(Stable) @NotNull public String getReplicationSubnetGroupDescription()
      The description for the subnet group.

    • setReplicationSubnetGroupDescription

      @Stability(Stable) public void setReplicationSubnetGroupDescription(@NotNull String value)
      The description for the subnet group.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      One or more subnet IDs to be assigned to the subnet group.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      One or more subnet IDs to be assigned to the subnet group.

    • getReplicationSubnetGroupIdentifier

      @Stability(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(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.