ReplicationInstance

Provides a DMS (Data Migration Service) replication instance resource. DMS replication instances can be created, updated, deleted, and imported.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var dmsAssumeRole = Output.Create(Aws.Iam.GetPolicyDocument.InvokeAsync(new Aws.Iam.GetPolicyDocumentArgs
        {
            Statements = 
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementArgs
                {
                    Actions = 
                    {
                        "sts:AssumeRole",
                    },
                    Principals = 
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalArgs
                        {
                            Identifiers = 
                            {
                                "dms.amazonaws.com",
                            },
                            Type = "Service",
                        },
                    },
                },
            },
        }));
        var dms_access_for_endpoint = new Aws.Iam.Role("dms-access-for-endpoint", new Aws.Iam.RoleArgs
        {
            AssumeRolePolicy = dmsAssumeRole.Apply(dmsAssumeRole => dmsAssumeRole.Json),
        });
        var dms_access_for_endpoint_AmazonDMSRedshiftS3Role = new Aws.Iam.RolePolicyAttachment("dms-access-for-endpoint-AmazonDMSRedshiftS3Role", new Aws.Iam.RolePolicyAttachmentArgs
        {
            PolicyArn = "arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role",
            Role = dms_access_for_endpoint.Name,
        });
        var dms_cloudwatch_logs_role = new Aws.Iam.Role("dms-cloudwatch-logs-role", new Aws.Iam.RoleArgs
        {
            AssumeRolePolicy = dmsAssumeRole.Apply(dmsAssumeRole => dmsAssumeRole.Json),
        });
        var dms_cloudwatch_logs_role_AmazonDMSCloudWatchLogsRole = new Aws.Iam.RolePolicyAttachment("dms-cloudwatch-logs-role-AmazonDMSCloudWatchLogsRole", new Aws.Iam.RolePolicyAttachmentArgs
        {
            PolicyArn = "arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole",
            Role = dms_cloudwatch_logs_role.Name,
        });
        var dms_vpc_role = new Aws.Iam.Role("dms-vpc-role", new Aws.Iam.RoleArgs
        {
            AssumeRolePolicy = dmsAssumeRole.Apply(dmsAssumeRole => dmsAssumeRole.Json),
        });
        var dms_vpc_role_AmazonDMSVPCManagementRole = new Aws.Iam.RolePolicyAttachment("dms-vpc-role-AmazonDMSVPCManagementRole", new Aws.Iam.RolePolicyAttachmentArgs
        {
            PolicyArn = "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
            Role = dms_vpc_role.Name,
        });
        // Create a new replication instance
        var test = new Aws.Dms.ReplicationInstance("test", new Aws.Dms.ReplicationInstanceArgs
        {
            AllocatedStorage = 20,
            ApplyImmediately = true,
            AutoMinorVersionUpgrade = true,
            AvailabilityZone = "us-west-2c",
            EngineVersion = "3.1.4",
            KmsKeyArn = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
            MultiAz = false,
            PreferredMaintenanceWindow = "sun:10:30-sun:14:30",
            PubliclyAccessible = true,
            ReplicationInstanceClass = "dms.t2.micro",
            ReplicationInstanceId = "test-dms-replication-instance-tf",
            ReplicationSubnetGroupId = aws_dms_replication_subnet_group.Test_dms_replication_subnet_group_tf.Id,
            Tags = 
            {
                { "Name", "test" },
            },
            VpcSecurityGroupIds = 
            {
                "sg-12345678",
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/dms"
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/iam"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        dmsAssumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
            Statements: []iam.GetPolicyDocumentStatement{
                iam.GetPolicyDocumentStatement{
                    Actions: []string{
                        "sts:AssumeRole",
                    },
                    Principals: []iam.GetPolicyDocumentStatementPrincipal{
                        iam.GetPolicyDocumentStatementPrincipal{
                            Identifiers: []string{
                                "dms.amazonaws.com",
                            },
                            Type: "Service",
                        },
                    },
                },
            },
        }, nil)
        if err != nil {
            return err
        }
        _, err = iam.NewRole(ctx, "dms_access_for_endpoint", &iam.RoleArgs{
            AssumeRolePolicy: pulumi.String(dmsAssumeRole.Json),
        })
        if err != nil {
            return err
        }
        _, err = iam.NewRolePolicyAttachment(ctx, "dms_access_for_endpoint_AmazonDMSRedshiftS3Role", &iam.RolePolicyAttachmentArgs{
            PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role"),
            Role:      dms_access_for_endpoint.Name,
        })
        if err != nil {
            return err
        }
        _, err = iam.NewRole(ctx, "dms_cloudwatch_logs_role", &iam.RoleArgs{
            AssumeRolePolicy: pulumi.String(dmsAssumeRole.Json),
        })
        if err != nil {
            return err
        }
        _, err = iam.NewRolePolicyAttachment(ctx, "dms_cloudwatch_logs_role_AmazonDMSCloudWatchLogsRole", &iam.RolePolicyAttachmentArgs{
            PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole"),
            Role:      dms_cloudwatch_logs_role.Name,
        })
        if err != nil {
            return err
        }
        _, err = iam.NewRole(ctx, "dms_vpc_role", &iam.RoleArgs{
            AssumeRolePolicy: pulumi.String(dmsAssumeRole.Json),
        })
        if err != nil {
            return err
        }
        _, err = iam.NewRolePolicyAttachment(ctx, "dms_vpc_role_AmazonDMSVPCManagementRole", &iam.RolePolicyAttachmentArgs{
            PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole"),
            Role:      dms_vpc_role.Name,
        })
        if err != nil {
            return err
        }
        _, err = dms.NewReplicationInstance(ctx, "test", &dms.ReplicationInstanceArgs{
            AllocatedStorage:           pulumi.Int(20),
            ApplyImmediately:           pulumi.Bool(true),
            AutoMinorVersionUpgrade:    pulumi.Bool(true),
            AvailabilityZone:           pulumi.String("us-west-2c"),
            EngineVersion:              pulumi.String("3.1.4"),
            KmsKeyArn:                  pulumi.String("arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"),
            MultiAz:                    pulumi.Bool(false),
            PreferredMaintenanceWindow: pulumi.String("sun:10:30-sun:14:30"),
            PubliclyAccessible:         pulumi.Bool(true),
            ReplicationInstanceClass:   pulumi.String("dms.t2.micro"),
            ReplicationInstanceId:      pulumi.String("test-dms-replication-instance-tf"),
            ReplicationSubnetGroupId:   pulumi.String(aws_dms_replication_subnet_group.Test - dms - replication - subnet - group - tf.Id),
            Tags: pulumi.StringMap{
                "Name": pulumi.String("test"),
            },
            VpcSecurityGroupIds: pulumi.StringArray{
                pulumi.String("sg-12345678"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

dms_assume_role = aws.iam.get_policy_document(statements=[{
    "actions": ["sts:AssumeRole"],
    "principals": [{
        "identifiers": ["dms.amazonaws.com"],
        "type": "Service",
    }],
}])
dms_access_for_endpoint = aws.iam.Role("dms-access-for-endpoint", assume_role_policy=dms_assume_role.json)
dms_access_for_endpoint__amazon_dms_redshift_s3_role = aws.iam.RolePolicyAttachment("dms-access-for-endpoint-AmazonDMSRedshiftS3Role",
    policy_arn="arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role",
    role=dms_access_for_endpoint.name)
dms_cloudwatch_logs_role = aws.iam.Role("dms-cloudwatch-logs-role", assume_role_policy=dms_assume_role.json)
dms_cloudwatch_logs_role__amazon_dms_cloud_watch_logs_role = aws.iam.RolePolicyAttachment("dms-cloudwatch-logs-role-AmazonDMSCloudWatchLogsRole",
    policy_arn="arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole",
    role=dms_cloudwatch_logs_role.name)
dms_vpc_role = aws.iam.Role("dms-vpc-role", assume_role_policy=dms_assume_role.json)
dms_vpc_role__amazon_dmsvpc_management_role = aws.iam.RolePolicyAttachment("dms-vpc-role-AmazonDMSVPCManagementRole",
    policy_arn="arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
    role=dms_vpc_role.name)
# Create a new replication instance
test = aws.dms.ReplicationInstance("test",
    allocated_storage=20,
    apply_immediately=True,
    auto_minor_version_upgrade=True,
    availability_zone="us-west-2c",
    engine_version="3.1.4",
    kms_key_arn="arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
    multi_az=False,
    preferred_maintenance_window="sun:10:30-sun:14:30",
    publicly_accessible=True,
    replication_instance_class="dms.t2.micro",
    replication_instance_id="test-dms-replication-instance-tf",
    replication_subnet_group_id=aws_dms_replication_subnet_group["test-dms-replication-subnet-group-tf"]["id"],
    tags={
        "Name": "test",
    },
    vpc_security_group_ids=["sg-12345678"])

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

const dmsAssumeRole = pulumi.output(aws.iam.getPolicyDocument({
    statements: [{
        actions: ["sts:AssumeRole"],
        principals: [{
            identifiers: ["dms.amazonaws.com"],
            type: "Service",
        }],
    }],
}, { async: true }));
const dms_access_for_endpoint = new aws.iam.Role("dms-access-for-endpoint", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_access_for_endpoint_AmazonDMSRedshiftS3Role = new aws.iam.RolePolicyAttachment("dms-access-for-endpoint-AmazonDMSRedshiftS3Role", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role",
    role: dms_access_for_endpoint.name,
});
const dms_cloudwatch_logs_role = new aws.iam.Role("dms-cloudwatch-logs-role", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_cloudwatch_logs_role_AmazonDMSCloudWatchLogsRole = new aws.iam.RolePolicyAttachment("dms-cloudwatch-logs-role-AmazonDMSCloudWatchLogsRole", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole",
    role: dms_cloudwatch_logs_role.name,
});
const dms_vpc_role = new aws.iam.Role("dms-vpc-role", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_vpc_role_AmazonDMSVPCManagementRole = new aws.iam.RolePolicyAttachment("dms-vpc-role-AmazonDMSVPCManagementRole", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
    role: dms_vpc_role.name,
});
// Create a new replication instance
const test = new aws.dms.ReplicationInstance("test", {
    allocatedStorage: 20,
    applyImmediately: true,
    autoMinorVersionUpgrade: true,
    availabilityZone: "us-west-2c",
    engineVersion: "3.1.4",
    kmsKeyArn: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
    multiAz: false,
    preferredMaintenanceWindow: "sun:10:30-sun:14:30",
    publiclyAccessible: true,
    replicationInstanceClass: "dms.t2.micro",
    replicationInstanceId: "test-dms-replication-instance-tf",
    replicationSubnetGroupId: aws_dms_replication_subnet_group_test_dms_replication_subnet_group_tf.id,
    tags: {
        Name: "test",
    },
    vpcSecurityGroupIds: ["sg-12345678"],
});

Create a ReplicationInstance Resource

new ReplicationInstance(name: string, args: ReplicationInstanceArgs, opts?: CustomResourceOptions);

def ReplicationInstance(resource_name, opts=None, allocated_storage=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, engine_version=None, kms_key_arn=None, multi_az=None, preferred_maintenance_window=None, publicly_accessible=None, replication_instance_class=None, replication_instance_id=None, replication_subnet_group_id=None, tags=None, vpc_security_group_ids=None, __props__=None);

func NewReplicationInstance(ctx *Context, name string, args ReplicationInstanceArgs, opts ...ResourceOption) (*ReplicationInstance, error)

public ReplicationInstance(string name, ReplicationInstanceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ReplicationInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ReplicationInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ReplicationInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ReplicationInstance Resource Properties

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

Inputs

The ReplicationInstance resource accepts the following input properties:

ReplicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
AllocatedStorage int: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
ApplyImmediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
AvailabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
EngineVersion string: The engine version number of the replication instance.
KmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
PubliclyAccessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
ReplicationSubnetGroupId string: A subnet group to associate with the replication instance.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
VpcSecurityGroupIds List<string>: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

ReplicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
AllocatedStorage int: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
ApplyImmediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
AvailabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
EngineVersion string: The engine version number of the replication instance.
KmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
PubliclyAccessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
ReplicationSubnetGroupId string: A subnet group to associate with the replication instance.
Tags map[string]string: A map of tags to assign to the resource.
VpcSecurityGroupIds []string: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

replicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
replicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
allocatedStorage number: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
applyImmediately boolean: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
availabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
engineVersion string: The engine version number of the replication instance.
kmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
publiclyAccessible boolean: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
replicationSubnetGroupId string: A subnet group to associate with the replication instance.
tags {[key: string]: string}: A map of tags to assign to the resource.
vpcSecurityGroupIds string[]: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

replication_instance_class str: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
replication_instance_id str: The replication instance identifier. This parameter is stored as a lowercase string.
allocated_storage float: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
apply_immediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
availability_zone str: The EC2 Availability Zone that the replication instance will be created in.
engine_version str: The engine version number of the replication instance.
kms_key_arn str: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
publicly_accessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
replication_subnet_group_id str: A subnet group to associate with the replication instance.
tags Dict[str, str]: A map of tags to assign to the resource.
vpc_security_group_ids List[str]: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
ReplicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePrivateIps List<string>: A list of the private IP addresses of the replication instance.
ReplicationInstancePublicIps List<string>: A list of the public IP addresses of the replication instance.

Id string: The provider-assigned unique ID for this managed resource.
ReplicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstancePrivateIps []string: A list of the private IP addresses of the replication instance.
ReplicationInstancePublicIps []string: A list of the public IP addresses of the replication instance.

id string: The provider-assigned unique ID for this managed resource.
replicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
replicationInstancePrivateIps string[]: A list of the private IP addresses of the replication instance.
replicationInstancePublicIps string[]: A list of the public IP addresses of the replication instance.

id str: The provider-assigned unique ID for this managed resource.
replication_instance_arn str: The Amazon Resource Name (ARN) of the replication instance.
replication_instance_private_ips List[str]: A list of the private IP addresses of the replication instance.
replication_instance_public_ips List[str]: A list of the public IP addresses of the replication instance.

Look up an Existing ReplicationInstance Resource

Get an existing ReplicationInstance 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?: ReplicationInstanceState, opts?: CustomResourceOptions): ReplicationInstance

static get(resource_name, id, opts=None, allocated_storage=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, engine_version=None, kms_key_arn=None, multi_az=None, preferred_maintenance_window=None, publicly_accessible=None, replication_instance_arn=None, replication_instance_class=None, replication_instance_id=None, replication_instance_private_ips=None, replication_instance_public_ips=None, replication_subnet_group_id=None, tags=None, vpc_security_group_ids=None, __props__=None);

func GetReplicationInstance(ctx *Context, name string, id IDInput, state *ReplicationInstanceState, opts ...ResourceOption) (*ReplicationInstance, error)

public static ReplicationInstance Get(string name, Input<string> id, ReplicationInstanceState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AllocatedStorage int: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
ApplyImmediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
AvailabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
EngineVersion string: The engine version number of the replication instance.
KmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
PubliclyAccessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
ReplicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
ReplicationInstancePrivateIps List<string>: A list of the private IP addresses of the replication instance.
ReplicationInstancePublicIps List<string>: A list of the public IP addresses of the replication instance.
ReplicationSubnetGroupId string: A subnet group to associate with the replication instance.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
VpcSecurityGroupIds List<string>: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

AllocatedStorage int: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
ApplyImmediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
AvailabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
EngineVersion string: The engine version number of the replication instance.
KmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
PubliclyAccessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
ReplicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
ReplicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
ReplicationInstancePrivateIps []string: A list of the private IP addresses of the replication instance.
ReplicationInstancePublicIps []string: A list of the public IP addresses of the replication instance.
ReplicationSubnetGroupId string: A subnet group to associate with the replication instance.
Tags map[string]string: A map of tags to assign to the resource.
VpcSecurityGroupIds []string: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

allocatedStorage number: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
applyImmediately boolean: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
availabilityZone string: The EC2 Availability Zone that the replication instance will be created in.
engineVersion string: The engine version number of the replication instance.
kmsKeyArn string: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
publiclyAccessible boolean: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
replicationInstanceArn string: The Amazon Resource Name (ARN) of the replication instance.
replicationInstanceClass string: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
replicationInstanceId string: The replication instance identifier. This parameter is stored as a lowercase string.
replicationInstancePrivateIps string[]: A list of the private IP addresses of the replication instance.
replicationInstancePublicIps string[]: A list of the public IP addresses of the replication instance.
replicationSubnetGroupId string: A subnet group to associate with the replication instance.
tags {[key: string]: string}: A map of tags to assign to the resource.
vpcSecurityGroupIds string[]: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

allocated_storage float: The amount of storage (in gigabytes) to be initially allocated for the replication instance.
apply_immediately bool: Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
availability_zone str: The EC2 Availability Zone that the replication instance will be created in.
engine_version str: The engine version number of the replication instance.
kms_key_arn str: The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
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).
publicly_accessible bool: Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
replication_instance_arn str: The Amazon Resource Name (ARN) of the replication instance.
replication_instance_class str: The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
replication_instance_id str: The replication instance identifier. This parameter is stored as a lowercase string.
replication_instance_private_ips List[str]: A list of the private IP addresses of the replication instance.
replication_instance_public_ips List[str]: A list of the public IP addresses of the replication instance.
replication_subnet_group_id str: A subnet group to associate with the replication instance.
tags Dict[str, str]: A map of tags to assign to the resource.
vpc_security_group_ids List[str]: A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud