aws.elasticache.SubnetGroup
Provides an ElastiCache Subnet Group resource.
NOTE: ElastiCache Subnet Groups are only for use when working with an ElastiCache cluster inside of a VPC. If you are on EC2 Classic, see the ElastiCache Security Group resource.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var fooVpc = new Aws.Ec2.Vpc("fooVpc", new()
{
CidrBlock = "10.0.0.0/16",
Tags =
{
{ "Name", "tf-test" },
},
});
var fooSubnet = new Aws.Ec2.Subnet("fooSubnet", new()
{
VpcId = fooVpc.Id,
CidrBlock = "10.0.0.0/24",
AvailabilityZone = "us-west-2a",
Tags =
{
{ "Name", "tf-test" },
},
});
var bar = new Aws.ElastiCache.SubnetGroup("bar", new()
{
SubnetIds = new[]
{
fooSubnet.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticache"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooVpc, err := ec2.NewVpc(ctx, "fooVpc", &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, "fooSubnet", &ec2.SubnetArgs{
VpcId: fooVpc.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{
SubnetIds: pulumi.StringArray{
fooSubnet.ID(),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.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 fooVpc = new Vpc("fooVpc", VpcArgs.builder()
.cidrBlock("10.0.0.0/16")
.tags(Map.of("Name", "tf-test"))
.build());
var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()
.vpcId(fooVpc.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()
.subnetIds(fooSubnet.id())
.build());
}
}
import pulumi
import pulumi_aws as aws
foo_vpc = aws.ec2.Vpc("fooVpc",
cidr_block="10.0.0.0/16",
tags={
"Name": "tf-test",
})
foo_subnet = aws.ec2.Subnet("fooSubnet",
vpc_id=foo_vpc.id,
cidr_block="10.0.0.0/24",
availability_zone="us-west-2a",
tags={
"Name": "tf-test",
})
bar = aws.elasticache.SubnetGroup("bar", subnet_ids=[foo_subnet.id])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const fooVpc = new aws.ec2.Vpc("fooVpc", {
cidrBlock: "10.0.0.0/16",
tags: {
Name: "tf-test",
},
});
const fooSubnet = new aws.ec2.Subnet("fooSubnet", {
vpcId: fooVpc.id,
cidrBlock: "10.0.0.0/24",
availabilityZone: "us-west-2a",
tags: {
Name: "tf-test",
},
});
const bar = new aws.elasticache.SubnetGroup("bar", {subnetIds: [fooSubnet.id]});
resources:
fooVpc:
type: aws:ec2:Vpc
properties:
cidrBlock: 10.0.0.0/16
tags:
Name: tf-test
fooSubnet:
type: aws:ec2:Subnet
properties:
vpcId: ${fooVpc.id}
cidrBlock: 10.0.0.0/24
availabilityZone: us-west-2a
tags:
Name: tf-test
bar:
type: aws:elasticache:SubnetGroup
properties:
subnetIds:
- ${fooSubnet.id}
Create SubnetGroup Resource
new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: CustomResourceOptions);
@overload
def SubnetGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def SubnetGroup(resource_name: str,
args: SubnetGroupArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args SubnetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args SubnetGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubnetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubnetGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The SubnetGroup resource accepts the following input properties:
- Subnet
Ids 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 string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- 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.
- Subnet
Ids []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 string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- 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.
- subnet
Ids 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 String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- 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.
- subnet
Ids 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 string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- {[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 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 str
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- 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.
- subnet
Ids 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 String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- 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:
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) -> 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Arn string
- Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- Name string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- Subnet
Ids List<string> List of VPC Subnet IDs for the cache subnet group
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- Name string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- Subnet
Ids []string List of VPC Subnet IDs for the cache subnet group
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- name String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- subnet
Ids List<String> List of VPC Subnet IDs for the cache subnet group
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- description string
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- name string
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- subnet
Ids string[] List of VPC Subnet IDs for the cache subnet group
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- description str
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- name 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
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- description String
Description for the cache subnet group. Defaults to "Managed by Pulumi".
- name String
Name for the cache subnet group. ElastiCache converts this name to lowercase.
- subnet
Ids List<String> List of VPC Subnet IDs for the cache subnet group
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
ElastiCache Subnet Groups can be imported using the name
, e.g.,
$ pulumi import aws:elasticache/subnetGroup:SubnetGroup bar tf-test-cache-subnet
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.