ModifyReplicationGroupMessage

public struct ModifyReplicationGroupMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true | false Default: false

    Declaration

    Swift

    public let applyImmediately: Bool?

  • Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. 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 AUTH.

    Declaration

    Swift

    public let authToken: String?

  • Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: Rotate Set For more information, see Authenticating Users with Redis AUTH

    Declaration

    Swift

    public let authTokenUpdateStrategy: AuthTokenUpdateStrategyType?

  • Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false

    Declaration

    Swift

    public let automaticFailoverEnabled: Bool?

  • This parameter is currently disabled.

    Declaration

    Swift

    public let autoMinorVersionUpgrade: Bool?

  • A valid cache node type that you want to scale this replication group to.

    Declaration

    Swift

    public let cacheNodeType: String?

  • The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    Declaration

    Swift

    public let cacheParameterGroupName: String?

  • A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

    Declaration

    Swift

    public let cacheSecurityGroupNames: [String]?

  • The upgraded version of the cache engine to be run on the clusters in the replication group. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

    Declaration

    Swift

    public let engineVersion: String?

  • A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

    Declaration

    Swift

    public let multiAZEnabled: Bool?

  • The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the replication group owner.

    Declaration

    Swift

    public let notificationTopicArn: String?

  • The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active | inactive

    Declaration

    Swift

    public let notificationTopicStatus: 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

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

  • For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

    Declaration

    Swift

    public let primaryClusterId: String?

  • A description for the replication group. Maximum length is 255 characters.

    Declaration

    Swift

    public let replicationGroupDescription: String?

  • The identifier of the replication group to modify.

    Declaration

    Swift

    public let replicationGroupId: String

  • Specifies the VPC Security Groups associated with the clusters in the replication group. This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

    Declaration

    Swift

    public let securityGroupIds: [String]?

  • The number of days for which ElastiCache retains automatic node group (shard) 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. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    Declaration

    Swift

    public let snapshotRetentionLimit: Int?

  • The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

    Declaration

    Swift

    public let snapshottingClusterId: String?

  • The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    Declaration

    Swift

    public let snapshotWindow: String?

  • Undocumented

    Declaration

    Swift

    public init(applyImmediately: Bool? = nil, authToken: String? = nil, authTokenUpdateStrategy: AuthTokenUpdateStrategyType? = nil, automaticFailoverEnabled: Bool? = nil, autoMinorVersionUpgrade: Bool? = nil, cacheNodeType: String? = nil, cacheParameterGroupName: String? = nil, cacheSecurityGroupNames: [String]? = nil, engineVersion: String? = nil, multiAZEnabled: Bool? = nil, notificationTopicArn: String? = nil, notificationTopicStatus: String? = nil, preferredMaintenanceWindow: String? = nil, primaryClusterId: String? = nil, replicationGroupDescription: String? = nil, replicationGroupId: String, securityGroupIds: [String]? = nil, snapshotRetentionLimit: Int? = nil, snapshottingClusterId: String? = nil, snapshotWindow: String? = nil)