Class: Aws::ElastiCache::Types::CreateReplicationGroupMessage

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

Overview

Note:

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

{
  replication_group_id: "String", # required
  replication_group_description: "String", # required
  primary_cluster_id: "String",
  automatic_failover_enabled: false,
  num_cache_clusters: 1,
  preferred_cache_cluster_a_zs: ["String"],
  num_node_groups: 1,
  replicas_per_node_group: 1,
  node_group_configuration: [
    {
      node_group_id: "AllowedNodeGroupId",
      slots: "String",
      replica_count: 1,
      primary_availability_zone: "String",
      replica_availability_zones: ["String"],
    },
  ],
  cache_node_type: "String",
  engine: "String",
  engine_version: "String",
  cache_parameter_group_name: "String",
  cache_subnet_group_name: "String",
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  snapshot_arns: ["String"],
  snapshot_name: "String",
  preferred_maintenance_window: "String",
  port: 1,
  notification_topic_arn: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  auth_token: "String",
  transit_encryption_enabled: false,
  at_rest_encryption_enabled: false,
}

Represents the input of a ‘CreateReplicationGroup` operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#at_rest_encryption_enabled ⇒ Boolean

A flag that enables encryption at rest when set to ‘true`.

You cannot modify the value of ‘AtRestEncryptionEnabled` after the replication group is created. To enable encryption at rest on a replication group you must set `AtRestEncryptionEnabled` to `true` when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version ‘3.2.6` or `4.x`.

Default: ‘false`

Returns:

  • (Boolean) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#auth_token ⇒ String

**Reserved parameter.** The password used to access a password protected server.

‘AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`.

For HIPAA compliance, you must specify ‘TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • Cannot contain any of the following characters: ‘/’, ‘“’, or ‘@’.

For more information, see [AUTH password] at redis.io/commands/AUTH.

[1]: redis.io/commands/AUTH

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

This parameter is currently disabled.

Returns:

  • (Boolean) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#automatic_failover_enabled ⇒ Boolean

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If ‘true`, Multi-AZ is enabled for this replication group. If `false`, Multi-AZ is disabled for this replication group.

‘AutomaticFailoverEnabled` must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 and T2 cache node types.

  • Redis (cluster mode enabled): T1 node types.

Returns:

  • (Boolean) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_node_type ⇒ String

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

      **M3 node types:** ‘cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge`

      **M4 node types:** ‘cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`

    • Previous generation: (not recommended)

      **T1 node types:** ‘cache.t1.micro`

      **M1 node types:** ‘cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge`

  • Compute optimized:

    • Previous generation: (not recommended)

      **C1 node types:** ‘cache.c1.xlarge`

  • Memory optimized:

    • Current generation:

      **R3 node types:** ‘cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`

      **R4 node types;** ‘cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge`

    • Previous generation: (not recommended)

      **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see:

  • Amazon ElastiCache Product Features and Details][1
  • Cache Node Type-Specific Parameters for Memcached][2
  • Cache Node Type-Specific Parameters for Redis][3

[1]: aws.amazon.com/elasticache/details [2]: docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific [3]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_parameter_group_name ⇒ String

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use ‘CacheParameterGroupName=default.redis3.2`.

  • To create a Redis (cluster mode enabled) replication group, use ‘CacheParameterGroupName=default.redis3.2.cluster.on`.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_security_group_names ⇒ Array<String>

A list of cache security group names to associate with this replication group.

Returns:

  • (Array<String>) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_subnet_group_name ⇒ String

The name of the cache subnet group to be used for the replication group.

If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [Subnets and Subnet Groups].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#engine ⇒ String

The name of the cache engine to be used for the clusters in this replication group.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#engine_version ⇒ String

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the ‘DescribeCacheEngineVersions` operation.

Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]) in the *ElastiCache User Guide*, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#node_group_configuration ⇒ Array<Types::NodeGroupConfiguration>

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: ‘PrimaryAvailabilityZone`, `ReplicaAvailabilityZones`, `ReplicaCount`, and `Slots`.

If you’re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Returns:



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#notification_topic_arn ⇒ String

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

<note markdown=“1”> The Amazon SNS topic owner must be the same as the cluster owner.

</note>

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#num_cache_clusters ⇒ Integer

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ‘ReplicasPerNodeGroup` instead.

If ‘AutomaticFailoverEnabled` is `true`, the value of this parameter must be at least 2. If `AutomaticFailoverEnabled` is `false` you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for ‘NumCacheClusters` is 6 (1 primary plus 5 replicas).

Returns:

  • (Integer) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#num_node_groups ⇒ Integer

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Returns:

  • (Integer) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#port ⇒ Integer

The port number on which each member of the replication group accepts connections.

Returns:

  • (Integer) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#preferred_cache_cluster_a_zs ⇒ Array<String>

A list of EC2 Availability Zones in which the replication group’s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use ‘NodeGroupConfiguration` instead.

<note markdown=“1”> If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of

‘NumCacheClusters`.

</note>

Default: system chosen Availability Zones.

Returns:

  • (Array<String>) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#preferred_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:

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`

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#primary_cluster_id ⇒ String

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of ‘available`.

This parameter is not required if ‘NumCacheClusters`, `NumNodeGroups`, or `ReplicasPerNodeGroup` is specified.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#replicas_per_node_group ⇒ Integer

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Returns:

  • (Integer) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#replication_group_description ⇒ String

A user-created description for the replication group.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#replication_group_id ⇒ String

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

  • (Array<String>) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_arns ⇒ Array<String>

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: ‘arn:aws:s3:::my_bucket/snapshot1.rdb`

Returns:

  • (Array<String>) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_name ⇒ String

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to ‘restoring` while the new replication group is being created.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_retention_limit ⇒ Integer

The number of days for which ElastiCache 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.

Default: 0 (i.e., automatic backups are disabled for this cluster).

Returns:

  • (Integer) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_window ⇒ String

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: ‘05:00-09:00`

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Returns:

  • (String) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of cost allocation tags to be added to this resource. A tag is a key-value pair.

Returns:



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#transit_encryption_enabled ⇒ Boolean

A flag that enables in-transit encryption when set to ‘true`.

You cannot modify the value of ‘TransitEncryptionEnabled` after the cluster is created. To enable in-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster.

This parameter is valid only if the ‘Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x`, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for ‘CacheSubnetGroup`.

Required: Only available when creating a replication group in an Amazon VPC using redis version ‘3.2.6` or `4.x`.

Default: ‘false`

For HIPAA compliance, you must specify ‘TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.

Returns:

  • (Boolean) 


2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2112

class CreateReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :automatic_failover_enabled,
  :num_cache_clusters,
  :preferred_cache_cluster_a_zs,
  :num_node_groups,
  :replicas_per_node_group,
  :node_group_configuration,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :cache_security_group_names,
  :security_group_ids,
  :tags,
  :snapshot_arns,
  :snapshot_name,
  :preferred_maintenance_window,
  :port,
  :notification_topic_arn,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end