1. Packages
  2. AWS
  3. API Docs
  4. dms
  5. getReplicationInstance
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Data source for managing an AWS DMS (Database Migration) Replication Instance.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Aws.Dms.GetReplicationInstance.Invoke(new()
        {
            ReplicationInstanceId = aws_dms_replication_instance.Test.Replication_instance_id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/dms"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dms.LookupReplicationInstance(ctx, &dms.LookupReplicationInstanceArgs{
    			ReplicationInstanceId: aws_dms_replication_instance.Test.Replication_instance_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.dms.DmsFunctions;
    import com.pulumi.aws.dms.inputs.GetReplicationInstanceArgs;
    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) {
            final var test = DmsFunctions.getReplicationInstance(GetReplicationInstanceArgs.builder()
                .replicationInstanceId(aws_dms_replication_instance.test().replication_instance_id())
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = aws.dms.getReplicationInstance({
        replicationInstanceId: aws_dms_replication_instance.test.replication_instance_id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.dms.get_replication_instance(replication_instance_id=aws_dms_replication_instance["test"]["replication_instance_id"])
    
    variables:
      test:
        fn::invoke:
          Function: aws:dms:getReplicationInstance
          Arguments:
            replicationInstanceId: ${aws_dms_replication_instance.test.replication_instance_id}
    

    Using getReplicationInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReplicationInstance(args: GetReplicationInstanceArgs, opts?: InvokeOptions): Promise<GetReplicationInstanceResult>
    function getReplicationInstanceOutput(args: GetReplicationInstanceOutputArgs, opts?: InvokeOptions): Output<GetReplicationInstanceResult>
    def get_replication_instance(replication_instance_id: Optional[str] = None,
                                 tags: Optional[Mapping[str, str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetReplicationInstanceResult
    def get_replication_instance_output(replication_instance_id: Optional[pulumi.Input[str]] = None,
                                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetReplicationInstanceResult]
    func LookupReplicationInstance(ctx *Context, args *LookupReplicationInstanceArgs, opts ...InvokeOption) (*LookupReplicationInstanceResult, error)
    func LookupReplicationInstanceOutput(ctx *Context, args *LookupReplicationInstanceOutputArgs, opts ...InvokeOption) LookupReplicationInstanceResultOutput

    > Note: This function is named LookupReplicationInstance in the Go SDK.

    public static class GetReplicationInstance 
    {
        public static Task<GetReplicationInstanceResult> InvokeAsync(GetReplicationInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetReplicationInstanceResult> Invoke(GetReplicationInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetReplicationInstanceResult> getReplicationInstance(GetReplicationInstanceArgs args, InvokeOptions options)
    public static Output<GetReplicationInstanceResult> getReplicationInstance(GetReplicationInstanceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:dms/getReplicationInstance:getReplicationInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ReplicationInstanceId string
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    Tags Dictionary<string, string>
    ReplicationInstanceId string
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    Tags map[string]string
    replicationInstanceId String
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    tags Map<String,String>
    replicationInstanceId string
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    tags {[key: string]: string}
    replication_instance_id str
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    tags Mapping[str, str]
    replicationInstanceId String
    The replication instance identifier. This parameter is stored as a lowercase string.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen
    • Cannot contain two consecutive hyphens.
    tags Map<String>

    getReplicationInstance Result

    The following output properties are available:

    AllocatedStorage int
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    AllowMajorVersionUpgrade bool
    (Default: false) Indicates that major version upgrades are allowed.
    ApplyImmediately bool
    (Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    AutoMinorVersionUpgrade bool
    (Default: false) 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    ReplicationInstanceId 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
    (Optional) A subnet group to associate with the replication instance.
    Tags Dictionary<string, string>
    VpcSecurityGroupIds List<string>
    (Optional) 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
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    AllowMajorVersionUpgrade bool
    (Default: false) Indicates that major version upgrades are allowed.
    ApplyImmediately bool
    (Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    AutoMinorVersionUpgrade bool
    (Default: false) 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    ReplicationInstanceId 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
    (Optional) A subnet group to associate with the replication instance.
    Tags map[string]string
    VpcSecurityGroupIds []string
    (Optional) 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 Integer
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    allowMajorVersionUpgrade Boolean
    (Default: false) Indicates that major version upgrades are allowed.
    applyImmediately Boolean
    (Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    autoMinorVersionUpgrade Boolean
    (Default: false) 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.
    id String
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    replicationInstanceId 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
    (Optional) A subnet group to associate with the replication instance.
    tags Map<String,String>
    vpcSecurityGroupIds List<String>
    (Optional) 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
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    allowMajorVersionUpgrade boolean
    (Default: false) Indicates that major version upgrades are allowed.
    applyImmediately boolean
    (Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    autoMinorVersionUpgrade boolean
    (Default: false) 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.
    id string
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    replicationInstanceId 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
    (Optional) A subnet group to associate with the replication instance.
    tags {[key: string]: string}
    vpcSecurityGroupIds string[]
    (Optional) 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 int
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    allow_major_version_upgrade bool
    (Default: false) Indicates that major version upgrades are allowed.
    apply_immediately bool
    (Default: false) 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
    (Default: false) 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.
    id str
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    replication_instance_id str
    replication_instance_private_ips Sequence[str]
    A list of the private IP addresses of the replication instance.
    replication_instance_public_ips Sequence[str]
    A list of the public IP addresses of the replication instance.
    replication_subnet_group_id str
    (Optional) A subnet group to associate with the replication instance.
    tags Mapping[str, str]
    vpc_security_group_ids Sequence[str]
    (Optional) 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
    (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    allowMajorVersionUpgrade Boolean
    (Default: false) Indicates that major version upgrades are allowed.
    applyImmediately Boolean
    (Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    autoMinorVersionUpgrade Boolean
    (Default: false) 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.
    id String
    The provider-assigned unique ID for this managed resource.
    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
    (Default: false) 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. See AWS DMS User Guide for available instance sizes and advice on which one to choose.
    replicationInstanceId 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
    (Optional) A subnet group to associate with the replication instance.
    tags Map<String>
    vpcSecurityGroupIds List<String>
    (Optional) 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
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.