Class: Aws::MemoryDB::Types::CreateClusterRequest

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

Overview

Note:

When making an API call, you may pass CreateClusterRequest data as a hash:

{
  cluster_name: "String", # required
  node_type: "String", # required
  parameter_group_name: "String",
  description: "String",
  num_shards: 1,
  num_replicas_per_shard: 1,
  subnet_group_name: "String",
  security_group_ids: ["String"],
  maintenance_window: "String",
  port: 1,
  sns_topic_arn: "String",
  tls_enabled: false,
  kms_key_id: "String",
  snapshot_arns: ["String"],
  snapshot_name: "String",
  snapshot_retention_limit: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  snapshot_window: "String",
  acl_name: "ACLName", # required
  engine_version: "String",
  auto_minor_version_upgrade: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl_nameString

The name of the Access Control List to associate with the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#auto_minor_version_upgradeBoolean

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (Boolean)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#cluster_nameString

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#descriptionString

An optional description of the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#engine_versionString

The version number of the Redis engine to be used for the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#kms_key_idString

The ID of the KMS key used to encrypt the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#maintenance_windowString

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.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#node_typeString

The compute and memory capacity of the nodes in the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#num_replicas_per_shardInteger

The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

Returns:

  • (Integer)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#num_shardsInteger

The number of shards the cluster will contain. The default value is 1.

Returns:

  • (Integer)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#parameter_group_nameString

The name of the parameter group associated with the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#portInteger

The port number on which each of the nodes accepts connections.

Returns:

  • (Integer)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#security_group_idsArray<String>

A list of security group names to associate with this cluster.

Returns:

  • (Array<String>)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#snapshot_arnsArray<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.

Returns:

  • (Array<String>)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#snapshot_nameString

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.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#snapshot_retention_limitInteger

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.

Returns:

  • (Integer)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#snapshot_windowString

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.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#sns_topic_arnString

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#subnet_group_nameString

The name of the subnet group to be used for the cluster.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#tagsArray<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.

Returns:



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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

#tls_enabledBoolean

A flag to enable in-transit encryption on the cluster.

Returns:

  • (Boolean)


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 749

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