1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package elasticache
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/elasticache/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled)
// replication group. This API can be used to create a standalone regional
// replication group or a secondary replication group associated with a Global
// datastore. A Redis (cluster mode disabled) replication group is a collection of
// clusters, where one of the clusters is a read/write primary and the others are
// read-only replicas. Writes to the primary are asynchronously propagated to the
// replicas. A Redis cluster-mode enabled cluster is comprised of from 1 to 90
// shards (API/CLI: node groups). Each shard has a primary node and up to 5
// read-only replica nodes. The configuration can range from 90 shards and 0
// replicas to 15 shards and 5 replicas, which is the maximum number or replicas
// allowed. The node or shard limit can be increased to a maximum of 500 per
// cluster if the Redis engine version is 5.0.6 or higher. For example, you can
// choose to configure a 500 node cluster that ranges between 83 shards (one
// primary and 5 replicas per shard) and 500 shards (single primary and no
// replicas). Make sure there are enough available IP addresses to accommodate the
// increase. Common pitfalls include the subnets in the subnet group have too small
// a CIDR range or the subnets are shared and heavily used by other clusters. For
// more information, see Creating a Subnet Group (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html)
// . For versions below 5.0.6, the limit is 250 per cluster. To request a limit
// increase, see Amazon Service Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
// and choose the limit type Nodes per cluster per instance type. When a Redis
// (cluster mode disabled) replication group has been successfully created, you can
// add one or more read replicas to it, up to a total of 5 read replicas. If you
// need to increase or decrease the number of node groups (console: shards), you
// can avail yourself of ElastiCache for Redis' scaling. For more information, see
// Scaling ElastiCache for Redis Clusters (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html)
// in the ElastiCache User Guide. This operation is valid for Redis only.
func (c *Client) CreateReplicationGroup(ctx context.Context, params *CreateReplicationGroupInput, optFns ...func(*Options)) (*CreateReplicationGroupOutput, error) {
if params == nil {
params = &CreateReplicationGroupInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateReplicationGroup", params, optFns, c.addOperationCreateReplicationGroupMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateReplicationGroupOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the input of a CreateReplicationGroup operation.
type CreateReplicationGroupInput struct {
// A user-created description for the replication group.
//
// This member is required.
ReplicationGroupDescription *string
// The replication group identifier. This parameter is stored as a lowercase
// string. Constraints:
// - A name must contain from 1 to 40 alphanumeric characters or hyphens.
// - The first character must be a letter.
// - A name cannot end with a hyphen or contain two consecutive hyphens.
//
// This member is required.
ReplicationGroupId *string
// 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 , 4.x or later. Default: false
AtRestEncryptionEnabled *bool
// 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.
// - The only permitted printable special characters are !, &, #, $, ^, <, >,
// and -. Other printable special characters cannot be used in the AUTH token.
// For more information, see AUTH password (http://redis.io/commands/AUTH) at
// http://redis.io/commands/AUTH.
AuthToken *string
// If you are running Redis engine version 6.0 or later, set this parameter to
// yes if you want to opt-in to the next auto minor version upgrade campaign. This
// parameter is disabled for previous versions.
AutoMinorVersionUpgrade *bool
// Specifies whether a read-only replica is automatically promoted to read/write
// primary if the existing primary fails. AutomaticFailoverEnabled must be enabled
// for Redis (cluster mode enabled) replication groups. Default: false
AutomaticFailoverEnabled *bool
// 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: M7g node types: cache.m7g.large , cache.m7g.xlarge ,
// cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge
// , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
// M6g node types (available only for Redis engine version 5.0.6 onward and for
// Memcached engine version 1.5.16 onward): cache.m6g.large , cache.m6g.xlarge ,
// cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge
// , cache.m6g.16xlarge M5 node types: cache.m5.large , cache.m5.xlarge ,
// cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4
// node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge ,
// cache.m4.4xlarge , cache.m4.10xlarge T4g node types (available only for Redis
// engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
// cache.t4g.micro , cache.t4g.small , cache.t4g.medium T3 node types:
// cache.t3.micro , cache.t3.small , cache.t3.medium T2 node types:
// cache.t2.micro , cache.t2.small , cache.t2.medium
// - Previous generation: (not recommended. Existing clusters are still
// supported but creation of new clusters is not supported for these types.) T1
// node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium ,
// cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium ,
// cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge
// - Compute optimized:
// - Previous generation: (not recommended. Existing clusters are still
// supported but creation of new clusters is not supported for these types.) C1
// node types: cache.c1.xlarge
// - Memory optimized:
// - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge ,
// cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge
// , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
// R6g node types (available only for Redis engine version 5.0.6 onward and for
// Memcached engine version 1.5.16 onward): cache.r6g.large , cache.r6g.xlarge ,
// cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge
// , cache.r6g.16xlarge R5 node types: cache.r5.large , cache.r5.xlarge ,
// cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge 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. Existing clusters are still
// supported but creation of new clusters is not supported for these types.) M2
// node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node
// types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge ,
//
// cache.r3.4xlarge , cache.r3.8xlarge
// Additional node type info
// - All current generation instance types are created in Amazon VPC by default.
// - Redis append-only files (AOF) are not supported for T1 or T2 instances.
// - Redis Multi-AZ with automatic failover is not supported on T1 instances.
// - Redis configuration variables appendonly and appendfsync are not supported
// on Redis version 2.8.22 and later.
CacheNodeType *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 .
CacheParameterGroupName *string
// A list of cache security group names to associate with this replication group.
CacheSecurityGroupNames []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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html)
// .
CacheSubnetGroupName *string
// Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must
// first set the cluster mode to Compatible. Compatible mode allows your Redis
// clients to connect using both cluster mode enabled and cluster mode disabled.
// After you migrate all Redis clients to use cluster mode enabled, you can then
// complete cluster mode configuration and set the cluster mode to Enabled.
ClusterMode types.ClusterMode
// Enables data tiering. Data tiering is only supported for replication groups
// using the r6gd node type. This parameter must be set to true when using r6gd
// nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html)
// .
DataTieringEnabled *bool
// The name of the cache engine to be used for the clusters in this replication
// group. The value must be set to Redis .
Engine *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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)
// ) 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.
EngineVersion *string
// The name of the Global datastore
GlobalReplicationGroupId *string
// The network type you choose when creating a replication group, either ipv4 |
// ipv6 . IPv6 is supported for workloads using Redis engine version 6.2 onward or
// Memcached engine version 1.6.6 on all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/)
// .
IpDiscovery types.IpDiscovery
// The ID of the KMS key used to encrypt the disk in the cluster.
KmsKeyId *string
// Specifies the destination, format and type of the logs.
LogDeliveryConfigurations []types.LogDeliveryConfigurationRequest
// A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For
// more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html)
// .
MultiAZEnabled *bool
// Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using
// Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all
// instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/) .
NetworkType types.NetworkType
// 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, it is required 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.
NodeGroupConfiguration []types.NodeGroupConfiguration
// The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS)
// topic to which notifications are sent. The Amazon SNS topic owner must be the
// same as the cluster owner.
NotificationTopicArn *string
// 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).
NumCacheClusters *int32
// 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
NumNodeGroups *int32
// The port number on which each member of the replication group accepts
// connections.
Port *int32
// 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. 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
// . Default: system chosen Availability Zones.
PreferredCacheClusterAZs []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
PreferredMaintenanceWindow *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.
PrimaryClusterId *string
// An optional parameter that specifies the number of replica nodes in each node
// group (shard). Valid values are 0 to 5.
ReplicasPerNodeGroup *int32
// 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).
SecurityGroupIds []string
// The name of the snapshot used to create a replication group. Available for
// Redis only.
ServerlessCacheSnapshotName *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
SnapshotArns []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.
SnapshotName *string
// 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).
SnapshotRetentionLimit *int32
// 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.
SnapshotWindow *string
// 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 . Tags on replication groups will be replicated to all nodes.
Tags []types.Tag
// A flag that enables in-transit encryption when set to true . This parameter is
// valid only if the Engine parameter is redis , the EngineVersion parameter is
// 3.2.6 , 4.x or later, 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 , 4.x or later. Default: false For HIPAA compliance,
// you must specify TransitEncryptionEnabled as true , an AuthToken , and a
// CacheSubnetGroup .
TransitEncryptionEnabled *bool
// A setting that allows you to migrate your clients to use in-transit encryption,
// with no downtime. When setting TransitEncryptionEnabled to true , you can set
// your TransitEncryptionMode to preferred in the same request, to allow both
// encrypted and unencrypted connections at the same time. Once you migrate all
// your Redis clients to use encrypted connections you can modify the value to
// required to allow encrypted connections only. Setting TransitEncryptionMode to
// required is a two-step process that requires you to first set the
// TransitEncryptionMode to preferred , after that you can set
// TransitEncryptionMode to required . This process will not trigger the
// replacement of the replication group.
TransitEncryptionMode types.TransitEncryptionMode
// The user group to associate with the replication group.
UserGroupIds []string
noSmithyDocumentSerde
}
type CreateReplicationGroupOutput struct {
// Contains all of the attributes of a specific Redis replication group.
ReplicationGroup *types.ReplicationGroup
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateReplicationGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpCreateReplicationGroup{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCreateReplicationGroup{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateReplicationGroup"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateReplicationGroupValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateReplicationGroup(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateReplicationGroup(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateReplicationGroup",
}
}
|