1. Packages
  2. AWS Classic
  3. API Docs
  4. elasticache
  5. getSubnetGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.elasticache.getSubnetGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides information about a ElastiCache Subnet Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.elasticache.getSubnetGroup({
        name: "my-subnet-group",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.elasticache.get_subnet_group(name="my-subnet-group")
    
    package main
    
    import (
    	"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 {
    		_, err := elasticache.LookupSubnetGroup(ctx, &elasticache.LookupSubnetGroupArgs{
    			Name: "my-subnet-group",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.ElastiCache.GetSubnetGroup.Invoke(new()
        {
            Name = "my-subnet-group",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.elasticache.ElasticacheFunctions;
    import com.pulumi.aws.elasticache.inputs.GetSubnetGroupArgs;
    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) {
            final var example = ElasticacheFunctions.getSubnetGroup(GetSubnetGroupArgs.builder()
                .name("my-subnet-group")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:elasticache:getSubnetGroup
          Arguments:
            name: my-subnet-group
    

    Using getSubnetGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSubnetGroup(args: GetSubnetGroupArgs, opts?: InvokeOptions): Promise<GetSubnetGroupResult>
    function getSubnetGroupOutput(args: GetSubnetGroupOutputArgs, opts?: InvokeOptions): Output<GetSubnetGroupResult>
    def get_subnet_group(name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSubnetGroupResult
    def get_subnet_group_output(name: Optional[pulumi.Input[str]] = None,
                         tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSubnetGroupResult]
    func LookupSubnetGroup(ctx *Context, args *LookupSubnetGroupArgs, opts ...InvokeOption) (*LookupSubnetGroupResult, error)
    func LookupSubnetGroupOutput(ctx *Context, args *LookupSubnetGroupOutputArgs, opts ...InvokeOption) LookupSubnetGroupResultOutput

    > Note: This function is named LookupSubnetGroup in the Go SDK.

    public static class GetSubnetGroup 
    {
        public static Task<GetSubnetGroupResult> InvokeAsync(GetSubnetGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetSubnetGroupResult> Invoke(GetSubnetGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSubnetGroupResult> getSubnetGroup(GetSubnetGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:elasticache/getSubnetGroup:getSubnetGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the subnet group.
    Tags Dictionary<string, string>
    Map of tags assigned to the subnet group.
    Name string
    Name of the subnet group.
    Tags map[string]string
    Map of tags assigned to the subnet group.
    name String
    Name of the subnet group.
    tags Map<String,String>
    Map of tags assigned to the subnet group.
    name string
    Name of the subnet group.
    tags {[key: string]: string}
    Map of tags assigned to the subnet group.
    name str
    Name of the subnet group.
    tags Mapping[str, str]
    Map of tags assigned to the subnet group.
    name String
    Name of the subnet group.
    tags Map<String>
    Map of tags assigned to the subnet group.

    getSubnetGroup Result

    The following output properties are available:

    Arn string
    ARN of the subnet group.
    Description string
    Description of the subnet group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    SubnetIds List<string>
    Set of VPC Subnet ID-s of the subnet group.
    VpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    Tags Dictionary<string, string>
    Map of tags assigned to the subnet group.
    Arn string
    ARN of the subnet group.
    Description string
    Description of the subnet group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    SubnetIds []string
    Set of VPC Subnet ID-s of the subnet group.
    VpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    Tags map[string]string
    Map of tags assigned to the subnet group.
    arn String
    ARN of the subnet group.
    description String
    Description of the subnet group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    subnetIds List<String>
    Set of VPC Subnet ID-s of the subnet group.
    vpcId String
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    tags Map<String,String>
    Map of tags assigned to the subnet group.
    arn string
    ARN of the subnet group.
    description string
    Description of the subnet group.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    subnetIds string[]
    Set of VPC Subnet ID-s of the subnet group.
    vpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    tags {[key: string]: string}
    Map of tags assigned to the subnet group.
    arn str
    ARN of the subnet group.
    description str
    Description of the subnet group.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    subnet_ids Sequence[str]
    Set of VPC Subnet ID-s of the subnet group.
    vpc_id str
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    tags Mapping[str, str]
    Map of tags assigned to the subnet group.
    arn String
    ARN of the subnet group.
    description String
    Description of the subnet group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    subnetIds List<String>
    Set of VPC Subnet ID-s of the subnet group.
    vpcId String
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    tags Map<String>
    Map of tags assigned to the subnet group.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi