SubnetGroup class
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],
});
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])
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,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/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().ToIDOutput().ToStringOutput(),
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().ToIDOutput().ToStringOutput(),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_vpc" "foo" {
cidr_block = "10.0.0.0/16"
tags = {
"Name" = "tf-test"
}
}
resource "aws_ec2_subnet" "foo" {
vpc_id = aws_ec2_vpc.foo.id
cidr_block = "10.0.0.0/24"
availability_zone = "us-west-2a"
tags = {
"Name" = "tf-test"
}
}
resource "aws_elasticache_subnetgroup" "bar" {
name = "tf-test-cache-subnet"
subnet_ids = [aws_ec2_subnet.foo.id]
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
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}
Import
Using pulumi import, import ElastiCache Subnet Groups using the name. For example:
$ pulumi import aws:elasticache/subnetGroup:SubnetGroup bar tf-test-cache-subnet
Constructors
- SubnetGroup(String name, {SubnetGroupArgs? args, CustomResourceOptions? options})
-
Creates a new SubnetGroup.
nameThe Pulumi resource name.argsArguments used to configure this SubnetGroup. The set of arguments for SubnetGroup.optionsResource options controlling this resource's behavior. - SubnetGroup.reference(String urn)
- Creates a typed reference to an existing SubnetGroup resource.
Properties
-
arn
↔ Output<
String> -
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
Description for the cache subnet group. Defaults to "Managed by Pulumi".
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name for the cache subnet group. ElastiCache converts this name to lowercase.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subnetIds
↔ Output<
List< String> > -
List of VPC Subnet IDs for the cache subnet group
latefinal
-
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String> -
VPC identifier (VPC ID) of the cache subnet group.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SubnetGroupState? state, CustomResourceOptions? options}) → SubnetGroup -
Gets an existing SubnetGroup resource's state with the given
nameandid.