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.



2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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)
  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 Redis only.

Returns:

  • (String)


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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

#engineString

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

Returns:

  • (String)


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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)
  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 Redis only.

Returns:

  • (Array<String>)


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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

#snapshot_retention_limitInteger

The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.

Returns:

  • (Integer)


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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)
  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:



2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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

#user_group_idString

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

Returns:

  • (String)


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2957

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