Package software.amazon.awscdk.services.appsync

Class CfnApiCache

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appsync.CfnApiCache
All Implemented Interfaces:
IInspectable, IApiCacheRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:32.583Z") @Stability(Stable) public class CfnApiCache extends CfnResource implements IInspectable, IApiCacheRef
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)
         .healthMetricsConfig("healthMetricsConfig")
         .transitEncryptionEnabled(false)
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnApiCacheProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getApiCacheRef

      @Stability(Stable) @NotNull public ApiCacheReference getApiCacheRef()
      A reference to a ApiCache resource.
      Specified by:
      getApiCacheRef in interface IApiCacheRef

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getApiCachingBehavior

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

    • setApiCachingBehavior

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

    • 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.

    • setTtl

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

    • getType

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

      Valid values are.

    • setType

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

      Valid values are.

    • getAtRestEncryptionEnabled

      @Stability(Stable) @Nullable public Object getAtRestEncryptionEnabled()
      This parameter has been deprecated .

      Returns union: either Boolean or IResolvable

    • setAtRestEncryptionEnabled

      @Stability(Stable) public void setAtRestEncryptionEnabled(@Nullable Boolean value)
      This parameter has been deprecated .

    • setAtRestEncryptionEnabled

      @Stability(Stable) public void setAtRestEncryptionEnabled(@Nullable IResolvable value)
      This parameter has been deprecated .

    • getHealthMetricsConfig

      @Stability(Stable) @Nullable public String getHealthMetricsConfig()
      Controls how cache health metrics will be emitted to CloudWatch.

      Cache health metrics include:.

    • setHealthMetricsConfig

      @Stability(Stable) public void setHealthMetricsConfig(@Nullable String value)
      Controls how cache health metrics will be emitted to CloudWatch.

      Cache health metrics include:.

    • getTransitEncryptionEnabled

      @Stability(Stable) @Nullable public Object getTransitEncryptionEnabled()
      This parameter has been deprecated .

      Returns union: either Boolean or IResolvable

    • setTransitEncryptionEnabled

      @Stability(Stable) public void setTransitEncryptionEnabled(@Nullable Boolean value)
      This parameter has been deprecated .

    • setTransitEncryptionEnabled

      @Stability(Stable) public void setTransitEncryptionEnabled(@Nullable IResolvable value)
      This parameter has been deprecated .