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

aws.elasticache.SubnetGroup

Explore with Pulumi AI

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

Provides an ElastiCache Subnet Group resource.

Example Usage

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

const foo = new aws.ec2.Vpc("foo", {
    cidrBlock: "10.0.0.0/16",
    tags: {
        Name: "tf-test",
    },
});
const fooSubnet = new aws.ec2.Subnet("foo", {
    vpcId: foo.id,
    cidrBlock: "10.0.0.0/24",
    availabilityZone: "us-west-2a",
    tags: {
        Name: "tf-test",
    },
});
const bar = new aws.elasticache.SubnetGroup("bar", {
    name: "tf-test-cache-subnet",
    subnetIds: [fooSubnet.id],
});
Copy
import pulumi
import pulumi_aws as aws

foo = aws.ec2.Vpc("foo",
    cidr_block="10.0.0.0/16",
    tags={
        "Name": "tf-test",
    })
foo_subnet = aws.ec2.Subnet("foo",
    vpc_id=foo.id,
    cidr_block="10.0.0.0/24",
    availability_zone="us-west-2a",
    tags={
        "Name": "tf-test",
    })
bar = aws.elasticache.SubnetGroup("bar",
    name="tf-test-cache-subnet",
    subnet_ids=[foo_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/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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

    var fooSubnet = new Aws.Ec2.Subnet("foo", new()
    {
        VpcId = foo.Id,
        CidrBlock = "10.0.0.0/24",
        AvailabilityZone = "us-west-2a",
        Tags = 
        {
            { "Name", "tf-test" },
        },
    });

    var bar = new Aws.ElastiCache.SubnetGroup("bar", new()
    {
        Name = "tf-test-cache-subnet",
        SubnetIds = new[]
        {
            fooSubnet.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.elasticache.SubnetGroup;
import com.pulumi.aws.elasticache.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 foo = new Vpc("foo", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .tags(Map.of("Name", "tf-test"))
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()
            .vpcId(foo.id())
            .cidrBlock("10.0.0.0/24")
            .availabilityZone("us-west-2a")
            .tags(Map.of("Name", "tf-test"))
            .build());

        var bar = new SubnetGroup("bar", SubnetGroupArgs.builder()
            .name("tf-test-cache-subnet")
            .subnetIds(fooSubnet.id())
            .build());

    }
}
Copy
resources:
  foo:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
      tags:
        Name: tf-test
  fooSubnet:
    type: aws:ec2:Subnet
    name: foo
    properties:
      vpcId: ${foo.id}
      cidrBlock: 10.0.0.0/24
      availabilityZone: us-west-2a
      tags:
        Name: tf-test
  bar:
    type: aws:elasticache:SubnetGroup
    properties:
      name: tf-test-cache-subnet
      subnetIds:
        - ${fooSubnet.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,
                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:elasticache: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 examplesubnetGroupResourceResourceFromElasticachesubnetGroup = new Aws.ElastiCache.SubnetGroup("examplesubnetGroupResourceResourceFromElasticachesubnetGroup", new()
{
    SubnetIds = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := elasticache.NewSubnetGroup(ctx, "examplesubnetGroupResourceResourceFromElasticachesubnetGroup", &elasticache.SubnetGroupArgs{
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var examplesubnetGroupResourceResourceFromElasticachesubnetGroup = new SubnetGroup("examplesubnetGroupResourceResourceFromElasticachesubnetGroup", SubnetGroupArgs.builder()
    .subnetIds("string")
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
examplesubnet_group_resource_resource_from_elasticachesubnet_group = aws.elasticache.SubnetGroup("examplesubnetGroupResourceResourceFromElasticachesubnetGroup",
    subnet_ids=["string"],
    description="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const examplesubnetGroupResourceResourceFromElasticachesubnetGroup = new aws.elasticache.SubnetGroup("examplesubnetGroupResourceResourceFromElasticachesubnetGroup", {
    subnetIds: ["string"],
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:elasticache:SubnetGroup
properties:
    description: string
    name: 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>
List of VPC Subnet IDs for the cache subnet group
Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
Tags Dictionary<string, string>
Key-value map of resource tags. .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
List of VPC Subnet IDs for the cache subnet group
Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
Tags map[string]string
Key-value map of resource tags. .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>
List of VPC Subnet IDs for the cache subnet group
description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
tags Map<String,String>
Key-value map of resource tags. .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[]
List of VPC Subnet IDs for the cache subnet group
description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
tags {[key: string]: string}
Key-value map of resource tags. .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]
List of VPC Subnet IDs for the cache subnet group
description str
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
Name for the cache subnet group. ElastiCache converts this name to lowercase.
tags Mapping[str, str]
Key-value map of resource tags. .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>
List of VPC Subnet IDs for the cache subnet group
description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
tags Map<String>
Key-value map of resource tags. .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
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Arn string
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn String
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn string
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn str
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn String
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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

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,
        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:elasticache: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
Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
SubnetIds List<string>
List of VPC Subnet IDs for the cache subnet group
Tags Dictionary<string, string>
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Arn string
Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
SubnetIds []string
List of VPC Subnet IDs for the cache subnet group
Tags map[string]string
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn String
description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
subnetIds List<String>
List of VPC Subnet IDs for the cache subnet group
tags Map<String,String>
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn string
description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
subnetIds string[]
List of VPC Subnet IDs for the cache subnet group
tags {[key: string]: string}
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn str
description str
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
Name for the cache subnet group. ElastiCache converts this name to lowercase.
subnet_ids Sequence[str]
List of VPC Subnet IDs for the cache subnet group
tags Mapping[str, str]
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
arn String
description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
subnetIds List<String>
List of VPC Subnet IDs for the cache subnet group
tags Map<String>
Key-value map of resource tags. .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 Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

Import

Using pulumi import, import ElastiCache Subnet Groups using the name. For example:

$ pulumi import aws:elasticache/subnetGroup:SubnetGroup bar tf-test-cache-subnet
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