Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
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 dictionaryThe following arguments are supported:
- Replication
Instance stringId - 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.
- Dictionary<string, string>
- Replication
Instance stringId - 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.
- map[string]string
- replication
Instance StringId - 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.
- Map<String,String>
- replication
Instance stringId - 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.
- {[key: string]: string}
- replication_
instance_ strid - 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.
- Mapping[str, str]
- replication
Instance StringId - 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.
- Map<String>
getReplicationInstance Result
The following output properties are available:
- 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 boolVersion Upgrade - (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 boolVersion Upgrade - (Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
- Availability
Zone string - The EC2 Availability Zone that the replication instance will be created in.
- Engine
Version string - The engine version number of the replication instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringArn - 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_zoneparameter if themulti_azparameter is set totrue. - Preferred
Maintenance stringWindow - 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 stringArn - The Amazon Resource Name (ARN) of the replication instance.
- Replication
Instance stringClass - 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 stringId - Replication
Instance List<string>Private Ips - A list of the private IP addresses of the replication instance.
- Replication
Instance List<string>Public Ips - A list of the public IP addresses of the replication instance.
- Replication
Subnet stringGroup Id - (Optional) A subnet group to associate with the replication instance.
- Dictionary<string, string>
- Vpc
Security List<string>Group Ids - (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 boolVersion Upgrade - (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 boolVersion Upgrade - (Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
- Availability
Zone string - The EC2 Availability Zone that the replication instance will be created in.
- Engine
Version string - The engine version number of the replication instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringArn - 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_zoneparameter if themulti_azparameter is set totrue. - Preferred
Maintenance stringWindow - 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 stringArn - The Amazon Resource Name (ARN) of the replication instance.
- Replication
Instance stringClass - 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 stringId - Replication
Instance []stringPrivate Ips - A list of the private IP addresses of the replication instance.
- Replication
Instance []stringPublic Ips - A list of the public IP addresses of the replication instance.
- Replication
Subnet stringGroup Id - (Optional) A subnet group to associate with the replication instance.
- map[string]string
- Vpc
Security []stringGroup Ids - (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 Integer - (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
- allow
Major BooleanVersion Upgrade - (Default: false) Indicates that major version upgrades are allowed.
- apply
Immediately Boolean - (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 BooleanVersion Upgrade - (Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
- availability
Zone String - The EC2 Availability Zone that the replication instance will be created in.
- engine
Version String - The engine version number of the replication instance.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringArn - 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 Boolean - Specifies if the replication instance is a multi-az deployment. You cannot set the
availability_zoneparameter if themulti_azparameter is set totrue. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- publicly
Accessible 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.
- replication
Instance StringArn - The Amazon Resource Name (ARN) of the replication instance.
- replication
Instance StringClass - 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 StringId - replication
Instance List<String>Private Ips - A list of the private IP addresses of the replication instance.
- replication
Instance List<String>Public Ips - A list of the public IP addresses of the replication instance.
- replication
Subnet StringGroup Id - (Optional) A subnet group to associate with the replication instance.
- Map<String,String>
- vpc
Security List<String>Group Ids - (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 number - (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
- allow
Major booleanVersion Upgrade - (Default: false) Indicates that major version upgrades are allowed.
- apply
Immediately boolean - (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 booleanVersion Upgrade - (Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
- availability
Zone string - The EC2 Availability Zone that the replication instance will be created in.
- engine
Version string - The engine version number of the replication instance.
- id string
- The provider-assigned unique ID for this managed resource.
- kms
Key stringArn - 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 boolean - Specifies if the replication instance is a multi-az deployment. You cannot set the
availability_zoneparameter if themulti_azparameter is set totrue. - preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- publicly
Accessible 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.
- replication
Instance stringArn - The Amazon Resource Name (ARN) of the replication instance.
- replication
Instance stringClass - 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 stringId - replication
Instance string[]Private Ips - A list of the private IP addresses of the replication instance.
- replication
Instance string[]Public Ips - A list of the public IP addresses of the replication instance.
- replication
Subnet stringGroup Id - (Optional) A subnet group to associate with the replication instance.
- {[key: string]: string}
- vpc
Security string[]Group Ids - (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_ boolversion_ upgrade - (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_ boolversion_ upgrade - (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_ strarn - 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_zoneparameter if themulti_azparameter is set totrue. - preferred_
maintenance_ strwindow - 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_ strarn - The Amazon Resource Name (ARN) of the replication instance.
- replication_
instance_ strclass - 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_ strid - replication_
instance_ Sequence[str]private_ ips - A list of the private IP addresses of the replication instance.
- replication_
instance_ Sequence[str]public_ ips - A list of the public IP addresses of the replication instance.
- replication_
subnet_ strgroup_ id - (Optional) A subnet group to associate with the replication instance.
- Mapping[str, str]
- vpc_
security_ Sequence[str]group_ ids - (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 Number - (Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
- allow
Major BooleanVersion Upgrade - (Default: false) Indicates that major version upgrades are allowed.
- apply
Immediately Boolean - (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 BooleanVersion Upgrade - (Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
- availability
Zone String - The EC2 Availability Zone that the replication instance will be created in.
- engine
Version String - The engine version number of the replication instance.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringArn - 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 Boolean - Specifies if the replication instance is a multi-az deployment. You cannot set the
availability_zoneparameter if themulti_azparameter is set totrue. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- publicly
Accessible 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.
- replication
Instance StringArn - The Amazon Resource Name (ARN) of the replication instance.
- replication
Instance StringClass - 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 StringId - replication
Instance List<String>Private Ips - A list of the private IP addresses of the replication instance.
- replication
Instance List<String>Public Ips - A list of the public IP addresses of the replication instance.
- replication
Subnet StringGroup Id - (Optional) A subnet group to associate with the replication instance.
- Map<String>
- vpc
Security List<String>Group Ids - (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
awsTerraform Provider.
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
