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

aws.memorydb.SubnetGroup

Explore with Pulumi AI

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

Provides a MemoryDB Subnet Group.

More information about subnet groups can be found in the MemoryDB User Guide.

Example Usage

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

const example = new aws.ec2.Vpc("example", {cidrBlock: "10.0.0.0/16"});
const exampleSubnet = new aws.ec2.Subnet("example", {
    vpcId: example.id,
    cidrBlock: "10.0.0.0/24",
    availabilityZone: "us-west-2a",
});
const exampleSubnetGroup = new aws.memorydb.SubnetGroup("example", {
    name: "my-subnet-group",
    subnetIds: [exampleSubnet.id],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2.Vpc("example", cidr_block="10.0.0.0/16")
example_subnet = aws.ec2.Subnet("example",
    vpc_id=example.id,
    cidr_block="10.0.0.0/24",
    availability_zone="us-west-2a")
example_subnet_group = aws.memorydb.SubnetGroup("example",
    name="my-subnet-group",
    subnet_ids=[example_subnet.id])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.NewVpc(ctx, "example", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := ec2.NewSubnet(ctx, "example", &ec2.SubnetArgs{
			VpcId:            example.ID(),
			CidrBlock:        pulumi.String("10.0.0.0/24"),
			AvailabilityZone: pulumi.String("us-west-2a"),
		})
		if err != nil {
			return err
		}
		_, err = memorydb.NewSubnetGroup(ctx, "example", &memorydb.SubnetGroupArgs{
			Name: pulumi.String("my-subnet-group"),
			SubnetIds: pulumi.StringArray{
				exampleSubnet.ID(),
			},
		})
		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 example = new Aws.Ec2.Vpc("example", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    var exampleSubnet = new Aws.Ec2.Subnet("example", new()
    {
        VpcId = example.Id,
        CidrBlock = "10.0.0.0/24",
        AvailabilityZone = "us-west-2a",
    });

    var exampleSubnetGroup = new Aws.MemoryDb.SubnetGroup("example", new()
    {
        Name = "my-subnet-group",
        SubnetIds = new[]
        {
            exampleSubnet.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.aws.memorydb.SubnetGroup;
import com.pulumi.aws.memorydb.SubnetGroupArgs;
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 example = new Vpc("example", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .vpcId(example.id())
            .cidrBlock("10.0.0.0/24")
            .availabilityZone("us-west-2a")
            .build());

        var exampleSubnetGroup = new SubnetGroup("exampleSubnetGroup", SubnetGroupArgs.builder()
            .name("my-subnet-group")
            .subnetIds(exampleSubnet.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  exampleSubnet:
    type: aws:ec2:Subnet
    name: example
    properties:
      vpcId: ${example.id}
      cidrBlock: 10.0.0.0/24
      availabilityZone: us-west-2a
  exampleSubnetGroup:
    type: aws:memorydb:SubnetGroup
    name: example
    properties:
      name: my-subnet-group
      subnetIds:
        - ${exampleSubnet.id}
Copy

Create SubnetGroup Resource

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

Constructor syntax

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

@overload
def SubnetGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                name_prefix: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
func NewSubnetGroup(ctx *Context, name string, args SubnetGroupArgs, opts ...ResourceOption) (*SubnetGroup, error)
public SubnetGroup(string name, SubnetGroupArgs args, CustomResourceOptions? opts = null)
public SubnetGroup(String name, SubnetGroupArgs args)
public SubnetGroup(String name, SubnetGroupArgs args, CustomResourceOptions options)

type: aws:memorydb:SubnetGroup
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. SubnetGroupArgs
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. SubnetGroupArgs
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. SubnetGroupArgs
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. SubnetGroupArgs
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. SubnetGroupArgs
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 examplesubnetGroupResourceResourceFromMemorydbsubnetGroup = new Aws.MemoryDb.SubnetGroup("examplesubnetGroupResourceResourceFromMemorydbsubnetGroup", new()
{
    SubnetIds = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    NamePrefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := memorydb.NewSubnetGroup(ctx, "examplesubnetGroupResourceResourceFromMemorydbsubnetGroup", &memorydb.SubnetGroupArgs{
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	NamePrefix:  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var examplesubnetGroupResourceResourceFromMemorydbsubnetGroup = new SubnetGroup("examplesubnetGroupResourceResourceFromMemorydbsubnetGroup", SubnetGroupArgs.builder()
    .subnetIds("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
examplesubnet_group_resource_resource_from_memorydbsubnet_group = aws.memorydb.SubnetGroup("examplesubnetGroupResourceResourceFromMemorydbsubnetGroup",
    subnet_ids=["string"],
    description="string",
    name="string",
    name_prefix="string",
    tags={
        "string": "string",
    })
Copy
const examplesubnetGroupResourceResourceFromMemorydbsubnetGroup = new aws.memorydb.SubnetGroup("examplesubnetGroupResourceResourceFromMemorydbsubnetGroup", {
    subnetIds: ["string"],
    description: "string",
    name: "string",
    namePrefix: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:memorydb:SubnetGroup
properties:
    description: string
    name: string
    namePrefix: string
    subnetIds:
        - string
    tags:
        string: string
Copy

SubnetGroup 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 SubnetGroup resource accepts the following input properties:

SubnetIds This property is required. List<string>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

Description string
Description for the subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
NamePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags Dictionary<string, string>
A 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.
SubnetIds This property is required. []string

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

Description string
Description for the subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
NamePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags map[string]string
A 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.
subnetIds This property is required. List<String>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

description String
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String,String>
A 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.
subnetIds This property is required. string[]

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

description string
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
tags {[key: string]: string}
A 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.
subnet_ids This property is required. Sequence[str]

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

description str
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
name_prefix Changes to this property will trigger replacement. str
Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Mapping[str, str]
A 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.
subnetIds This property is required. List<String>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

description String
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String>
A 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 SubnetGroup resource produces the following output properties:

Arn string
The ARN of the subnet group.
Id string
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.
Arn string
The ARN of the subnet group.
Id string
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.
arn String
The ARN of the subnet group.
id String
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.
arn string
The ARN of the subnet group.
id string
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.
arn str
The ARN of the subnet group.
id str
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.
arn String
The ARN of the subnet group.
id String
The provider-assigned unique ID for this managed resource.
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 VPC in which the subnet group exists.

Look up Existing SubnetGroup Resource

Get an existing SubnetGroup 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?: SubnetGroupState, opts?: CustomResourceOptions): SubnetGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: 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) -> SubnetGroup
func GetSubnetGroup(ctx *Context, name string, id IDInput, state *SubnetGroupState, opts ...ResourceOption) (*SubnetGroup, error)
public static SubnetGroup Get(string name, Input<string> id, SubnetGroupState? state, CustomResourceOptions? opts = null)
public static SubnetGroup get(String name, Output<String> id, SubnetGroupState state, CustomResourceOptions options)
resources:  _:    type: aws:memorydb:SubnetGroup    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:
Arn string
The ARN of the subnet group.
Description string
Description for the subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
NamePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
SubnetIds List<string>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

Tags Dictionary<string, string>
A 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 VPC in which the subnet group exists.
Arn string
The ARN of the subnet group.
Description string
Description for the subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
NamePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
SubnetIds []string

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

Tags map[string]string
A 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 VPC in which the subnet group exists.
arn String
The ARN of the subnet group.
description String
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds List<String>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

tags Map<String,String>
A 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 VPC in which the subnet group exists.
arn string
The ARN of the subnet group.
description string
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. string
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds string[]

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

tags {[key: string]: string}
A 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 VPC in which the subnet group exists.
arn str
The ARN of the subnet group.
description str
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
name_prefix Changes to this property will trigger replacement. str
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnet_ids Sequence[str]

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

tags Mapping[str, str]
A 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 VPC in which the subnet group exists.
arn String
The ARN of the subnet group.
description String
Description for the subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name of the subnet group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds List<String>

Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided.

The following arguments are optional:

tags Map<String>
A 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 VPC in which the subnet group exists.

Import

Using pulumi import, import a subnet group using its name. For example:

$ pulumi import aws:memorydb/subnetGroup:SubnetGroup example my-subnet-group
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.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws