1. Packages
  2. AWS
  3. API Docs
  4. drs
  5. ReplicationConfigurationTemplate
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.drs.ReplicationConfigurationTemplate

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides an Elastic Disaster Recovery replication configuration template resource. Before using DRS, your account must be initialized.

    NOTE: Your configuration must use the PIT policy shown in the basic configuration due to AWS rules. The only value that you can change is the retention_duration of rule_id 3.

    Example Usage

    Create ReplicationConfigurationTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReplicationConfigurationTemplate(name: string, args: ReplicationConfigurationTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def ReplicationConfigurationTemplate(resource_name: str,
                                         args: ReplicationConfigurationTemplateArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReplicationConfigurationTemplate(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         staging_area_tags: Optional[Mapping[str, str]] = None,
                                         replication_servers_security_groups_ids: Optional[Sequence[str]] = None,
                                         bandwidth_throttling: Optional[int] = None,
                                         create_public_ip: Optional[bool] = None,
                                         use_dedicated_replication_server: Optional[bool] = None,
                                         default_large_staging_disk_type: Optional[str] = None,
                                         associate_default_security_group: Optional[bool] = None,
                                         ebs_encryption: Optional[str] = None,
                                         data_plane_routing: Optional[str] = None,
                                         replication_server_instance_type: Optional[str] = None,
                                         staging_area_subnet_id: Optional[str] = None,
                                         ebs_encryption_key_arn: Optional[str] = None,
                                         auto_replicate_new_disks: Optional[bool] = None,
                                         tags: Optional[Mapping[str, str]] = None,
                                         timeouts: Optional[ReplicationConfigurationTemplateTimeoutsArgs] = None,
                                         pit_policies: Optional[Sequence[ReplicationConfigurationTemplatePitPolicyArgs]] = None)
    func NewReplicationConfigurationTemplate(ctx *Context, name string, args ReplicationConfigurationTemplateArgs, opts ...ResourceOption) (*ReplicationConfigurationTemplate, error)
    public ReplicationConfigurationTemplate(string name, ReplicationConfigurationTemplateArgs args, CustomResourceOptions? opts = null)
    public ReplicationConfigurationTemplate(String name, ReplicationConfigurationTemplateArgs args)
    public ReplicationConfigurationTemplate(String name, ReplicationConfigurationTemplateArgs args, CustomResourceOptions options)
    
    type: aws:drs:ReplicationConfigurationTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ReplicationConfigurationTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReplicationConfigurationTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReplicationConfigurationTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationConfigurationTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationConfigurationTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var replicationConfigurationTemplateResource = new Aws.Drs.ReplicationConfigurationTemplate("replicationConfigurationTemplateResource", new()
    {
        StagingAreaTags = 
        {
            { "string", "string" },
        },
        ReplicationServersSecurityGroupsIds = new[]
        {
            "string",
        },
        BandwidthThrottling = 0,
        CreatePublicIp = false,
        UseDedicatedReplicationServer = false,
        DefaultLargeStagingDiskType = "string",
        AssociateDefaultSecurityGroup = false,
        EbsEncryption = "string",
        DataPlaneRouting = "string",
        ReplicationServerInstanceType = "string",
        StagingAreaSubnetId = "string",
        EbsEncryptionKeyArn = "string",
        AutoReplicateNewDisks = false,
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Aws.Drs.Inputs.ReplicationConfigurationTemplateTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        PitPolicies = new[]
        {
            new Aws.Drs.Inputs.ReplicationConfigurationTemplatePitPolicyArgs
            {
                Interval = 0,
                RetentionDuration = 0,
                Units = "string",
                Enabled = false,
                RuleId = 0,
            },
        },
    });
    
    example, err := drs.NewReplicationConfigurationTemplate(ctx, "replicationConfigurationTemplateResource", &drs.ReplicationConfigurationTemplateArgs{
    	StagingAreaTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ReplicationServersSecurityGroupsIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	BandwidthThrottling:           pulumi.Int(0),
    	CreatePublicIp:                pulumi.Bool(false),
    	UseDedicatedReplicationServer: pulumi.Bool(false),
    	DefaultLargeStagingDiskType:   pulumi.String("string"),
    	AssociateDefaultSecurityGroup: pulumi.Bool(false),
    	EbsEncryption:                 pulumi.String("string"),
    	DataPlaneRouting:              pulumi.String("string"),
    	ReplicationServerInstanceType: pulumi.String("string"),
    	StagingAreaSubnetId:           pulumi.String("string"),
    	EbsEncryptionKeyArn:           pulumi.String("string"),
    	AutoReplicateNewDisks:         pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &drs.ReplicationConfigurationTemplateTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	PitPolicies: drs.ReplicationConfigurationTemplatePitPolicyArray{
    		&drs.ReplicationConfigurationTemplatePitPolicyArgs{
    			Interval:          pulumi.Int(0),
    			RetentionDuration: pulumi.Int(0),
    			Units:             pulumi.String("string"),
    			Enabled:           pulumi.Bool(false),
    			RuleId:            pulumi.Int(0),
    		},
    	},
    })
    
    var replicationConfigurationTemplateResource = new ReplicationConfigurationTemplate("replicationConfigurationTemplateResource", ReplicationConfigurationTemplateArgs.builder()
        .stagingAreaTags(Map.of("string", "string"))
        .replicationServersSecurityGroupsIds("string")
        .bandwidthThrottling(0)
        .createPublicIp(false)
        .useDedicatedReplicationServer(false)
        .defaultLargeStagingDiskType("string")
        .associateDefaultSecurityGroup(false)
        .ebsEncryption("string")
        .dataPlaneRouting("string")
        .replicationServerInstanceType("string")
        .stagingAreaSubnetId("string")
        .ebsEncryptionKeyArn("string")
        .autoReplicateNewDisks(false)
        .tags(Map.of("string", "string"))
        .timeouts(ReplicationConfigurationTemplateTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .pitPolicies(ReplicationConfigurationTemplatePitPolicyArgs.builder()
            .interval(0)
            .retentionDuration(0)
            .units("string")
            .enabled(false)
            .ruleId(0)
            .build())
        .build());
    
    replication_configuration_template_resource = aws.drs.ReplicationConfigurationTemplate("replicationConfigurationTemplateResource",
        staging_area_tags={
            "string": "string",
        },
        replication_servers_security_groups_ids=["string"],
        bandwidth_throttling=0,
        create_public_ip=False,
        use_dedicated_replication_server=False,
        default_large_staging_disk_type="string",
        associate_default_security_group=False,
        ebs_encryption="string",
        data_plane_routing="string",
        replication_server_instance_type="string",
        staging_area_subnet_id="string",
        ebs_encryption_key_arn="string",
        auto_replicate_new_disks=False,
        tags={
            "string": "string",
        },
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        pit_policies=[{
            "interval": 0,
            "retention_duration": 0,
            "units": "string",
            "enabled": False,
            "rule_id": 0,
        }])
    
    const replicationConfigurationTemplateResource = new aws.drs.ReplicationConfigurationTemplate("replicationConfigurationTemplateResource", {
        stagingAreaTags: {
            string: "string",
        },
        replicationServersSecurityGroupsIds: ["string"],
        bandwidthThrottling: 0,
        createPublicIp: false,
        useDedicatedReplicationServer: false,
        defaultLargeStagingDiskType: "string",
        associateDefaultSecurityGroup: false,
        ebsEncryption: "string",
        dataPlaneRouting: "string",
        replicationServerInstanceType: "string",
        stagingAreaSubnetId: "string",
        ebsEncryptionKeyArn: "string",
        autoReplicateNewDisks: false,
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        pitPolicies: [{
            interval: 0,
            retentionDuration: 0,
            units: "string",
            enabled: false,
            ruleId: 0,
        }],
    });
    
    type: aws:drs:ReplicationConfigurationTemplate
    properties:
        associateDefaultSecurityGroup: false
        autoReplicateNewDisks: false
        bandwidthThrottling: 0
        createPublicIp: false
        dataPlaneRouting: string
        defaultLargeStagingDiskType: string
        ebsEncryption: string
        ebsEncryptionKeyArn: string
        pitPolicies:
            - enabled: false
              interval: 0
              retentionDuration: 0
              ruleId: 0
              units: string
        replicationServerInstanceType: string
        replicationServersSecurityGroupsIds:
            - string
        stagingAreaSubnetId: string
        stagingAreaTags:
            string: string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
            update: string
        useDedicatedReplicationServer: false
    

    ReplicationConfigurationTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReplicationConfigurationTemplate resource accepts the following input properties:

    AssociateDefaultSecurityGroup bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    BandwidthThrottling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    CreatePublicIp bool
    Whether to create a Public IP for the Recovery Instance by default.
    DataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    DefaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    EbsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ReplicationServerInstanceType string
    Instance type to be used for the replication server.
    ReplicationServersSecurityGroupsIds List<string>
    Security group IDs that will be used by the replication server.
    StagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    StagingAreaTags Dictionary<string, string>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    UseDedicatedReplicationServer bool

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

    The following arguments are optional:

    AutoReplicateNewDisks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    EbsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    PitPolicies List<ReplicationConfigurationTemplatePitPolicy>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    Tags Dictionary<string, string>
    Set of tags to be associated with the Replication Configuration Template resource.
    Timeouts ReplicationConfigurationTemplateTimeouts
    AssociateDefaultSecurityGroup bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    BandwidthThrottling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    CreatePublicIp bool
    Whether to create a Public IP for the Recovery Instance by default.
    DataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    DefaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    EbsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ReplicationServerInstanceType string
    Instance type to be used for the replication server.
    ReplicationServersSecurityGroupsIds []string
    Security group IDs that will be used by the replication server.
    StagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    StagingAreaTags map[string]string
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    UseDedicatedReplicationServer bool

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

    The following arguments are optional:

    AutoReplicateNewDisks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    EbsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    PitPolicies []ReplicationConfigurationTemplatePitPolicyArgs
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    Tags map[string]string
    Set of tags to be associated with the Replication Configuration Template resource.
    Timeouts ReplicationConfigurationTemplateTimeoutsArgs
    associateDefaultSecurityGroup Boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    bandwidthThrottling Integer
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp Boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting String
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType String
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption String
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    replicationServerInstanceType String
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds List<String>
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId String
    Subnet to be used by the replication staging area.
    stagingAreaTags Map<String,String>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    useDedicatedReplicationServer Boolean

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

    The following arguments are optional:

    autoReplicateNewDisks Boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    ebsEncryptionKeyArn String
    ARN of the EBS encryption key to be used during replication.
    pitPolicies List<ReplicationConfigurationTemplatePitPolicy>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    tags Map<String,String>
    Set of tags to be associated with the Replication Configuration Template resource.
    timeouts ReplicationConfigurationTemplateTimeouts
    associateDefaultSecurityGroup boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    bandwidthThrottling number
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    replicationServerInstanceType string
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds string[]
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    stagingAreaTags {[key: string]: string}
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    useDedicatedReplicationServer boolean

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

    The following arguments are optional:

    autoReplicateNewDisks boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    ebsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    pitPolicies ReplicationConfigurationTemplatePitPolicy[]
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    tags {[key: string]: string}
    Set of tags to be associated with the Replication Configuration Template resource.
    timeouts ReplicationConfigurationTemplateTimeouts
    associate_default_security_group bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    bandwidth_throttling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    create_public_ip bool
    Whether to create a Public IP for the Recovery Instance by default.
    data_plane_routing str
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    default_large_staging_disk_type str
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebs_encryption str
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    replication_server_instance_type str
    Instance type to be used for the replication server.
    replication_servers_security_groups_ids Sequence[str]
    Security group IDs that will be used by the replication server.
    staging_area_subnet_id str
    Subnet to be used by the replication staging area.
    staging_area_tags Mapping[str, str]
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    use_dedicated_replication_server bool

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

    The following arguments are optional:

    auto_replicate_new_disks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    ebs_encryption_key_arn str
    ARN of the EBS encryption key to be used during replication.
    pit_policies Sequence[ReplicationConfigurationTemplatePitPolicyArgs]
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    tags Mapping[str, str]
    Set of tags to be associated with the Replication Configuration Template resource.
    timeouts ReplicationConfigurationTemplateTimeoutsArgs
    associateDefaultSecurityGroup Boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    bandwidthThrottling Number
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp Boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting String
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType String
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption String
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    replicationServerInstanceType String
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds List<String>
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId String
    Subnet to be used by the replication staging area.
    stagingAreaTags Map<String>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    useDedicatedReplicationServer Boolean

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

    The following arguments are optional:

    autoReplicateNewDisks Boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    ebsEncryptionKeyArn String
    ARN of the EBS encryption key to be used during replication.
    pitPolicies List<Property Map>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    tags Map<String>
    Set of tags to be associated with the Replication Configuration Template resource.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReplicationConfigurationTemplate resource produces the following output properties:

    Arn string
    Replication configuration template ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Replication configuration template ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Replication configuration template ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Replication configuration template ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Replication configuration template ARN.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Replication configuration template ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ReplicationConfigurationTemplate Resource

    Get an existing ReplicationConfigurationTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ReplicationConfigurationTemplateState, opts?: CustomResourceOptions): ReplicationConfigurationTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            associate_default_security_group: Optional[bool] = None,
            auto_replicate_new_disks: Optional[bool] = None,
            bandwidth_throttling: Optional[int] = None,
            create_public_ip: Optional[bool] = None,
            data_plane_routing: Optional[str] = None,
            default_large_staging_disk_type: Optional[str] = None,
            ebs_encryption: Optional[str] = None,
            ebs_encryption_key_arn: Optional[str] = None,
            pit_policies: Optional[Sequence[ReplicationConfigurationTemplatePitPolicyArgs]] = None,
            replication_server_instance_type: Optional[str] = None,
            replication_servers_security_groups_ids: Optional[Sequence[str]] = None,
            staging_area_subnet_id: Optional[str] = None,
            staging_area_tags: Optional[Mapping[str, str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            timeouts: Optional[ReplicationConfigurationTemplateTimeoutsArgs] = None,
            use_dedicated_replication_server: Optional[bool] = None) -> ReplicationConfigurationTemplate
    func GetReplicationConfigurationTemplate(ctx *Context, name string, id IDInput, state *ReplicationConfigurationTemplateState, opts ...ResourceOption) (*ReplicationConfigurationTemplate, error)
    public static ReplicationConfigurationTemplate Get(string name, Input<string> id, ReplicationConfigurationTemplateState? state, CustomResourceOptions? opts = null)
    public static ReplicationConfigurationTemplate get(String name, Output<String> id, ReplicationConfigurationTemplateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Replication configuration template ARN.
    AssociateDefaultSecurityGroup bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    AutoReplicateNewDisks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    BandwidthThrottling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    CreatePublicIp bool
    Whether to create a Public IP for the Recovery Instance by default.
    DataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    DefaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    EbsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    EbsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    PitPolicies List<ReplicationConfigurationTemplatePitPolicy>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    ReplicationServerInstanceType string
    Instance type to be used for the replication server.
    ReplicationServersSecurityGroupsIds List<string>
    Security group IDs that will be used by the replication server.
    StagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    StagingAreaTags Dictionary<string, string>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    Tags Dictionary<string, string>
    Set of tags to be associated with the Replication Configuration Template resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts ReplicationConfigurationTemplateTimeouts
    UseDedicatedReplicationServer bool

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

    The following arguments are optional:

    Arn string
    Replication configuration template ARN.
    AssociateDefaultSecurityGroup bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    AutoReplicateNewDisks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    BandwidthThrottling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    CreatePublicIp bool
    Whether to create a Public IP for the Recovery Instance by default.
    DataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    DefaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    EbsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    EbsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    PitPolicies []ReplicationConfigurationTemplatePitPolicyArgs
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    ReplicationServerInstanceType string
    Instance type to be used for the replication server.
    ReplicationServersSecurityGroupsIds []string
    Security group IDs that will be used by the replication server.
    StagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    StagingAreaTags map[string]string
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    Tags map[string]string
    Set of tags to be associated with the Replication Configuration Template resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts ReplicationConfigurationTemplateTimeoutsArgs
    UseDedicatedReplicationServer bool

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

    The following arguments are optional:

    arn String
    Replication configuration template ARN.
    associateDefaultSecurityGroup Boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    autoReplicateNewDisks Boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    bandwidthThrottling Integer
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp Boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting String
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType String
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption String
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ebsEncryptionKeyArn String
    ARN of the EBS encryption key to be used during replication.
    pitPolicies List<ReplicationConfigurationTemplatePitPolicy>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    replicationServerInstanceType String
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds List<String>
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId String
    Subnet to be used by the replication staging area.
    stagingAreaTags Map<String,String>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    tags Map<String,String>
    Set of tags to be associated with the Replication Configuration Template resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts ReplicationConfigurationTemplateTimeouts
    useDedicatedReplicationServer Boolean

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

    The following arguments are optional:

    arn string
    Replication configuration template ARN.
    associateDefaultSecurityGroup boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    autoReplicateNewDisks boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    bandwidthThrottling number
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting string
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType string
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption string
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ebsEncryptionKeyArn string
    ARN of the EBS encryption key to be used during replication.
    pitPolicies ReplicationConfigurationTemplatePitPolicy[]
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    replicationServerInstanceType string
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds string[]
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId string
    Subnet to be used by the replication staging area.
    stagingAreaTags {[key: string]: string}
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    tags {[key: string]: string}
    Set of tags to be associated with the Replication Configuration Template resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts ReplicationConfigurationTemplateTimeouts
    useDedicatedReplicationServer boolean

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

    The following arguments are optional:

    arn str
    Replication configuration template ARN.
    associate_default_security_group bool
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    auto_replicate_new_disks bool
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    bandwidth_throttling int
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    create_public_ip bool
    Whether to create a Public IP for the Recovery Instance by default.
    data_plane_routing str
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    default_large_staging_disk_type str
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebs_encryption str
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ebs_encryption_key_arn str
    ARN of the EBS encryption key to be used during replication.
    pit_policies Sequence[ReplicationConfigurationTemplatePitPolicyArgs]
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    replication_server_instance_type str
    Instance type to be used for the replication server.
    replication_servers_security_groups_ids Sequence[str]
    Security group IDs that will be used by the replication server.
    staging_area_subnet_id str
    Subnet to be used by the replication staging area.
    staging_area_tags Mapping[str, str]
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    tags Mapping[str, str]
    Set of tags to be associated with the Replication Configuration Template resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts ReplicationConfigurationTemplateTimeoutsArgs
    use_dedicated_replication_server bool

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

    The following arguments are optional:

    arn String
    Replication configuration template ARN.
    associateDefaultSecurityGroup Boolean
    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
    autoReplicateNewDisks Boolean
    Whether to allow the AWS replication agent to automatically replicate newly added disks.
    bandwidthThrottling Number
    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
    createPublicIp Boolean
    Whether to create a Public IP for the Recovery Instance by default.
    dataPlaneRouting String
    Data plane routing mechanism that will be used for replication. Valid values are PUBLIC_IP and PRIVATE_IP.
    defaultLargeStagingDiskType String
    Staging Disk EBS volume type to be used during replication. Valid values are GP2, GP3, ST1, or AUTO.
    ebsEncryption String
    Type of EBS encryption to be used during replication. Valid values are DEFAULT and CUSTOM.
    ebsEncryptionKeyArn String
    ARN of the EBS encryption key to be used during replication.
    pitPolicies List<Property Map>
    Configuration block for Point in time (PIT) policy to manage snapshots taken during replication. See below.
    replicationServerInstanceType String
    Instance type to be used for the replication server.
    replicationServersSecurityGroupsIds List<String>
    Security group IDs that will be used by the replication server.
    stagingAreaSubnetId String
    Subnet to be used by the replication staging area.
    stagingAreaTags Map<String>
    Set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
    tags Map<String>
    Set of tags to be associated with the Replication Configuration Template resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Property Map
    useDedicatedReplicationServer Boolean

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

    The following arguments are optional:

    Supporting Types

    ReplicationConfigurationTemplatePitPolicy, ReplicationConfigurationTemplatePitPolicyArgs

    Interval int
    How often, in the chosen units, a snapshot should be taken.
    RetentionDuration int
    Duration to retain a snapshot for, in the chosen units.
    Units string
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    Enabled bool
    Whether this rule is enabled or not.
    RuleId int
    ID of the rule. Valid values are integers.
    Interval int
    How often, in the chosen units, a snapshot should be taken.
    RetentionDuration int
    Duration to retain a snapshot for, in the chosen units.
    Units string
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    Enabled bool
    Whether this rule is enabled or not.
    RuleId int
    ID of the rule. Valid values are integers.
    interval Integer
    How often, in the chosen units, a snapshot should be taken.
    retentionDuration Integer
    Duration to retain a snapshot for, in the chosen units.
    units String
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    enabled Boolean
    Whether this rule is enabled or not.
    ruleId Integer
    ID of the rule. Valid values are integers.
    interval number
    How often, in the chosen units, a snapshot should be taken.
    retentionDuration number
    Duration to retain a snapshot for, in the chosen units.
    units string
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    enabled boolean
    Whether this rule is enabled or not.
    ruleId number
    ID of the rule. Valid values are integers.
    interval int
    How often, in the chosen units, a snapshot should be taken.
    retention_duration int
    Duration to retain a snapshot for, in the chosen units.
    units str
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    enabled bool
    Whether this rule is enabled or not.
    rule_id int
    ID of the rule. Valid values are integers.
    interval Number
    How often, in the chosen units, a snapshot should be taken.
    retentionDuration Number
    Duration to retain a snapshot for, in the chosen units.
    units String
    Units used to measure the interval and retention_duration. Valid values are MINUTE, HOUR, and DAY.
    enabled Boolean
    Whether this rule is enabled or not.
    ruleId Number
    ID of the rule. Valid values are integers.

    ReplicationConfigurationTemplateTimeouts, ReplicationConfigurationTemplateTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import DRS Replication Configuration Template using the id. For example:

    $ pulumi import aws:drs/replicationConfigurationTemplate:ReplicationConfigurationTemplate example templateid
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi