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

aws.dms.ReplicationSubnetGroup

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Provides a DMS (Data Migration Service) replication subnet group resource. DMS replication subnet groups can be created, updated, deleted, and imported.

Note: AWS requires a special IAM role called dms-vpc-role when using this resource. See the example below to create it as part of your configuration.

Example Usage

Basic

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

// Create a new replication subnet group
const example = new aws.dms.ReplicationSubnetGroup("example", {
    replicationSubnetGroupDescription: "Example replication subnet group",
    replicationSubnetGroupId: "example-dms-replication-subnet-group-tf",
    subnetIds: [
        "subnet-12345678",
        "subnet-12345679",
    ],
    tags: {
        Name: "example",
    },
});
Copy
import pulumi
import pulumi_aws as aws

# Create a new replication subnet group
example = aws.dms.ReplicationSubnetGroup("example",
    replication_subnet_group_description="Example replication subnet group",
    replication_subnet_group_id="example-dms-replication-subnet-group-tf",
    subnet_ids=[
        "subnet-12345678",
        "subnet-12345679",
    ],
    tags={
        "Name": "example",
    })
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 {
		// Create a new replication subnet group
		_, err := dms.NewReplicationSubnetGroup(ctx, "example", &dms.ReplicationSubnetGroupArgs{
			ReplicationSubnetGroupDescription: pulumi.String("Example replication subnet group"),
			ReplicationSubnetGroupId:          pulumi.String("example-dms-replication-subnet-group-tf"),
			SubnetIds: pulumi.StringArray{
				pulumi.String("subnet-12345678"),
				pulumi.String("subnet-12345679"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
			},
		})
		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(() => 
{
    // Create a new replication subnet group
    var example = new Aws.Dms.ReplicationSubnetGroup("example", new()
    {
        ReplicationSubnetGroupDescription = "Example replication subnet group",
        ReplicationSubnetGroupId = "example-dms-replication-subnet-group-tf",
        SubnetIds = new[]
        {
            "subnet-12345678",
            "subnet-12345679",
        },
        Tags = 
        {
            { "Name", "example" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.ReplicationSubnetGroup;
import com.pulumi.aws.dms.ReplicationSubnetGroupArgs;
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) {
        // Create a new replication subnet group
        var example = new ReplicationSubnetGroup("example", ReplicationSubnetGroupArgs.builder()
            .replicationSubnetGroupDescription("Example replication subnet group")
            .replicationSubnetGroupId("example-dms-replication-subnet-group-tf")
            .subnetIds(            
                "subnet-12345678",
                "subnet-12345679")
            .tags(Map.of("Name", "example"))
            .build());

    }
}
Copy
resources:
  # Create a new replication subnet group
  example:
    type: aws:dms:ReplicationSubnetGroup
    properties:
      replicationSubnetGroupDescription: Example replication subnet group
      replicationSubnetGroupId: example-dms-replication-subnet-group-tf
      subnetIds:
        - subnet-12345678
        - subnet-12345679
      tags:
        Name: example
Copy

Creating special IAM role

If your account does not already include the dms-vpc-role IAM role, you will need to create it to allow DMS to manage subnets in the VPC.

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

const dms_vpc_role = new aws.iam.Role("dms-vpc-role", {
    name: "dms-vpc-role",
    description: "Allows DMS to manage VPC",
    assumeRolePolicy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Effect: "Allow",
            Principal: {
                Service: "dms.amazonaws.com",
            },
            Action: "sts:AssumeRole",
        }],
    }),
});
const example = new aws.iam.RolePolicyAttachment("example", {
    role: dms_vpc_role.name,
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
});
const exampleReplicationSubnetGroup = new aws.dms.ReplicationSubnetGroup("example", {
    replicationSubnetGroupDescription: "Example",
    replicationSubnetGroupId: "example-id",
    subnetIds: [
        "subnet-12345678",
        "subnet-12345679",
    ],
    tags: {
        Name: "example-id",
    },
}, {
    dependsOn: [example],
});
Copy
import pulumi
import json
import pulumi_aws as aws

dms_vpc_role = aws.iam.Role("dms-vpc-role",
    name="dms-vpc-role",
    description="Allows DMS to manage VPC",
    assume_role_policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Effect": "Allow",
            "Principal": {
                "Service": "dms.amazonaws.com",
            },
            "Action": "sts:AssumeRole",
        }],
    }))
example = aws.iam.RolePolicyAttachment("example",
    role=dms_vpc_role.name,
    policy_arn="arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole")
example_replication_subnet_group = aws.dms.ReplicationSubnetGroup("example",
    replication_subnet_group_description="Example",
    replication_subnet_group_id="example-id",
    subnet_ids=[
        "subnet-12345678",
        "subnet-12345679",
    ],
    tags={
        "Name": "example-id",
    },
    opts = pulumi.ResourceOptions(depends_on=[example]))
Copy
package main

import (
	"encoding/json"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Effect": "Allow",
					"Principal": map[string]interface{}{
						"Service": "dms.amazonaws.com",
					},
					"Action": "sts:AssumeRole",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		dms_vpc_role, err := iam.NewRole(ctx, "dms-vpc-role", &iam.RoleArgs{
			Name:             pulumi.String("dms-vpc-role"),
			Description:      pulumi.String("Allows DMS to manage VPC"),
			AssumeRolePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		example, err := iam.NewRolePolicyAttachment(ctx, "example", &iam.RolePolicyAttachmentArgs{
			Role:      dms_vpc_role.Name,
			PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole"),
		})
		if err != nil {
			return err
		}
		_, err = dms.NewReplicationSubnetGroup(ctx, "example", &dms.ReplicationSubnetGroupArgs{
			ReplicationSubnetGroupDescription: pulumi.String("Example"),
			ReplicationSubnetGroupId:          pulumi.String("example-id"),
			SubnetIds: pulumi.StringArray{
				pulumi.String("subnet-12345678"),
				pulumi.String("subnet-12345679"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-id"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			example,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var dms_vpc_role = new Aws.Iam.Role("dms-vpc-role", new()
    {
        Name = "dms-vpc-role",
        Description = "Allows DMS to manage VPC",
        AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Effect"] = "Allow",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["Service"] = "dms.amazonaws.com",
                    },
                    ["Action"] = "sts:AssumeRole",
                },
            },
        }),
    });

    var example = new Aws.Iam.RolePolicyAttachment("example", new()
    {
        Role = dms_vpc_role.Name,
        PolicyArn = "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
    });

    var exampleReplicationSubnetGroup = new Aws.Dms.ReplicationSubnetGroup("example", new()
    {
        ReplicationSubnetGroupDescription = "Example",
        ReplicationSubnetGroupId = "example-id",
        SubnetIds = new[]
        {
            "subnet-12345678",
            "subnet-12345679",
        },
        Tags = 
        {
            { "Name", "example-id" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            example,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicyAttachment;
import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
import com.pulumi.aws.dms.ReplicationSubnetGroup;
import com.pulumi.aws.dms.ReplicationSubnetGroupArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var dms_vpc_role = new Role("dms-vpc-role", RoleArgs.builder()
            .name("dms-vpc-role")
            .description("Allows DMS to manage VPC")
            .assumeRolePolicy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("Service", "dms.amazonaws.com")
                        )),
                        jsonProperty("Action", "sts:AssumeRole")
                    )))
                )))
            .build());

        var example = new RolePolicyAttachment("example", RolePolicyAttachmentArgs.builder()
            .role(dms_vpc_role.name())
            .policyArn("arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole")
            .build());

        var exampleReplicationSubnetGroup = new ReplicationSubnetGroup("exampleReplicationSubnetGroup", ReplicationSubnetGroupArgs.builder()
            .replicationSubnetGroupDescription("Example")
            .replicationSubnetGroupId("example-id")
            .subnetIds(            
                "subnet-12345678",
                "subnet-12345679")
            .tags(Map.of("Name", "example-id"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(example)
                .build());

    }
}
Copy
resources:
  dms-vpc-role:
    type: aws:iam:Role
    properties:
      name: dms-vpc-role
      description: Allows DMS to manage VPC
      assumeRolePolicy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Effect: Allow
              Principal:
                Service: dms.amazonaws.com
              Action: sts:AssumeRole
  example:
    type: aws:iam:RolePolicyAttachment
    properties:
      role: ${["dms-vpc-role"].name}
      policyArn: arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole
  exampleReplicationSubnetGroup:
    type: aws:dms:ReplicationSubnetGroup
    name: example
    properties:
      replicationSubnetGroupDescription: Example
      replicationSubnetGroupId: example-id
      subnetIds:
        - subnet-12345678
        - subnet-12345679
      tags:
        Name: example-id
    options:
      dependsOn:
        - ${example}
Copy

Create ReplicationSubnetGroup Resource

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

Constructor syntax

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

@overload
def ReplicationSubnetGroup(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           replication_subnet_group_description: Optional[str] = None,
                           replication_subnet_group_id: Optional[str] = None,
                           subnet_ids: Optional[Sequence[str]] = None,
                           tags: Optional[Mapping[str, str]] = None)
func NewReplicationSubnetGroup(ctx *Context, name string, args ReplicationSubnetGroupArgs, opts ...ResourceOption) (*ReplicationSubnetGroup, error)
public ReplicationSubnetGroup(string name, ReplicationSubnetGroupArgs args, CustomResourceOptions? opts = null)
public ReplicationSubnetGroup(String name, ReplicationSubnetGroupArgs args)
public ReplicationSubnetGroup(String name, ReplicationSubnetGroupArgs args, CustomResourceOptions options)

type: aws:dms:ReplicationSubnetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReplicationSubnetGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ReplicationSubnetGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ReplicationSubnetGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReplicationSubnetGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReplicationSubnetGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var replicationSubnetGroupResource = new Aws.Dms.ReplicationSubnetGroup("replicationSubnetGroupResource", new()
{
    ReplicationSubnetGroupDescription = "string",
    ReplicationSubnetGroupId = "string",
    SubnetIds = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := dms.NewReplicationSubnetGroup(ctx, "replicationSubnetGroupResource", &dms.ReplicationSubnetGroupArgs{
	ReplicationSubnetGroupDescription: pulumi.String("string"),
	ReplicationSubnetGroupId:          pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var replicationSubnetGroupResource = new ReplicationSubnetGroup("replicationSubnetGroupResource", ReplicationSubnetGroupArgs.builder()
    .replicationSubnetGroupDescription("string")
    .replicationSubnetGroupId("string")
    .subnetIds("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
replication_subnet_group_resource = aws.dms.ReplicationSubnetGroup("replicationSubnetGroupResource",
    replication_subnet_group_description="string",
    replication_subnet_group_id="string",
    subnet_ids=["string"],
    tags={
        "string": "string",
    })
Copy
const replicationSubnetGroupResource = new aws.dms.ReplicationSubnetGroup("replicationSubnetGroupResource", {
    replicationSubnetGroupDescription: "string",
    replicationSubnetGroupId: "string",
    subnetIds: ["string"],
    tags: {
        string: "string",
    },
});
Copy
type: aws:dms:ReplicationSubnetGroup
properties:
    replicationSubnetGroupDescription: string
    replicationSubnetGroupId: string
    subnetIds:
        - string
    tags:
        string: string
Copy

ReplicationSubnetGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ReplicationSubnetGroup resource accepts the following input properties:

ReplicationSubnetGroupDescription This property is required. string
Description for the subnet group.
ReplicationSubnetGroupId
This property is required.
Changes to this property will trigger replacement.
string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
SubnetIds This property is required. List<string>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
Tags Dictionary<string, string>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ReplicationSubnetGroupDescription This property is required. string
Description for the subnet group.
ReplicationSubnetGroupId
This property is required.
Changes to this property will trigger replacement.
string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
SubnetIds This property is required. []string
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
Tags map[string]string
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
replicationSubnetGroupDescription This property is required. String
Description for the subnet group.
replicationSubnetGroupId
This property is required.
Changes to this property will trigger replacement.
String
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds This property is required. List<String>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Map<String,String>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
replicationSubnetGroupDescription This property is required. string
Description for the subnet group.
replicationSubnetGroupId
This property is required.
Changes to this property will trigger replacement.
string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds This property is required. string[]
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags {[key: string]: string}
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
replication_subnet_group_description This property is required. str
Description for the subnet group.
replication_subnet_group_id
This property is required.
Changes to this property will trigger replacement.
str
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnet_ids This property is required. Sequence[str]
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Mapping[str, str]
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
replicationSubnetGroupDescription This property is required. String
Description for the subnet group.
replicationSubnetGroupId
This property is required.
Changes to this property will trigger replacement.
String
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds This property is required. List<String>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Map<String>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ReplicationSubnetGroupArn string
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The ID of the VPC the subnet group is in.
Id string
The provider-assigned unique ID for this managed resource.
ReplicationSubnetGroupArn string
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The ID of the VPC the subnet group is in.
id String
The provider-assigned unique ID for this managed resource.
replicationSubnetGroupArn String
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The ID of the VPC the subnet group is in.
id string
The provider-assigned unique ID for this managed resource.
replicationSubnetGroupArn string
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
The ID of the VPC the subnet group is in.
id str
The provider-assigned unique ID for this managed resource.
replication_subnet_group_arn str
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
The ID of the VPC the subnet group is in.
id String
The provider-assigned unique ID for this managed resource.
replicationSubnetGroupArn String
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The ID of the VPC the subnet group is in.

Look up Existing ReplicationSubnetGroup Resource

Get an existing ReplicationSubnetGroup 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?: ReplicationSubnetGroupState, opts?: CustomResourceOptions): ReplicationSubnetGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        replication_subnet_group_arn: Optional[str] = None,
        replication_subnet_group_description: Optional[str] = None,
        replication_subnet_group_id: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> ReplicationSubnetGroup
func GetReplicationSubnetGroup(ctx *Context, name string, id IDInput, state *ReplicationSubnetGroupState, opts ...ResourceOption) (*ReplicationSubnetGroup, error)
public static ReplicationSubnetGroup Get(string name, Input<string> id, ReplicationSubnetGroupState? state, CustomResourceOptions? opts = null)
public static ReplicationSubnetGroup get(String name, Output<String> id, ReplicationSubnetGroupState state, CustomResourceOptions options)
resources:  _:    type: aws:dms:ReplicationSubnetGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ReplicationSubnetGroupArn string
ReplicationSubnetGroupDescription string
Description for the subnet group.
ReplicationSubnetGroupId Changes to this property will trigger replacement. string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
SubnetIds List<string>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
Tags Dictionary<string, string>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The ID of the VPC the subnet group is in.
ReplicationSubnetGroupArn string
ReplicationSubnetGroupDescription string
Description for the subnet group.
ReplicationSubnetGroupId Changes to this property will trigger replacement. string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
SubnetIds []string
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
Tags map[string]string
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The ID of the VPC the subnet group is in.
replicationSubnetGroupArn String
replicationSubnetGroupDescription String
Description for the subnet group.
replicationSubnetGroupId Changes to this property will trigger replacement. String
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds List<String>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Map<String,String>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The ID of the VPC the subnet group is in.
replicationSubnetGroupArn string
replicationSubnetGroupDescription string
Description for the subnet group.
replicationSubnetGroupId Changes to this property will trigger replacement. string
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds string[]
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags {[key: string]: string}
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
The ID of the VPC the subnet group is in.
replication_subnet_group_arn str
replication_subnet_group_description str
Description for the subnet group.
replication_subnet_group_id Changes to this property will trigger replacement. str
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnet_ids Sequence[str]
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Mapping[str, str]
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
The ID of the VPC the subnet group is in.
replicationSubnetGroupArn String
replicationSubnetGroupDescription String
Description for the subnet group.
replicationSubnetGroupId Changes to this property will trigger replacement. String
Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be default.
subnetIds List<String>
List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones.
tags Map<String>
Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The ID of the VPC the subnet group is in.

Import

Using pulumi import, import replication subnet groups using the replication_subnet_group_id. For example:

$ pulumi import aws:dms/replicationSubnetGroup:ReplicationSubnetGroup test test-dms-replication-subnet-group-tf
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws