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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

aws-native.elasticache.getSubnetGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

    Resource Type definition for AWS::ElastiCache::SubnetGroup

    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(cache_subnet_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSubnetGroupResult
    def get_subnet_group_output(cache_subnet_group_name: Optional[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-native:elasticache:getSubnetGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    CacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    cacheSubnetGroupName String
    The name for the cache subnet group. This value is stored as a lowercase string.
    cacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    cache_subnet_group_name str
    The name for the cache subnet group. This value is stored as a lowercase string.
    cacheSubnetGroupName String
    The name for the cache subnet group. This value is stored as a lowercase string.

    getSubnetGroup Result

    The following output properties are available:

    Description string
    The description for the cache subnet group.
    SubnetIds List<string>
    The EC2 subnet IDs for the cache subnet group.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.
    Description string
    The description for the cache subnet group.
    SubnetIds []string
    The EC2 subnet IDs for the cache subnet group.
    Tags Tag
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.
    description String
    The description for the cache subnet group.
    subnetIds List<String>
    The EC2 subnet IDs for the cache subnet group.
    tags List<Tag>
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.
    description string
    The description for the cache subnet group.
    subnetIds string[]
    The EC2 subnet IDs for the cache subnet group.
    tags Tag[]
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.
    description str
    The description for the cache subnet group.
    subnet_ids Sequence[str]
    The EC2 subnet IDs for the cache subnet group.
    tags Sequence[root_Tag]
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.
    description String
    The description for the cache subnet group.
    subnetIds List<String>
    The EC2 subnet IDs for the cache subnet group.
    tags List<Property Map>
    A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi