Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. dax
  5. SubnetGroup
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.dax.SubnetGroup

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Provides a DAX Subnet Group resource.

Example Usage

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

const example = new aws.dax.SubnetGroup("example", {
    name: "example",
    subnetIds: [
        example1.id,
        example2.id,
    ],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.dax.SubnetGroup("example",
    name="example",
    subnet_ids=[
        example1["id"],
        example2["id"],
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dax.NewSubnetGroup(ctx, "example", &dax.SubnetGroupArgs{
			Name: pulumi.String("example"),
			SubnetIds: pulumi.StringArray{
				example1.Id,
				example2.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.Dax.SubnetGroup("example", new()
    {
        Name = "example",
        SubnetIds = new[]
        {
            example1.Id,
            example2.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dax.SubnetGroup;
import com.pulumi.aws.dax.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 SubnetGroup("example", SubnetGroupArgs.builder()
            .name("example")
            .subnetIds(            
                example1.id(),
                example2.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:dax:SubnetGroup
    properties:
      name: example
      subnetIds:
        - ${example1.id}
        - ${example2.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)
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:dax: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 subnetGroupResource = new Aws.Dax.SubnetGroup("subnetGroupResource", new()
{
    SubnetIds = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
});
Copy
example, err := dax.NewSubnetGroup(ctx, "subnetGroupResource", &dax.SubnetGroupArgs{
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var subnetGroupResource = new com.pulumi.aws.dax.SubnetGroup("subnetGroupResource", com.pulumi.aws.dax.SubnetGroupArgs.builder()
    .subnetIds("string")
    .description("string")
    .name("string")
    .build());
Copy
subnet_group_resource = aws.dax.SubnetGroup("subnetGroupResource",
    subnet_ids=["string"],
    description="string",
    name="string")
Copy
const subnetGroupResource = new aws.dax.SubnetGroup("subnetGroupResource", {
    subnetIds: ["string"],
    description: "string",
    name: "string",
});
Copy
type: aws:dax:SubnetGroup
properties:
    description: string
    name: string
    subnetIds:
        - 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>
A list of VPC subnet IDs for the subnet group.
Description string
A description of the subnet group.
Name Changes to this property will trigger replacement. string
The name of the subnet group.
SubnetIds This property is required. []string
A list of VPC subnet IDs for the subnet group.
Description string
A description of the subnet group.
Name Changes to this property will trigger replacement. string
The name of the subnet group.
subnetIds This property is required. List<String>
A list of VPC subnet IDs for the subnet group.
description String
A description of the subnet group.
name Changes to this property will trigger replacement. String
The name of the subnet group.
subnetIds This property is required. string[]
A list of VPC subnet IDs for the subnet group.
description string
A description of the subnet group.
name Changes to this property will trigger replacement. string
The name of the subnet group.
subnet_ids This property is required. Sequence[str]
A list of VPC subnet IDs for the subnet group.
description str
A description of the subnet group.
name Changes to this property will trigger replacement. str
The name of the subnet group.
subnetIds This property is required. List<String>
A list of VPC subnet IDs for the subnet group.
description String
A description of the subnet group.
name Changes to this property will trigger replacement. String
The name of the subnet group.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
VpcId string
VPC ID of the subnet group.
Id string
The provider-assigned unique ID for this managed resource.
VpcId string
VPC ID of the subnet group.
id String
The provider-assigned unique ID for this managed resource.
vpcId String
VPC ID of the subnet group.
id string
The provider-assigned unique ID for this managed resource.
vpcId string
VPC ID of the subnet group.
id str
The provider-assigned unique ID for this managed resource.
vpc_id str
VPC ID of the subnet group.
id String
The provider-assigned unique ID for this managed resource.
vpcId String
VPC ID of the 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,
        description: Optional[str] = None,
        name: Optional[str] = None,
        subnet_ids: Optional[Sequence[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:dax: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:
Description string
A description of the subnet group.
Name Changes to this property will trigger replacement. string
The name of the subnet group.
SubnetIds List<string>
A list of VPC subnet IDs for the subnet group.
VpcId string
VPC ID of the subnet group.
Description string
A description of the subnet group.
Name Changes to this property will trigger replacement. string
The name of the subnet group.
SubnetIds []string
A list of VPC subnet IDs for the subnet group.
VpcId string
VPC ID of the subnet group.
description String
A description of the subnet group.
name Changes to this property will trigger replacement. String
The name of the subnet group.
subnetIds List<String>
A list of VPC subnet IDs for the subnet group.
vpcId String
VPC ID of the subnet group.
description string
A description of the subnet group.
name Changes to this property will trigger replacement. string
The name of the subnet group.
subnetIds string[]
A list of VPC subnet IDs for the subnet group.
vpcId string
VPC ID of the subnet group.
description str
A description of the subnet group.
name Changes to this property will trigger replacement. str
The name of the subnet group.
subnet_ids Sequence[str]
A list of VPC subnet IDs for the subnet group.
vpc_id str
VPC ID of the subnet group.
description String
A description of the subnet group.
name Changes to this property will trigger replacement. String
The name of the subnet group.
subnetIds List<String>
A list of VPC subnet IDs for the subnet group.
vpcId String
VPC ID of the subnet group.

Import

Using pulumi import, import DAX Subnet Group using the name. For example:

$ pulumi import aws:dax/subnetGroup:SubnetGroup example my_dax_sg
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.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws