Class ServerlessCache

    • Method Detail

      • serverlessCacheName

        public final String serverlessCacheName()

        The unique identifier of the serverless cache.

        Returns:
        The unique identifier of the serverless cache.
      • description

        public final String description()

        A description of the serverless cache.

        Returns:
        A description of the serverless cache.
      • createTime

        public final Instant createTime()

        When the serverless cache was created.

        Returns:
        When the serverless cache was created.
      • status

        public final String status()

        The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

        Returns:
        The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
      • engine

        public final String engine()

        The engine the serverless cache is compatible with.

        Returns:
        The engine the serverless cache is compatible with.
      • majorEngineVersion

        public final String majorEngineVersion()

        The version number of the engine the serverless cache is compatible with.

        Returns:
        The version number of the engine the serverless cache is compatible with.
      • fullEngineVersion

        public final String fullEngineVersion()

        The name and version number of the engine the serverless cache is compatible with.

        Returns:
        The name and version number of the engine the serverless cache is compatible with.
      • cacheUsageLimits

        public final CacheUsageLimits cacheUsageLimits()

        The cache usage limit for the serverless cache.

        Returns:
        The cache usage limit for the serverless cache.
      • kmsKeyId

        public final String kmsKeyId()

        The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

        Returns:
        The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
      • hasSecurityGroupIds

        public final boolean hasSecurityGroupIds()
        For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • securityGroupIds

        public final List<String> securityGroupIds()

        The IDs of the EC2 security groups associated with the serverless cache.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

        Returns:
        The IDs of the EC2 security groups associated with the serverless cache.
      • endpoint

        public final Endpoint endpoint()
        Returns the value of the Endpoint property for this object.
        Returns:
        The value of the Endpoint property for this object.
      • readerEndpoint

        public final Endpoint readerEndpoint()
        Returns the value of the ReaderEndpoint property for this object.
        Returns:
        The value of the ReaderEndpoint property for this object.
      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the serverless cache.

        Returns:
        The Amazon Resource Name (ARN) of the serverless cache.
      • userGroupId

        public final String userGroupId()

        The identifier of the user group associated with the serverless cache. Available for Redis OSS only. Default is NULL.

        Returns:
        The identifier of the user group associated with the serverless cache. Available for Redis OSS only. Default is NULL.
      • hasSubnetIds

        public final boolean hasSubnetIds()
        For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • subnetIds

        public final List<String> subnetIds()

        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. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

        Returns:
        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. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
      • snapshotRetentionLimit

        public final Integer snapshotRetentionLimit()

        The current setting for the number of serverless cache snapshots the system will retain. Available for Redis OSS and Serverless Memcached only.

        Returns:
        The current setting for the number of serverless cache snapshots the system will retain. Available for Redis OSS and Serverless Memcached only.
      • dailySnapshotTime

        public final String dailySnapshotTime()

        The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis OSS and Serverless Memcached only.

        Returns:
        The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis OSS and Serverless Memcached only.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)