Class: Aws::MemoryDB::Types::CreateClusterRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MemoryDB::Types::CreateClusterRequest
- Defined in:
- gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#acl_name ⇒ String
The name of the Access Control List to associate with the cluster.
-
#auto_minor_version_upgrade ⇒ Boolean
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
-
#cluster_name ⇒ String
The name of the cluster.
-
#data_tiering ⇒ Boolean
Enables data tiering.
-
#description ⇒ String
An optional description of the cluster.
-
#engine_version ⇒ String
The version number of the Redis OSS engine to be used for the cluster.
-
#kms_key_id ⇒ String
The ID of the KMS key used to encrypt the cluster.
-
#maintenance_window ⇒ String
Specifies the weekly time range during which maintenance on the cluster is performed.
-
#node_type ⇒ String
The compute and memory capacity of the nodes in the cluster.
-
#num_replicas_per_shard ⇒ Integer
The number of replicas to apply to each shard.
-
#num_shards ⇒ Integer
The number of shards the cluster will contain.
-
#parameter_group_name ⇒ String
The name of the parameter group associated with the cluster.
-
#port ⇒ Integer
The port number on which each of the nodes accepts connections.
-
#security_group_ids ⇒ Array<String>
A list of security group names to associate with this cluster.
-
#snapshot_arns ⇒ Array<String>
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
-
#snapshot_name ⇒ String
The name of a snapshot from which to restore data into the new cluster.
-
#snapshot_retention_limit ⇒ Integer
The number of days for which MemoryDB retains automatic snapshots before deleting them.
-
#snapshot_window ⇒ String
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
-
#sns_topic_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
-
#subnet_group_name ⇒ String
The name of the subnet group to be used for the cluster.
-
#tags ⇒ Array<Types::Tag>
A list of tags to be added to this resource.
-
#tls_enabled ⇒ Boolean
A flag to enable in-transit encryption on the cluster.
Instance Attribute Details
#acl_name ⇒ String
The name of the Access Control List to associate with the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#auto_minor_version_upgrade ⇒ Boolean
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#cluster_name ⇒ String
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#data_tiering ⇒ Boolean
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
An optional description of the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#engine_version ⇒ String
The version number of the Redis OSS engine to be used for the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The ID of the KMS key used to encrypt the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#maintenance_window ⇒ String
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#node_type ⇒ String
The compute and memory capacity of the nodes in the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#num_replicas_per_shard ⇒ Integer
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#num_shards ⇒ Integer
The number of shards the cluster will contain. The default value is 1.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#parameter_group_name ⇒ String
The name of the parameter group associated with the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#port ⇒ Integer
The port number on which each of the nodes accepts connections.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#security_group_ids ⇒ Array<String>
A list of security group names to associate with this cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#snapshot_arns ⇒ Array<String>
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#snapshot_name ⇒ String
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#snapshot_retention_limit ⇒ Integer
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#snapshot_window ⇒ String
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#sns_topic_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#subnet_group_name ⇒ String
The name of the subnet group to be used for the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |
#tls_enabled ⇒ Boolean
A flag to enable in-transit encryption on the cluster.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 709 class CreateClusterRequest < Struct.new( :cluster_name, :node_type, :parameter_group_name, :description, :num_shards, :num_replicas_per_shard, :subnet_group_name, :security_group_ids, :maintenance_window, :port, :sns_topic_arn, :tls_enabled, :kms_key_id, :snapshot_arns, :snapshot_name, :snapshot_retention_limit, :tags, :snapshot_window, :acl_name, :engine_version, :auto_minor_version_upgrade, :data_tiering) SENSITIVE = [] include Aws::Structure end |