NAME

Paws::ElastiCache::ModifyReplicationGroup - Arguments for method ModifyReplicationGroup on Paws::ElastiCache

DESCRIPTION

This class represents the parameters used for calling the method ModifyReplicationGroup on the Amazon ElastiCache service. Use the attributes of this class as arguments to method ModifyReplicationGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationGroup.

SYNOPSIS

    my $elasticache = Paws->service('ElastiCache');
    # ModifyReplicationGroup
    my $ModifyReplicationGroupResult = $elasticache->ModifyReplicationGroup(
      'ApplyImmediately'            => 1,
      'ReplicationGroupDescription' => 'Modified replication group',
      'ReplicationGroupId'          => 'my-redis-rg',
      'SnapshotRetentionLimit'      => 30,
      'SnapshottingClusterId'       => 'my-redis-rg-001'
    );
    # Results:
    my $ReplicationGroup = $ModifyReplicationGroupResult->ReplicationGroup;
    # Returns a L<Paws::ElastiCache::ModifyReplicationGroupResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/elasticache/ModifyReplicationGroup>

ATTRIBUTES

ApplyImmediately => Bool

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"

AuthToken => Str

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 (http://redis.io/commands/AUTH).

AuthTokenUpdateStrategy => Str

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 (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)

Valid values are: "SET", "ROTATE", "DELETE"

AutomaticFailoverEnabled => Bool

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: "true" | "false"

AutoMinorVersionUpgrade => Bool

This parameter is currently disabled.

CacheNodeType => Str

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

CacheParameterGroupName => Str

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.

CacheSecurityGroupNames => ArrayRef[Str|Undef]

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".

EngineVersion => Str

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), 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.

LogDeliveryConfigurations => ArrayRef[Paws::ElastiCache::LogDeliveryConfigurationRequest]

Specifies the destination, format and type of the logs.

MultiAZEnabled => Bool

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

NodeGroupId => Str

Deprecated. This parameter is not used.

NotificationTopicArn => Str

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.

NotificationTopicStatus => Str

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"

PreferredMaintenanceWindow => Str

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"

PrimaryClusterId => Str

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.

RemoveUserGroups => Bool

Removes the user groups that can access this replication group.

ReplicationGroupDescription => Str

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

REQUIRED ReplicationGroupId => Str

The identifier of the replication group to modify.

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

UserGroupIdsToAdd => ArrayRef[Str|Undef]

The user group you are associating with the replication group.

UserGroupIdsToRemove => ArrayRef[Str|Undef]

The user group to remove, meaning the users in the group no longer can access the replication group.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>