Package software.amazon.awscdk.services.elasticache

Class CfnServerlessCache

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.elasticache.CfnServerlessCache
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:43.205Z") @Stability(Stable) public class CfnServerlessCache extends CfnResource implements IInspectable, ITaggableV2
The resource representing a serverless cache.

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.elasticache.*;
 CfnServerlessCache cfnServerlessCache = CfnServerlessCache.Builder.create(this, "MyCfnServerlessCache")
         .engine("engine")
         .serverlessCacheName("serverlessCacheName")
         // the properties below are optional
         .cacheUsageLimits(CacheUsageLimitsProperty.builder()
                 .dataStorage(DataStorageProperty.builder()
                         .unit("unit")
                         // the properties below are optional
                         .maximum(123)
                         .minimum(123)
                         .build())
                 .ecpuPerSecond(ECPUPerSecondProperty.builder()
                         .maximum(123)
                         .minimum(123)
                         .build())
                 .build())
         .dailySnapshotTime("dailySnapshotTime")
         .description("description")
         .endpoint(EndpointProperty.builder()
                 .address("address")
                 .port("port")
                 .build())
         .finalSnapshotName("finalSnapshotName")
         .kmsKeyId("kmsKeyId")
         .majorEngineVersion("majorEngineVersion")
         .readerEndpoint(EndpointProperty.builder()
                 .address("address")
                 .port("port")
                 .build())
         .securityGroupIds(List.of("securityGroupIds"))
         .snapshotArnsToRestore(List.of("snapshotArnsToRestore"))
         .snapshotRetentionLimit(123)
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userGroupId("userGroupId")
         .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

    • CfnServerlessCache

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

    • CfnServerlessCache

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

    • CfnServerlessCache

      @Stability(Stable) public CfnServerlessCache(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnServerlessCacheProps 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the serverless cache.

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      When the serverless cache was created.

    • getAttrEndpointAddress

      @Stability(Stable) @NotNull public String getAttrEndpointAddress()
      The DNS hostname of the cache node.

    • getAttrEndpointPort

      @Stability(Stable) @NotNull public String getAttrEndpointPort()
      The port number that the cache engine is listening on.

    • getAttrFullEngineVersion

      @Stability(Stable) @NotNull public String getAttrFullEngineVersion()
      The name and version number of the engine the serverless cache is compatible with.

    • getAttrReaderEndpointAddress

      @Stability(Stable) @NotNull public String getAttrReaderEndpointAddress()
      The DNS hostname of the cache node.

    • getAttrReaderEndpointPort

      @Stability(Stable) @NotNull public String getAttrReaderEndpointPort()
      The port number that the cache engine is listening on.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the serverless cache.

      The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The engine the serverless cache is compatible with.

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The engine the serverless cache is compatible with.

    • getServerlessCacheName

      @Stability(Stable) @NotNull public String getServerlessCacheName()
      The unique identifier of the serverless cache.

    • setServerlessCacheName

      @Stability(Stable) public void setServerlessCacheName(@NotNull String value)
      The unique identifier of the serverless cache.

    • getCacheUsageLimits

      @Stability(Stable) @Nullable public Object getCacheUsageLimits()
      The cache usage limit for the serverless cache.

    • setCacheUsageLimits

      @Stability(Stable) public void setCacheUsageLimits(@Nullable IResolvable value)
      The cache usage limit for the serverless cache.

    • setCacheUsageLimits

      @Stability(Stable) public void setCacheUsageLimits(@Nullable CfnServerlessCache.CacheUsageLimitsProperty value)
      The cache usage limit for the serverless cache.

    • getDailySnapshotTime

      @Stability(Stable) @Nullable public String getDailySnapshotTime()
      The daily time that a cache snapshot will be created.

    • setDailySnapshotTime

      @Stability(Stable) public void setDailySnapshotTime(@Nullable String value)
      The daily time that a cache snapshot will be created.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the serverless cache.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the serverless cache.

    • getEndpoint

      @Stability(Stable) @Nullable public Object getEndpoint()
      Represents the information required for client programs to connect to a cache node.

    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable IResolvable value)
      Represents the information required for client programs to connect to a cache node.

    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable CfnServerlessCache.EndpointProperty value)
      Represents the information required for client programs to connect to a cache node.

    • getFinalSnapshotName

      @Stability(Stable) @Nullable public String getFinalSnapshotName()
      The name of the final snapshot taken of a cache before the cache is deleted.

    • setFinalSnapshotName

      @Stability(Stable) public void setFinalSnapshotName(@Nullable String value)
      The name of the final snapshot taken of a cache before the cache is deleted.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

    • getMajorEngineVersion

      @Stability(Stable) @Nullable public String getMajorEngineVersion()
      The version number of the engine the serverless cache is compatible with.

    • setMajorEngineVersion

      @Stability(Stable) public void setMajorEngineVersion(@Nullable String value)
      The version number of the engine the serverless cache is compatible with.

    • getReaderEndpoint

      @Stability(Stable) @Nullable public Object getReaderEndpoint()
      Represents the information required for client programs to connect to a cache node.

    • setReaderEndpoint

      @Stability(Stable) public void setReaderEndpoint(@Nullable IResolvable value)
      Represents the information required for client programs to connect to a cache node.

    • setReaderEndpoint

      @Stability(Stable) public void setReaderEndpoint(@Nullable CfnServerlessCache.EndpointProperty value)
      Represents the information required for client programs to connect to a cache node.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The IDs of the EC2 security groups associated with the serverless cache.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The IDs of the EC2 security groups associated with the serverless cache.

    • getSnapshotArnsToRestore

      @Stability(Stable) @Nullable public List<String> getSnapshotArnsToRestore()
      The ARN of the snapshot from which to restore data into the new cache.

    • setSnapshotArnsToRestore

      @Stability(Stable) public void setSnapshotArnsToRestore(@Nullable List<String> value)
      The ARN of the snapshot from which to restore data into the new cache.

    • getSnapshotRetentionLimit

      @Stability(Stable) @Nullable public Number getSnapshotRetentionLimit()
      The current setting for the number of serverless cache snapshots the system will retain.

    • setSnapshotRetentionLimit

      @Stability(Stable) public void setSnapshotRetentionLimit(@Nullable Number value)
      The current setting for the number of serverless cache snapshots the system will retain.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to be added to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to be added to this resource.

    • getUserGroupId

      @Stability(Stable) @Nullable public String getUserGroupId()
      The identifier of the user group associated with the serverless cache.

    • setUserGroupId

      @Stability(Stable) public void setUserGroupId(@Nullable String value)
      The identifier of the user group associated with the serverless cache.