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

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

AWS Cloud Control v1.14.0 published on Monday, Dec 9, 2024 by Pulumi

aws-native.elasticache.SubnetGroup

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.14.0 published on Monday, Dec 9, 2024 by Pulumi

    Resource Type definition for AWS::ElastiCache::SubnetGroup

    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,
                    description: Optional[str] = None,
                    subnet_ids: Optional[Sequence[str]] = None,
                    cache_subnet_group_name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:elasticache:SubnetGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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

    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:

    Description string
    The description for the cache subnet group.
    SubnetIds List<string>
    The EC2 subnet IDs for the cache subnet group.
    CacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    Tags List<Pulumi.AwsNative.Inputs.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.
    CacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    Tags TagArgs
    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.
    cacheSubnetGroupName String
    The name for the cache subnet group. This value is stored as a lowercase string.
    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.
    cacheSubnetGroupName string
    The name for the cache subnet group. This value is stored as a lowercase string.
    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.
    cache_subnet_group_name str
    The name for the cache subnet group. This value is stored as a lowercase string.
    tags Sequence[TagArgs]
    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.
    cacheSubnetGroupName String
    The name for the cache subnet group. This value is stored as a lowercase string.
    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.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    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.14.0 published on Monday, Dec 9, 2024 by Pulumi