Package software.amazon.awscdk.services.drs

Interface CfnReplicationConfigurationTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReplicationConfigurationTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:49.586Z")
@Stability(Stable)
public interface CfnReplicationConfigurationTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnReplicationConfigurationTemplate.

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.*;
 CfnReplicationConfigurationTemplateProps cfnReplicationConfigurationTemplateProps = CfnReplicationConfigurationTemplateProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReplicationConfigurationTemplateProps.Builder	A builder for CfnReplicationConfigurationTemplateProps
static final class	CfnReplicationConfigurationTemplateProps.Jsii$Proxy	An implementation for CfnReplicationConfigurationTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnReplicationConfigurationTemplateProps.Builder	builder()
default Object	getAssociateDefaultSecurityGroup()	Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
default Object	getAutoReplicateNewDisks()	Whether to allow the AWS replication agent to automatically replicate newly added disks.
Number	getBandwidthThrottling()	Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
default Object	getCreatePublicIp()	Whether to create a Public IP for the Recovery Instance by default.
default String	getDataPlaneRouting()	The data plane routing mechanism that will be used for replication.
default String	getDefaultLargeStagingDiskType()	The Staging Disk EBS volume type to be used during replication.
String	getEbsEncryption()	The type of EBS encryption to be used during replication.
default String	getEbsEncryptionKeyArn()	The ARN of the EBS encryption key to be used during replication.
default String	getInternetProtocol()	Which version of the Internet Protocol to use for replication of data.
Object	getPitPolicy()	The Point in time (PIT) policy to manage snapshots taken during replication.
default String	getReplicationServerInstanceType()	The instance type to be used for the replication server.
List<String>	getReplicationServersSecurityGroupsIDs()	The security group IDs that will be used by the replication server.
String	getStagingAreaSubnetId()	The subnet to be used by the replication staging area.
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.
default List<CfnTag>	getTags()	A set of tags to be associated with the Replication Configuration Template resource.
default Object	getUseDedicatedReplicationServer()	Whether to use a dedicated Replication Server in the replication staging area.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBandwidthThrottling

@Stability(Stable)
@NotNull
Number getBandwidthThrottling()

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-bandwidththrottling

getEbsEncryption

@Stability(Stable)
@NotNull
String getEbsEncryption()

The type of EBS encryption to be used during replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-ebsencryption

getPitPolicy

@Stability(Stable)
@NotNull
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>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-pitpolicy

getReplicationServersSecurityGroupsIDs

@Stability(Stable)
@NotNull
List<String> getReplicationServersSecurityGroupsIDs()

The security group IDs that will be used by the replication server.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-replicationserverssecuritygroupsids

getStagingAreaSubnetId

@Stability(Stable)
@NotNull
String getStagingAreaSubnetId()

The subnet to be used by the replication staging area.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-stagingareasubnetid

getStagingAreaTags

@Stability(Stable)
@NotNull
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>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-stagingareatags

getAssociateDefaultSecurityGroup

@Stability(Stable)
@Nullable
default Object getAssociateDefaultSecurityGroup()

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-associatedefaultsecuritygroup

getAutoReplicateNewDisks

@Stability(Stable)
@Nullable
default Object getAutoReplicateNewDisks()

Whether to allow the AWS replication agent to automatically replicate newly added disks.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-autoreplicatenewdisks

getCreatePublicIp

@Stability(Stable)
@Nullable
default Object getCreatePublicIp()

Whether to create a Public IP for the Recovery Instance by default.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-createpublicip

getDataPlaneRouting

@Stability(Stable)
@Nullable
default String getDataPlaneRouting()

The data plane routing mechanism that will be used for replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-dataplanerouting

getDefaultLargeStagingDiskType

@Stability(Stable)
@Nullable
default String getDefaultLargeStagingDiskType()

The Staging Disk EBS volume type to be used during replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-defaultlargestagingdisktype

getEbsEncryptionKeyArn

@Stability(Stable)
@Nullable
default String getEbsEncryptionKeyArn()

The ARN of the EBS encryption key to be used during replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-ebsencryptionkeyarn

getInternetProtocol

@Stability(Stable)
@Nullable
default String getInternetProtocol()

Which version of the Internet Protocol to use for replication of data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-internetprotocol

getReplicationServerInstanceType

@Stability(Stable)
@Nullable
default String getReplicationServerInstanceType()

The instance type to be used for the replication server.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-replicationserverinstancetype

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A set of tags to be associated with the Replication Configuration Template resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-tags

getUseDedicatedReplicationServer

@Stability(Stable)
@Nullable
default Object getUseDedicatedReplicationServer()

Whether to use a dedicated Replication Server in the replication staging area.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-drs-replicationconfigurationtemplate.html#cfn-drs-replicationconfigurationtemplate-usededicatedreplicationserver

builder

@Stability(Stable)
static CfnReplicationConfigurationTemplateProps.Builder builder()

Returns:

a CfnReplicationConfigurationTemplateProps.Builder of CfnReplicationConfigurationTemplateProps