Class: Aws::ElastiCache::Types::CreateServerlessCacheRequest

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::CreateServerlessCacheRequest

show all

Defined in:: gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cache_usage_limits ⇒ Types::CacheUsageLimits
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
#connection_type ⇒ String
The connection type for the serverless cache.
#daily_snapshot_time ⇒ String
The daily time that snapshots will be created from the new serverless cache.
#description ⇒ String
User-provided description for the serverless cache.
#engine ⇒ String
The name of the cache engine to be used for creating the serverless cache.
#kms_key_id ⇒ String
ARN of the customer managed key for encrypting the data at rest.
#major_engine_version ⇒ String
The version of the cache engine that will be used to create the serverless cache.
#network_type ⇒ String
The IP protocol version used by the serverless cache.
#security_group_ids ⇒ Array<String>
A list of the one or more VPC security groups to be associated with the serverless cache.
#serverless_cache_name ⇒ String
User-provided identifier for the serverless cache.
#snapshot_arns_to_restore ⇒ Array<String>
The ARN(s) of the snapshot that the new serverless cache will be created from.
#snapshot_retention_limit ⇒ Integer
The number of days for which ElastiCache retains automatic snapshots before deleting them.
#subnet_ids ⇒ Array<String>
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed.
#tags ⇒ Array<Types::Tag>
The list of tags (key, value) pairs to be added to the serverless cache resource.
#user_group_id ⇒ String
The identifier of the UserGroup to be associated with the serverless cache.

Instance Attribute Details

#cache_usage_limits ⇒ `Types::CacheUsageLimits`

Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.

Returns:

(Types::CacheUsageLimits)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ `String`

The connection type for the serverless cache. Must be either vpc | public. Use vpc to access the cache through a VPC endpoint, or public to access the cache over the internet. If not specified, defaults to vpc. This value cannot be changed after the serverless cache is created. Setting this to public requires Valkey 9 or above.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#daily_snapshot_time ⇒ `String`

The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic 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 2994

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The name of the cache engine to be used for creating the serverless cache.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#major_engine_version ⇒ `String`

The version of the cache engine that will be used to create the serverless cache.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ `String`

The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.

Returns:

(Array<String>)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_cache_name ⇒ `String`

User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

Returns:

(String)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arns_to_restore ⇒ `Array<String>`

The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

Returns:

(Array<String>)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ `Integer`

The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.

Returns:

(Integer)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.

Returns:

(Array<String>)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

Returns:

(Array<Types::Tag>)

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

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_id ⇒ `String`

The identifier of the UserGroup to be 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 2994

class CreateServerlessCacheRequest < Struct.new(
  :serverless_cache_name,
  :description,
  :engine,
  :major_engine_version,
  :cache_usage_limits,
  :kms_key_id,
  :security_group_ids,
  :snapshot_arns_to_restore,
  :tags,
  :user_group_id,
  :subnet_ids,
  :snapshot_retention_limit,
  :daily_snapshot_time,
  :network_type,
  :connection_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ElastiCache::Types::CreateServerlessCacheRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cache_usage_limits ⇒ Types::CacheUsageLimits

#connection_type ⇒ String

#daily_snapshot_time ⇒ String

#description ⇒ String

#engine ⇒ String

#kms_key_id ⇒ String

#major_engine_version ⇒ String

#network_type ⇒ String

#security_group_ids ⇒ Array<String>

#serverless_cache_name ⇒ String

#snapshot_arns_to_restore ⇒ Array<String>

#snapshot_retention_limit ⇒ Integer

#subnet_ids ⇒ Array<String>

#tags ⇒ Array<Types::Tag>

#user_group_id ⇒ String

#cache_usage_limits ⇒ `Types::CacheUsageLimits`

#connection_type ⇒ `String`

#daily_snapshot_time ⇒ `String`

#description ⇒ `String`

#engine ⇒ `String`

#kms_key_id ⇒ `String`

#major_engine_version ⇒ `String`

#network_type ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#serverless_cache_name ⇒ `String`

#snapshot_arns_to_restore ⇒ `Array<String>`

#snapshot_retention_limit ⇒ `Integer`

#subnet_ids ⇒ `Array<String>`

#tags ⇒ `Array<Types::Tag>`

#user_group_id ⇒ `String`