Package software.amazon.awscdk.services.drs

Class CfnReplicationConfigurationTemplate

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.drs.CfnReplicationConfigurationTemplate
All Implemented Interfaces:
IInspectable, IReplicationConfigurationTemplateRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:49.584Z") @Stability(Stable) public class CfnReplicationConfigurationTemplate extends CfnResource implements IInspectable, IReplicationConfigurationTemplateRef, ITaggableV2
A replication configuration template for AWS Elastic Disaster Recovery Service.

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.drs.*;
 CfnReplicationConfigurationTemplate cfnReplicationConfigurationTemplate = CfnReplicationConfigurationTemplate.Builder.create(this, "MyCfnReplicationConfigurationTemplate")
         .bandwidthThrottling(123)
         .ebsEncryption("ebsEncryption")
         .pitPolicy(List.of(PITPolicyRuleProperty.builder()
                 .interval(123)
                 .retentionDuration(123)
                 .units("units")
                 // the properties below are optional
                 .enabled(false)
                 .ruleId(123)
                 .build()))
         .replicationServersSecurityGroupsIDs(List.of("replicationServersSecurityGroupsIDs"))
         .stagingAreaSubnetId("stagingAreaSubnetId")
         .stagingAreaTags(Map.of(
                 "stagingAreaTagsKey", "stagingAreaTags"))
         // the properties below are optional
         .associateDefaultSecurityGroup(false)
         .autoReplicateNewDisks(false)
         .createPublicIp(false)
         .dataPlaneRouting("dataPlaneRouting")
         .defaultLargeStagingDiskType("defaultLargeStagingDiskType")
         .ebsEncryptionKeyArn("ebsEncryptionKeyArn")
         .internetProtocol("internetProtocol")
         .replicationServerInstanceType("replicationServerInstanceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useDedicatedReplicationServer(false)
         .build();

See Also:

  • 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

    • CfnReplicationConfigurationTemplate

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

    • CfnReplicationConfigurationTemplate

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

    • CfnReplicationConfigurationTemplate

      @Stability(Stable) public CfnReplicationConfigurationTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnReplicationConfigurationTemplateProps props)
      Create a new AWS::DRS::ReplicationConfigurationTemplate.

      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

    • arnForReplicationConfigurationTemplate

      @Stability(Stable) @NotNull public static String arnForReplicationConfigurationTemplate(@NotNull IReplicationConfigurationTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnReplicationConfigurationTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnReplicationConfigurationTemplate(@NotNull Object x)
      Checks whether the given object is a CfnReplicationConfigurationTemplate.

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Replication Configuration Template ARN.

    • getAttrReplicationConfigurationTemplateId

      @Stability(Stable) @NotNull public String getAttrReplicationConfigurationTemplateId()
      The Replication Configuration Template ID.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getReplicationConfigurationTemplateRef

      @Stability(Stable) @NotNull public ReplicationConfigurationTemplateReference getReplicationConfigurationTemplateRef()
      A reference to a ReplicationConfigurationTemplate resource.
      Specified by:
      getReplicationConfigurationTemplateRef in interface IReplicationConfigurationTemplateRef

    • getBandwidthThrottling

      @Stability(Stable) @NotNull public Number getBandwidthThrottling()
      Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

    • setBandwidthThrottling

      @Stability(Stable) public void setBandwidthThrottling(@NotNull Number value)
      Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

    • getEbsEncryption

      @Stability(Stable) @NotNull public String getEbsEncryption()
      The type of EBS encryption to be used during replication.

    • setEbsEncryption

      @Stability(Stable) public void setEbsEncryption(@NotNull String value)
      The type of EBS encryption to be used during replication.

    • getPitPolicy

      @Stability(Stable) @NotNull public Object getPitPolicy()
      The Point in time (PIT) policy to manage snapshots taken during replication.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnReplicationConfigurationTemplate.PITPolicyRuleProperty>

    • setPitPolicy

      @Stability(Stable) public void setPitPolicy(@NotNull IResolvable value)
      The Point in time (PIT) policy to manage snapshots taken during replication.

    • setPitPolicy

      @Stability(Stable) public void setPitPolicy(@NotNull List<Object> value)
      The Point in time (PIT) policy to manage snapshots taken during replication.

    • getReplicationServersSecurityGroupsIDs

      @Stability(Stable) @NotNull public List<String> getReplicationServersSecurityGroupsIDs()
      The security group IDs that will be used by the replication server.

    • setReplicationServersSecurityGroupsIDs

      @Stability(Stable) public void setReplicationServersSecurityGroupsIDs(@NotNull List<String> value)
      The security group IDs that will be used by the replication server.

    • getStagingAreaSubnetId

      @Stability(Stable) @NotNull public String getStagingAreaSubnetId()
      The subnet to be used by the replication staging area.

    • setStagingAreaSubnetId

      @Stability(Stable) public void setStagingAreaSubnetId(@NotNull String value)
      The subnet to be used by the replication staging area.

    • getStagingAreaTags

      @Stability(Stable) @NotNull public Object getStagingAreaTags()
      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

      Returns union: either IResolvable or Mapinvalid input: '<'String, String>

    • setStagingAreaTags

      @Stability(Stable) public void setStagingAreaTags(@NotNull IResolvable value)
      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

    • setStagingAreaTags

      @Stability(Stable) public void setStagingAreaTags(@NotNull Map<String,String> value)
      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

    • getAssociateDefaultSecurityGroup

      @Stability(Stable) @Nullable public Object getAssociateDefaultSecurityGroup()
      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

      Returns union: either Boolean or IResolvable

    • setAssociateDefaultSecurityGroup

      @Stability(Stable) public void setAssociateDefaultSecurityGroup(@Nullable Boolean value)
      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

    • setAssociateDefaultSecurityGroup

      @Stability(Stable) public void setAssociateDefaultSecurityGroup(@Nullable IResolvable value)
      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

    • getAutoReplicateNewDisks

      @Stability(Stable) @Nullable public Object getAutoReplicateNewDisks()
      Whether to allow the AWS replication agent to automatically replicate newly added disks.

      Returns union: either Boolean or IResolvable

    • setAutoReplicateNewDisks

      @Stability(Stable) public void setAutoReplicateNewDisks(@Nullable Boolean value)
      Whether to allow the AWS replication agent to automatically replicate newly added disks.

    • setAutoReplicateNewDisks

      @Stability(Stable) public void setAutoReplicateNewDisks(@Nullable IResolvable value)
      Whether to allow the AWS replication agent to automatically replicate newly added disks.

    • getCreatePublicIp

      @Stability(Stable) @Nullable public Object getCreatePublicIp()
      Whether to create a Public IP for the Recovery Instance by default.

      Returns union: either Boolean or IResolvable

    • setCreatePublicIp

      @Stability(Stable) public void setCreatePublicIp(@Nullable Boolean value)
      Whether to create a Public IP for the Recovery Instance by default.

    • setCreatePublicIp

      @Stability(Stable) public void setCreatePublicIp(@Nullable IResolvable value)
      Whether to create a Public IP for the Recovery Instance by default.

    • getDataPlaneRouting

      @Stability(Stable) @Nullable public String getDataPlaneRouting()
      The data plane routing mechanism that will be used for replication.

    • setDataPlaneRouting

      @Stability(Stable) public void setDataPlaneRouting(@Nullable String value)
      The data plane routing mechanism that will be used for replication.

    • getDefaultLargeStagingDiskType

      @Stability(Stable) @Nullable public String getDefaultLargeStagingDiskType()
      The Staging Disk EBS volume type to be used during replication.

    • setDefaultLargeStagingDiskType

      @Stability(Stable) public void setDefaultLargeStagingDiskType(@Nullable String value)
      The Staging Disk EBS volume type to be used during replication.

    • getEbsEncryptionKeyArn

      @Stability(Stable) @Nullable public String getEbsEncryptionKeyArn()
      The ARN of the EBS encryption key to be used during replication.

    • setEbsEncryptionKeyArn

      @Stability(Stable) public void setEbsEncryptionKeyArn(@Nullable String value)
      The ARN of the EBS encryption key to be used during replication.

    • getInternetProtocol

      @Stability(Stable) @Nullable public String getInternetProtocol()
      Which version of the Internet Protocol to use for replication of data.

    • setInternetProtocol

      @Stability(Stable) public void setInternetProtocol(@Nullable String value)
      Which version of the Internet Protocol to use for replication of data.

    • getReplicationServerInstanceType

      @Stability(Stable) @Nullable public String getReplicationServerInstanceType()
      The instance type to be used for the replication server.

    • setReplicationServerInstanceType

      @Stability(Stable) public void setReplicationServerInstanceType(@Nullable String value)
      The instance type to be used for the replication server.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A set of tags to be associated with the Replication Configuration Template resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A set of tags to be associated with the Replication Configuration Template resource.

    • getUseDedicatedReplicationServer

      @Stability(Stable) @Nullable public Object getUseDedicatedReplicationServer()
      Whether to use a dedicated Replication Server in the replication staging area.

      Returns union: either Boolean or IResolvable

    • setUseDedicatedReplicationServer

      @Stability(Stable) public void setUseDedicatedReplicationServer(@Nullable Boolean value)
      Whether to use a dedicated Replication Server in the replication staging area.

    • setUseDedicatedReplicationServer

      @Stability(Stable) public void setUseDedicatedReplicationServer(@Nullable IResolvable value)
      Whether to use a dedicated Replication Server in the replication staging area.