Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. dms
  5. getReplicationInstance
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.dms.getReplicationInstance

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

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

Example Usage

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

const test = aws.dms.getReplicationInstance({
    replicationInstanceId: testAwsDmsReplicationInstance.replicationInstanceId,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.dms.get_replication_instance(replication_instance_id=test_aws_dms_replication_instance["replicationInstanceId"])
Copy
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.LookupReplicationInstance(ctx, &dms.LookupReplicationInstanceArgs{
			ReplicationInstanceId: testAwsDmsReplicationInstance.ReplicationInstanceId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = testAwsDmsReplicationInstance.ReplicationInstanceId,
    });

});
Copy
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(testAwsDmsReplicationInstance.replicationInstanceId())
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:dms:getReplicationInstance
      arguments:
        replicationInstanceId: ${testAwsDmsReplicationInstance.replicationInstanceId}
Copy

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>
Copy
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]
Copy
func LookupReplicationInstance(ctx *Context, args *LookupReplicationInstanceArgs, opts ...InvokeOption) (*LookupReplicationInstanceResult, error)
func LookupReplicationInstanceOutput(ctx *Context, args *LookupReplicationInstanceOutputArgs, opts ...InvokeOption) LookupReplicationInstanceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetReplicationInstanceResult> getReplicationInstance(GetReplicationInstanceArgs args, InvokeOptions options)
public static Output<GetReplicationInstanceResult> getReplicationInstance(GetReplicationInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:dms/getReplicationInstance:getReplicationInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ReplicationInstanceId This property is required. string
The replication instance identifier.
Tags Dictionary<string, string>
ReplicationInstanceId This property is required. string
The replication instance identifier.
Tags map[string]string
replicationInstanceId This property is required. String
The replication instance identifier.
tags Map<String,String>
replicationInstanceId This property is required. string
The replication instance identifier.
tags {[key: string]: string}
replication_instance_id This property is required. str
The replication instance identifier.
tags Mapping[str, str]
replicationInstanceId This property is required. String
The replication instance identifier.
tags Map<String>

getReplicationInstance Result

The following output properties are available:

AllocatedStorage int
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyArn string
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
MultiAz bool
Specifies if the replication instance is a multi-az deployment.
NetworkType string
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
Tags Dictionary<string, string>
VpcSecurityGroupIds List<string>
A set of VPC security group IDs that are used with the replication instance.
AllocatedStorage int
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyArn string
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
MultiAz bool
Specifies if the replication instance is a multi-az deployment.
NetworkType string
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
Tags map[string]string
VpcSecurityGroupIds []string
A set of VPC security group IDs that are used with the replication instance.
allocatedStorage Integer
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyArn String
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
multiAz Boolean
Specifies if the replication instance is a multi-az deployment.
networkType String
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
tags Map<String,String>
vpcSecurityGroupIds List<String>
A set of VPC security group IDs that are used with the replication instance.
allocatedStorage number
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
id string
The provider-assigned unique ID for this managed resource.
kmsKeyArn string
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
multiAz boolean
Specifies if the replication instance is a multi-az deployment.
networkType string
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
tags {[key: string]: string}
vpcSecurityGroupIds string[]
A set of VPC security group IDs that are used with the replication instance.
allocated_storage int
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
id str
The provider-assigned unique ID for this managed resource.
kms_key_arn str
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
multi_az bool
Specifies if the replication instance is a multi-az deployment.
network_type str
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
tags Mapping[str, str]
vpc_security_group_ids Sequence[str]
A set of VPC security group IDs that are used with the replication instance.
allocatedStorage Number
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
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.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyArn String
The Amazon Resource Name (ARN) for the KMS key used to encrypt the connection parameters.
multiAz Boolean
Specifies if the replication instance is a multi-az deployment.
networkType String
The type of IP address protocol used by the replication instance.
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. See AWS DMS User Guide for information on instance classes.
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
A subnet group to associate with the replication instance.
tags Map<String>
vpcSecurityGroupIds List<String>
A set of VPC security group IDs that are used with 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 v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws