Package software.amazon.awscdk.services.appsync

Class CfnApiCache

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appsync.CfnApiCache
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.375Z") @Stability(Stable) public class CfnApiCache extends CfnResource implements IInspectable
A CloudFormation AWS::AppSync::ApiCache.

The AWS::AppSync::ApiCache resource represents the input of a CreateApiCache operation.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnApiCache cfnApiCache = CfnApiCache.Builder.create(this, "MyCfnApiCache")
         .apiCachingBehavior("apiCachingBehavior")
         .apiId("apiId")
         .ttl(123)
         .type("type")
         // the properties below are optional
         .atRestEncryptionEnabled(false)
         .transitEncryptionEnabled(false)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApiCache

      protected CfnApiCache(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApiCache

      protected CfnApiCache(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApiCache

      @Stability(Stable) public CfnApiCache(@NotNull Construct scope, @NotNull String id, @NotNull CfnApiCacheProps props)
      Create a new AWS::AppSync::ApiCache.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiCachingBehavior

      @Stability(Stable) @NotNull public String getApiCachingBehavior()
      Caching behavior.

      • FULL_REQUEST_CACHING : All requests are fully cached.
      • PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

    • setApiCachingBehavior

      @Stability(Stable) public void setApiCachingBehavior(@NotNull String value)
      Caching behavior.

      • FULL_REQUEST_CACHING : All requests are fully cached.
      • PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The GraphQL API ID.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The GraphQL API ID.

    • getTtl

      @Stability(Stable) @NotNull public Number getTtl()
      TTL in seconds for cache entries.

      Valid values are 1–3,600 seconds.

    • setTtl

      @Stability(Stable) public void setTtl(@NotNull Number value)
      TTL in seconds for cache entries.

      Valid values are 1–3,600 seconds.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The cache instance type. Valid values are.

      • SMALL
      • MEDIUM
      • LARGE
      • XLARGE
      • LARGE_2X
      • LARGE_4X
      • LARGE_8X (not available in all regions)
      • LARGE_12X

      Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

      The following legacy instance types are available, but their use is discouraged:

      • T2_SMALL : A t2.small instance type.
      • T2_MEDIUM : A t2.medium instance type.
      • R4_LARGE : A r4.large instance type.
      • R4_XLARGE : A r4.xlarge instance type.
      • R4_2XLARGE : A r4.2xlarge instance type.
      • R4_4XLARGE : A r4.4xlarge instance type.
      • R4_8XLARGE : A r4.8xlarge instance type.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The cache instance type. Valid values are.

      • SMALL
      • MEDIUM
      • LARGE
      • XLARGE
      • LARGE_2X
      • LARGE_4X
      • LARGE_8X (not available in all regions)
      • LARGE_12X

      Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

      The following legacy instance types are available, but their use is discouraged:

      • T2_SMALL : A t2.small instance type.
      • T2_MEDIUM : A t2.medium instance type.
      • R4_LARGE : A r4.large instance type.
      • R4_XLARGE : A r4.xlarge instance type.
      • R4_2XLARGE : A r4.2xlarge instance type.
      • R4_4XLARGE : A r4.4xlarge instance type.
      • R4_8XLARGE : A r4.8xlarge instance type.

    • getAtRestEncryptionEnabled

      @Stability(Stable) @Nullable public Object getAtRestEncryptionEnabled()
      At-rest encryption flag for cache.

      You cannot update this setting after creation.

    • setAtRestEncryptionEnabled

      @Stability(Stable) public void setAtRestEncryptionEnabled(@Nullable Boolean value)
      At-rest encryption flag for cache.

      You cannot update this setting after creation.

    • setAtRestEncryptionEnabled

      @Stability(Stable) public void setAtRestEncryptionEnabled(@Nullable IResolvable value)
      At-rest encryption flag for cache.

      You cannot update this setting after creation.

    • getTransitEncryptionEnabled

      @Stability(Stable) @Nullable public Object getTransitEncryptionEnabled()
      Transit encryption flag when connecting to cache.

      You cannot update this setting after creation.

    • setTransitEncryptionEnabled

      @Stability(Stable) public void setTransitEncryptionEnabled(@Nullable Boolean value)
      Transit encryption flag when connecting to cache.

      You cannot update this setting after creation.

    • setTransitEncryptionEnabled

      @Stability(Stable) public void setTransitEncryptionEnabled(@Nullable IResolvable value)
      Transit encryption flag when connecting to cache.

      You cannot update this setting after creation.