Appearance
aws.elasticache.modify_replication_group ​
Call AWS ElastiCache ModifyReplicationGroup using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID used for field resolution and connection scoping. |
connection_uuid | uuid | Yes | — | AWS CloudConnection UUID for the target ElastiCache account, scoped to the caller organization. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS API endpoint region override; omit to use the connection or SDK default. |
replication_group_id | string | Yes | — | The identifier of the replication group to modify. |
replication_group_description | string | No | — | A description for the replication group. Maximum length is 255 characters. |
primary_cluster_id | string | No | — | 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 oth... |
snapshotting_cluster_id | string | No | — | The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups. |
automatic_failover_enabled | boolean | No | — | Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true |
multi_az_enabled | boolean | No | — | A flag to indicate MultiAZ is enabled. |
node_group_id | string | No | — | Deprecated. This parameter is not used. |
cache_security_group_names | list | No | — | 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 replica... |
security_group_ids | list | No | — | 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 Priv... |
preferred_maintenance_window | string | No | — | 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 windo... |
notification_topic_arn | string | No | — | 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. |
cache_parameter_group_name | string | No | — | 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 p... |
notification_topic_status | string | No | — | The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active |
apply_immediately | boolean | No | — | 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 se... |
engine | string | No | — | Modifies the engine listed in a replication group message. The options are valkey, memcached or redis. |
engine_version | string | No | — | 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... |
auto_minor_version_upgrade | boolean | No | — | If you are running Valkey or Redis OSS 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 p... |
snapshot_retention_limit | integer | No | — | 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... |
snapshot_window | string | No | — | 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 p... |
cache_node_type | string | No | — | A valid cache node type that you want to scale this replication group to. |
auth_token | string | No | — | 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 print... |
auth_token_update_strategy | string | No | — | Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: ROTATE - default, if no update strategy is provided SET - al... |
user_group_ids_to_add | list | No | — | The ID of the user group you are associating with the replication group. |
user_group_ids_to_remove | list | No | — | The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group. |
remove_user_groups | boolean | No | — | Removes the user group associated with this replication group. |
log_delivery_configurations | list | No | — | Specifies the destination, format and type of the logs. |
ip_discovery | string | No | — | The network type you choose when modifying a cluster, either ipv4 |
transit_encryption_enabled | boolean | No | — | A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred. |
transit_encryption_mode | string | No | — | A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryption... |
cluster_mode | string | No | — | Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using bot... |
provider_native_request | json | No | — | Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
connection_uuid | uuid | No | — | AWS CloudConnection UUID echoed from input. |
region | string | No | — | AWS API endpoint region used. |
service | string | No | — | AWS boto3 service/client name. |
operation | string | No | — | AWS API operation invoked. |
request_id | string | No | — | AWS request ID when available. |
response | json | No | — | Sanitized provider response object. |
items | list | No | — | Primary response item list when the API returns a collection. |
result_count | integer | No | — | Count of primary response items. |
next_page_token | string | No | — | Pagination token for the next page. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if engine supplies one. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.elasticache.modify_replication_group",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"replication_group_id": "value"
}
}