Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. dms
  5. ReplicationConfig
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.dms.ReplicationConfig

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a DMS Serverless replication config resource.

    NOTE: Changing most arguments will stop the replication if it is running. You can set start_replication to resume the replication afterwards.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const name = new aws.dms.ReplicationConfig("name", {
    replicationConfigIdentifier: "test-dms-serverless-replication-tf",
    resourceIdentifier: "test-dms-serverless-replication-tf",
    replicationType: "cdc",
    sourceEndpointArn: source.endpointArn,
    targetEndpointArn: target.endpointArn,
    tableMappings: `  {
    "rules":[{"rule-type":"selection","rule-id":"1","rule-name":"1","rule-action":"include","object-locator":{"schema-name":"%%","table-name":"%%"}}]
  }
`,
    startReplication: true,
    computeConfig: {
        replicationSubnetGroupId: _default.replicationSubnetGroupId,
        maxCapacityUnits: 64,
        minCapacityUnits: 2,
        preferredMaintenanceWindow: "sun:23:45-mon:00:30",
    },
});

    import pulumi
import pulumi_aws as aws

name = aws.dms.ReplicationConfig("name",
    replication_config_identifier="test-dms-serverless-replication-tf",
    resource_identifier="test-dms-serverless-replication-tf",
    replication_type="cdc",
    source_endpoint_arn=source["endpointArn"],
    target_endpoint_arn=target["endpointArn"],
    table_mappings="""  {
    "rules":[{"rule-type":"selection","rule-id":"1","rule-name":"1","rule-action":"include","object-locator":{"schema-name":"%%","table-name":"%%"}}]
  }
""",
    start_replication=True,
    compute_config={
        "replication_subnet_group_id": default["replicationSubnetGroupId"],
        "max_capacity_units": 64,
        "min_capacity_units": 2,
        "preferred_maintenance_window": "sun:23:45-mon:00:30",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.NewReplicationConfig(ctx, "name", &dms.ReplicationConfigArgs{
			ReplicationConfigIdentifier: pulumi.String("test-dms-serverless-replication-tf"),
			ResourceIdentifier:          pulumi.String("test-dms-serverless-replication-tf"),
			ReplicationType:             pulumi.String("cdc"),
			SourceEndpointArn:           pulumi.Any(source.EndpointArn),
			TargetEndpointArn:           pulumi.Any(target.EndpointArn),
			TableMappings:               pulumi.String("  {\n    \"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-action\":\"include\",\"object-locator\":{\"schema-name\":\"%%\",\"table-name\":\"%%\"}}]\n  }\n"),
			StartReplication:            pulumi.Bool(true),
			ComputeConfig: &dms.ReplicationConfigComputeConfigArgs{
				ReplicationSubnetGroupId:   pulumi.Any(_default.ReplicationSubnetGroupId),
				MaxCapacityUnits:           pulumi.Int(64),
				MinCapacityUnits:           pulumi.Int(2),
				PreferredMaintenanceWindow: pulumi.String("sun:23:45-mon:00:30"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var name = new Aws.Dms.ReplicationConfig("name", new()
    {
        ReplicationConfigIdentifier = "test-dms-serverless-replication-tf",
        ResourceIdentifier = "test-dms-serverless-replication-tf",
        ReplicationType = "cdc",
        SourceEndpointArn = source.EndpointArn,
        TargetEndpointArn = target.EndpointArn,
        TableMappings = @"  {
    ""rules"":[{""rule-type"":""selection"",""rule-id"":""1"",""rule-name"":""1"",""rule-action"":""include"",""object-locator"":{""schema-name"":""%%"",""table-name"":""%%""}}]
  }
",
        StartReplication = true,
        ComputeConfig = new Aws.Dms.Inputs.ReplicationConfigComputeConfigArgs
        {
            ReplicationSubnetGroupId = @default.ReplicationSubnetGroupId,
            MaxCapacityUnits = 64,
            MinCapacityUnits = 2,
            PreferredMaintenanceWindow = "sun:23:45-mon:00:30",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.ReplicationConfig;
import com.pulumi.aws.dms.ReplicationConfigArgs;
import com.pulumi.aws.dms.inputs.ReplicationConfigComputeConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var name = new ReplicationConfig("name", ReplicationConfigArgs.builder()
            .replicationConfigIdentifier("test-dms-serverless-replication-tf")
            .resourceIdentifier("test-dms-serverless-replication-tf")
            .replicationType("cdc")
            .sourceEndpointArn(source.endpointArn())
            .targetEndpointArn(target.endpointArn())
            .tableMappings("""
  {
    "rules":[{"rule-type":"selection","rule-id":"1","rule-name":"1","rule-action":"include","object-locator":{"schema-name":"%%","table-name":"%%"}}]
  }
            """)
            .startReplication(true)
            .computeConfig(ReplicationConfigComputeConfigArgs.builder()
                .replicationSubnetGroupId(default_.replicationSubnetGroupId())
                .maxCapacityUnits("64")
                .minCapacityUnits("2")
                .preferredMaintenanceWindow("sun:23:45-mon:00:30")
                .build())
            .build());

    }
}

    resources:
  name:
    type: aws:dms:ReplicationConfig
    properties:
      replicationConfigIdentifier: test-dms-serverless-replication-tf
      resourceIdentifier: test-dms-serverless-replication-tf
      replicationType: cdc
      sourceEndpointArn: ${source.endpointArn}
      targetEndpointArn: ${target.endpointArn}
      tableMappings: |2
          {
            "rules":[{"rule-type":"selection","rule-id":"1","rule-name":"1","rule-action":"include","object-locator":{"schema-name":"%%","table-name":"%%"}}]
          }
      startReplication: true
      computeConfig:
        replicationSubnetGroupId: ${default.replicationSubnetGroupId}
        maxCapacityUnits: '64'
        minCapacityUnits: '2'
        preferredMaintenanceWindow: sun:23:45-mon:00:30

    Create ReplicationConfig Resource

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

    Constructor syntax

    new ReplicationConfig(name: string, args: ReplicationConfigArgs, opts?: CustomResourceOptions);
    @overload
def ReplicationConfig(resource_name: str,
                      args: ReplicationConfigArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ReplicationConfig(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      compute_config: Optional[ReplicationConfigComputeConfigArgs] = None,
                      replication_config_identifier: Optional[str] = None,
                      replication_type: Optional[str] = None,
                      source_endpoint_arn: Optional[str] = None,
                      table_mappings: Optional[str] = None,
                      target_endpoint_arn: Optional[str] = None,
                      replication_settings: Optional[str] = None,
                      resource_identifier: Optional[str] = None,
                      start_replication: Optional[bool] = None,
                      supplemental_settings: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewReplicationConfig(ctx *Context, name string, args ReplicationConfigArgs, opts ...ResourceOption) (*ReplicationConfig, error)
    public ReplicationConfig(string name, ReplicationConfigArgs args, CustomResourceOptions? opts = null)
    public ReplicationConfig(String name, ReplicationConfigArgs args)
public ReplicationConfig(String name, ReplicationConfigArgs args, CustomResourceOptions options)

    type: aws:dms:ReplicationConfig
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 ReplicationConfigArgs
    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 ReplicationConfigArgs
    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 ReplicationConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationConfigArgs
    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 replicationConfigResource = new Aws.Dms.ReplicationConfig("replicationConfigResource", new()
{
    ComputeConfig = new Aws.Dms.Inputs.ReplicationConfigComputeConfigArgs
    {
        ReplicationSubnetGroupId = "string",
        AvailabilityZone = "string",
        DnsNameServers = "string",
        KmsKeyId = "string",
        MaxCapacityUnits = 0,
        MinCapacityUnits = 0,
        MultiAz = false,
        PreferredMaintenanceWindow = "string",
        VpcSecurityGroupIds = new[]
        {
            "string",
        },
    },
    ReplicationConfigIdentifier = "string",
    ReplicationType = "string",
    SourceEndpointArn = "string",
    TableMappings = "string",
    TargetEndpointArn = "string",
    ReplicationSettings = "string",
    ResourceIdentifier = "string",
    StartReplication = false,
    SupplementalSettings = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := dms.NewReplicationConfig(ctx, "replicationConfigResource", &dms.ReplicationConfigArgs{
	ComputeConfig: &dms.ReplicationConfigComputeConfigArgs{
		ReplicationSubnetGroupId:   pulumi.String("string"),
		AvailabilityZone:           pulumi.String("string"),
		DnsNameServers:             pulumi.String("string"),
		KmsKeyId:                   pulumi.String("string"),
		MaxCapacityUnits:           pulumi.Int(0),
		MinCapacityUnits:           pulumi.Int(0),
		MultiAz:                    pulumi.Bool(false),
		PreferredMaintenanceWindow: pulumi.String("string"),
		VpcSecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ReplicationConfigIdentifier: pulumi.String("string"),
	ReplicationType:             pulumi.String("string"),
	SourceEndpointArn:           pulumi.String("string"),
	TableMappings:               pulumi.String("string"),
	TargetEndpointArn:           pulumi.String("string"),
	ReplicationSettings:         pulumi.String("string"),
	ResourceIdentifier:          pulumi.String("string"),
	StartReplication:            pulumi.Bool(false),
	SupplementalSettings:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var replicationConfigResource = new ReplicationConfig("replicationConfigResource", ReplicationConfigArgs.builder()
    .computeConfig(ReplicationConfigComputeConfigArgs.builder()
        .replicationSubnetGroupId("string")
        .availabilityZone("string")
        .dnsNameServers("string")
        .kmsKeyId("string")
        .maxCapacityUnits(0)
        .minCapacityUnits(0)
        .multiAz(false)
        .preferredMaintenanceWindow("string")
        .vpcSecurityGroupIds("string")
        .build())
    .replicationConfigIdentifier("string")
    .replicationType("string")
    .sourceEndpointArn("string")
    .tableMappings("string")
    .targetEndpointArn("string")
    .replicationSettings("string")
    .resourceIdentifier("string")
    .startReplication(false)
    .supplementalSettings("string")
    .tags(Map.of("string", "string"))
    .build());

    replication_config_resource = aws.dms.ReplicationConfig("replicationConfigResource",
    compute_config={
        "replicationSubnetGroupId": "string",
        "availabilityZone": "string",
        "dnsNameServers": "string",
        "kmsKeyId": "string",
        "maxCapacityUnits": 0,
        "minCapacityUnits": 0,
        "multiAz": False,
        "preferredMaintenanceWindow": "string",
        "vpcSecurityGroupIds": ["string"],
    },
    replication_config_identifier="string",
    replication_type="string",
    source_endpoint_arn="string",
    table_mappings="string",
    target_endpoint_arn="string",
    replication_settings="string",
    resource_identifier="string",
    start_replication=False,
    supplemental_settings="string",
    tags={
        "string": "string",
    })

    const replicationConfigResource = new aws.dms.ReplicationConfig("replicationConfigResource", {
    computeConfig: {
        replicationSubnetGroupId: "string",
        availabilityZone: "string",
        dnsNameServers: "string",
        kmsKeyId: "string",
        maxCapacityUnits: 0,
        minCapacityUnits: 0,
        multiAz: false,
        preferredMaintenanceWindow: "string",
        vpcSecurityGroupIds: ["string"],
    },
    replicationConfigIdentifier: "string",
    replicationType: "string",
    sourceEndpointArn: "string",
    tableMappings: "string",
    targetEndpointArn: "string",
    replicationSettings: "string",
    resourceIdentifier: "string",
    startReplication: false,
    supplementalSettings: "string",
    tags: {
        string: "string",
    },
});

    type: aws:dms:ReplicationConfig
properties:
    computeConfig:
        availabilityZone: string
        dnsNameServers: string
        kmsKeyId: string
        maxCapacityUnits: 0
        minCapacityUnits: 0
        multiAz: false
        preferredMaintenanceWindow: string
        replicationSubnetGroupId: string
        vpcSecurityGroupIds:
            - string
    replicationConfigIdentifier: string
    replicationSettings: string
    replicationType: string
    resourceIdentifier: string
    sourceEndpointArn: string
    startReplication: false
    supplementalSettings: string
    tableMappings: string
    tags:
        string: string
    targetEndpointArn: string

    ReplicationConfig Resource Properties

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

    Inputs

    The ReplicationConfig resource accepts the following input properties:

    ComputeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    ReplicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    ReplicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    TableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    ReplicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    ResourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    StartReplication bool
    Whether to run or stop the serverless replication, default is false.
    SupplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ComputeConfig ReplicationConfigComputeConfigArgs
    Configuration block for provisioning an DMS Serverless replication.
    ReplicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    ReplicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    TableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    ReplicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    ResourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    StartReplication bool
    Whether to run or stop the serverless replication, default is false.
    SupplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    computeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier String
    Unique identifier that you want to use to create the config.
    replicationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    tableMappings String
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    replicationSettings String
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    resourceIdentifier String
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    startReplication Boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings String
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    computeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    replicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    sourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    tableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    replicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    resourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    startReplication boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    compute_config ReplicationConfigComputeConfigArgs
    Configuration block for provisioning an DMS Serverless replication.
    replication_config_identifier str
    Unique identifier that you want to use to create the config.
    replication_type str
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    source_endpoint_arn str
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    table_mappings str
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    target_endpoint_arn str
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    replication_settings str
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    resource_identifier str
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    start_replication bool
    Whether to run or stop the serverless replication, default is false.
    supplemental_settings str
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    computeConfig Property Map
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier String
    Unique identifier that you want to use to create the config.
    replicationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    tableMappings String
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    replicationSettings String
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    resourceIdentifier String
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    startReplication Boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings String
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) for the serverless replication config.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) for the serverless replication config.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) for the serverless replication config.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) for the serverless replication config.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) for the serverless replication config.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) for the serverless replication config.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A 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 ReplicationConfig Resource

    Get an existing ReplicationConfig 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?: ReplicationConfigState, opts?: CustomResourceOptions): ReplicationConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        compute_config: Optional[ReplicationConfigComputeConfigArgs] = None,
        replication_config_identifier: Optional[str] = None,
        replication_settings: Optional[str] = None,
        replication_type: Optional[str] = None,
        resource_identifier: Optional[str] = None,
        source_endpoint_arn: Optional[str] = None,
        start_replication: Optional[bool] = None,
        supplemental_settings: Optional[str] = None,
        table_mappings: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_endpoint_arn: Optional[str] = None) -> ReplicationConfig
    func GetReplicationConfig(ctx *Context, name string, id IDInput, state *ReplicationConfigState, opts ...ResourceOption) (*ReplicationConfig, error)
    public static ReplicationConfig Get(string name, Input<string> id, ReplicationConfigState? state, CustomResourceOptions? opts = null)
    public static ReplicationConfig get(String name, Output<String> id, ReplicationConfigState 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
    The Amazon Resource Name (ARN) for the serverless replication config.
    ComputeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    ReplicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    ReplicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    ReplicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ResourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    StartReplication bool
    Whether to run or stop the serverless replication, default is false.
    SupplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    TableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    Arn string
    The Amazon Resource Name (ARN) for the serverless replication config.
    ComputeConfig ReplicationConfigComputeConfigArgs
    Configuration block for provisioning an DMS Serverless replication.
    ReplicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    ReplicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    ReplicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ResourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    StartReplication bool
    Whether to run or stop the serverless replication, default is false.
    SupplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    TableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    arn String
    The Amazon Resource Name (ARN) for the serverless replication config.
    computeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier String
    Unique identifier that you want to use to create the config.
    replicationSettings String
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    replicationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    resourceIdentifier String
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplication Boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings String
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tableMappings String
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    arn string
    The Amazon Resource Name (ARN) for the serverless replication config.
    computeConfig ReplicationConfigComputeConfig
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier string
    Unique identifier that you want to use to create the config.
    replicationSettings string
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    replicationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    resourceIdentifier string
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    sourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplication boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings string
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tableMappings string
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    arn str
    The Amazon Resource Name (ARN) for the serverless replication config.
    compute_config ReplicationConfigComputeConfigArgs
    Configuration block for provisioning an DMS Serverless replication.
    replication_config_identifier str
    Unique identifier that you want to use to create the config.
    replication_settings str
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    replication_type str
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    resource_identifier str
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    source_endpoint_arn str
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    start_replication bool
    Whether to run or stop the serverless replication, default is false.
    supplemental_settings str
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    table_mappings str
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_endpoint_arn str
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    arn String
    The Amazon Resource Name (ARN) for the serverless replication config.
    computeConfig Property Map
    Configuration block for provisioning an DMS Serverless replication.
    replicationConfigIdentifier String
    Unique identifier that you want to use to create the config.
    replicationSettings String
    An escaped JSON string that are used to provision this replication configuration. For example, Change processing tuning settings
    replicationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    resourceIdentifier String
    Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplication Boolean
    Whether to run or stop the serverless replication, default is false.
    supplementalSettings String
    JSON settings for specifying supplemental data. For more information see Specifying supplemental data for task settings
    tableMappings String
    An escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

    Supporting Types

    ReplicationConfigComputeConfig, ReplicationConfigComputeConfigArgs

    ReplicationSubnetGroupId string
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    AvailabilityZone string
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    DnsNameServers string
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    KmsKeyId string
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    MaxCapacityUnits int
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    MinCapacityUnits int
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    MultiAz bool
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    VpcSecurityGroupIds List<string>
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    ReplicationSubnetGroupId string
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    AvailabilityZone string
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    DnsNameServers string
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    KmsKeyId string
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    MaxCapacityUnits int
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    MinCapacityUnits int
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    MultiAz bool
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    VpcSecurityGroupIds []string
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    replicationSubnetGroupId String
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    availabilityZone String
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    dnsNameServers String
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    kmsKeyId String
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    maxCapacityUnits Integer
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    minCapacityUnits Integer
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    multiAz Boolean
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    vpcSecurityGroupIds List<String>
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    replicationSubnetGroupId string
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    availabilityZone string
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    dnsNameServers string
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    kmsKeyId string
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    maxCapacityUnits number
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    minCapacityUnits number
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    multiAz boolean
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    preferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    vpcSecurityGroupIds string[]
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    replication_subnet_group_id str
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    availability_zone str
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    dns_name_servers str
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    kms_key_id str
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    max_capacity_units int
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    min_capacity_units int
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    multi_az bool
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    preferred_maintenance_window str
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    vpc_security_group_ids Sequence[str]
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
    replicationSubnetGroupId String
    Specifies a subnet group identifier to associate with the DMS Serverless replication.
    availabilityZone String
    The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random.
    dnsNameServers String
    A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database.
    kmsKeyId String
    An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.
    maxCapacityUnits Number
    Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384.
    minCapacityUnits Number
    Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. If this value isn't set DMS scans the current activity of available source tables to identify an optimum setting for this parameter.
    multiAz Boolean
    Specifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to true.
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    • Format: ddd:hh24:mi-ddd:hh24:mi
    • Valid Days: mon, tue, wed, thu, fri, sat, sun
    • Constraints: Minimum 30-minute window.
    vpcSecurityGroupIds List<String>
    Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.

    Import

    Using pulumi import, import a replication config using the arn. For example:

    $ pulumi import aws:dms/replicationConfig:ReplicationConfig example arn:aws:dms:us-east-1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI

    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.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws