Class ApiCache


  • public class ApiCache
    extends com.pulumi.resources.CustomResource
    Provides an AppSync API Cache. ## Example Usage <!--Start PulumiCodeChooser -->
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.appsync.GraphQLApi;
     import com.pulumi.aws.appsync.GraphQLApiArgs;
     import com.pulumi.aws.appsync.ApiCache;
     import com.pulumi.aws.appsync.ApiCacheArgs;
     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 GraphQLApi("example", GraphQLApiArgs.builder()        
                 .authenticationType("API_KEY")
                 .name("example")
                 .build());
     
             var exampleApiCache = new ApiCache("exampleApiCache", ApiCacheArgs.builder()        
                 .apiId(example.id())
                 .apiCachingBehavior("FULL_REQUEST_CACHING")
                 .type("LARGE")
                 .ttl(900)
                 .build());
     
         }
     }
     
     
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_appsync_api_cache` using the AppSync API ID. For example: ```sh $ pulumi import aws:appsync/apiCache:ApiCache example xxxxx ```
    • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      ApiCache​(java.lang.String name)  
      ApiCache​(java.lang.String name, ApiCacheArgs args)  
      ApiCache​(java.lang.String name, ApiCacheArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> apiCachingBehavior()  
      com.pulumi.core.Output<java.lang.String> apiId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> atRestEncryptionEnabled()  
      static ApiCache get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ApiCacheState 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.util.Optional<java.lang.Boolean>> transitEncryptionEnabled()  
      com.pulumi.core.Output<java.lang.Integer> ttl()  
      com.pulumi.core.Output<java.lang.String> type()  
      • 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

      • ApiCache

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

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

        public ApiCache​(java.lang.String name,
                        ApiCacheArgs 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

      • apiCachingBehavior

        public com.pulumi.core.Output<java.lang.String> apiCachingBehavior()
        Returns:
        Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`.
      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        GraphQL API ID.
      • atRestEncryptionEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> atRestEncryptionEnabled()
        Returns:
        At-rest encryption flag for cache. You cannot update this setting after creation.
      • transitEncryptionEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> transitEncryptionEnabled()
        Returns:
        Transit encryption flag when connecting to cache. You cannot update this setting after creation.
      • ttl

        public com.pulumi.core.Output<java.lang.Integer> ttl()
        Returns:
        TTL in seconds for cache entries.
      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`.
      • get

        public static ApiCache get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   ApiCacheState 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.