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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_usage_limitsTypes::CacheUsageLimits

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



2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#daily_snapshot_timeString

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)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#major_engine_versionString

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

Returns:

  • (String)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

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)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<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>)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_cache_nameString

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

Returns:

  • (String)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arns_to_restoreArray<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>)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limitInteger

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)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<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>)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_idString

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

Returns:

  • (String)


2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2968

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)
  SENSITIVE = []
  include Aws::Structure
end