Package com.pulumi.aws.elasticache

Class SubnetGroup

  • public class SubnetGroup
extends com.pulumi.resources.CustomResource
    Provides an ElastiCache Subnet Group resource. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import ElastiCache Subnet Groups using the `name`. For example: ```sh $ pulumi import aws:elasticache/subnetGroup:SubnetGroup bar tf-test-cache-subnet ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> description()  
      static SubnetGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SubnetGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> vpcId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SubnetGroup

        public SubnetGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • SubnetGroup

        public SubnetGroup​(java.lang.String name,
                   SubnetGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • SubnetGroup

        public SubnetGroup​(java.lang.String name,
                   SubnetGroupArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description for the cache subnet group. Defaults to "Managed by Pulumi".

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the cache subnet group. ElastiCache converts this name to lowercase.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • subnetIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()
        Returns:
        List of VPC Subnet IDs for the cache subnet group

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        VPC identifier (VPC ID) of the cache subnet group.

      • get

        public static SubnetGroup get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              SubnetGroupState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.