Class: Aws::ElastiCache::Types::ServerlessCache

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::ServerlessCache

Defined in:

gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

The resource representing a serverless cache.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #cache_usage_limits ⇒ Types::CacheUsageLimits

  The cache usage limit for the serverless cache.

• #create_time ⇒ Time

  When the serverless cache was created.

• #daily_snapshot_time ⇒ String

  The daily time that a cache snapshot will be created.

• #description ⇒ String

  A description of the serverless cache.

• #endpoint ⇒ Types::Endpoint

  Represents the information required for client programs to connect to a cache node.

• #engine ⇒ String

  The engine the serverless cache is compatible with.

• #full_engine_version ⇒ String

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

• #kms_key_id ⇒ String

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

• #major_engine_version ⇒ String

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

• #reader_endpoint ⇒ Types::Endpoint

  Represents the information required for client programs to connect to a cache node.

• #security_group_ids ⇒ Array<String>

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

• #serverless_cache_name ⇒ String

  The unique identifier of the serverless cache.

• #snapshot_retention_limit ⇒ Integer

  The current setting for the number of serverless cache snapshots the system will retain.

• #status ⇒ String

  The current status of the serverless cache.

• #subnet_ids ⇒ Array<String>

  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.

• #user_group_id ⇒ String

  The identifier of the user group associated with the serverless cache.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#cache_usage_limits ⇒ Types::CacheUsageLimits

The cache usage limit for the serverless cache.

Returns:

• (Types::CacheUsageLimits)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

When the serverless cache was created.

Returns:

• (Time)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#daily_snapshot_time ⇒ String

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 Valkey, Redis OSS and Serverless Memcached only.

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the serverless cache.

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ Types::Endpoint

Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

• (Types::Endpoint)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The engine the serverless cache is compatible with.

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#full_engine_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#major_engine_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpoint ⇒ Types::Endpoint

Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

• (Types::Endpoint)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_cache_name ⇒ String

The unique identifier of the serverless cache.

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 8612

class ServerlessCache < Struct.new(
  :serverless_cache_name,
  :description,
  :create_time,
  :status,
  :engine,
  :major_engine_version,
  :full_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :endpoint,
  :reader_endpoint,
  :arn,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time)
  SENSITIVE = []
  include Aws::Structure
end