Skip to content

Update Table Replica Auto Scaling

dynamodb_update_table_replica_auto_scaling R Documentation

Updates auto scaling settings on your global tables at once

Description

Updates auto scaling settings on your global tables at once.

Usage

dynamodb_update_table_replica_auto_scaling(GlobalSecondaryIndexUpdates,
  TableName, ProvisionedWriteCapacityAutoScalingUpdate, ReplicaUpdates)

Arguments

GlobalSecondaryIndexUpdates

Represents the auto scaling settings of the global secondary indexes of the replica to be updated.

TableName

[required] The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

ProvisionedWriteCapacityAutoScalingUpdate

Represents the auto scaling settings to be modified for a global table or global secondary index.

ReplicaUpdates

Represents the auto scaling settings of replicas of the table that will be modified.

Value

A list with the following syntax:

list(
  TableAutoScalingDescription = list(
    TableName = "string",
    TableStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED"|"REPLICATION_NOT_AUTHORIZED",
    Replicas = list(
      list(
        RegionName = "string",
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE",
            ProvisionedReadCapacityAutoScalingSettings = list(
              MinimumUnits = 123,
              MaximumUnits = 123,
              AutoScalingDisabled = TRUE|FALSE,
              AutoScalingRoleArn = "string",
              ScalingPolicies = list(
                list(
                  PolicyName = "string",
                  TargetTrackingScalingPolicyConfiguration = list(
                    DisableScaleIn = TRUE|FALSE,
                    ScaleInCooldown = 123,
                    ScaleOutCooldown = 123,
                    TargetValue = 123.0
                  )
                )
              )
            ),
            ProvisionedWriteCapacityAutoScalingSettings = list(
              MinimumUnits = 123,
              MaximumUnits = 123,
              AutoScalingDisabled = TRUE|FALSE,
              AutoScalingRoleArn = "string",
              ScalingPolicies = list(
                list(
                  PolicyName = "string",
                  TargetTrackingScalingPolicyConfiguration = list(
                    DisableScaleIn = TRUE|FALSE,
                    ScaleInCooldown = 123,
                    ScaleOutCooldown = 123,
                    TargetValue = 123.0
                  )
                )
              )
            )
          )
        ),
        ReplicaProvisionedReadCapacityAutoScalingSettings = list(
          MinimumUnits = 123,
          MaximumUnits = 123,
          AutoScalingDisabled = TRUE|FALSE,
          AutoScalingRoleArn = "string",
          ScalingPolicies = list(
            list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        ),
        ReplicaProvisionedWriteCapacityAutoScalingSettings = list(
          MinimumUnits = 123,
          MaximumUnits = 123,
          AutoScalingDisabled = TRUE|FALSE,
          AutoScalingRoleArn = "string",
          ScalingPolicies = list(
            list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        ),
        ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED"|"REPLICATION_NOT_AUTHORIZED"
      )
    )
  )
)

Request syntax

svc$update_table_replica_auto_scaling(
  GlobalSecondaryIndexUpdates = list(
    list(
      IndexName = "string",
      ProvisionedWriteCapacityAutoScalingUpdate = list(
        MinimumUnits = 123,
        MaximumUnits = 123,
        AutoScalingDisabled = TRUE|FALSE,
        AutoScalingRoleArn = "string",
        ScalingPolicyUpdate = list(
          PolicyName = "string",
          TargetTrackingScalingPolicyConfiguration = list(
            DisableScaleIn = TRUE|FALSE,
            ScaleInCooldown = 123,
            ScaleOutCooldown = 123,
            TargetValue = 123.0
          )
        )
      )
    )
  ),
  TableName = "string",
  ProvisionedWriteCapacityAutoScalingUpdate = list(
    MinimumUnits = 123,
    MaximumUnits = 123,
    AutoScalingDisabled = TRUE|FALSE,
    AutoScalingRoleArn = "string",
    ScalingPolicyUpdate = list(
      PolicyName = "string",
      TargetTrackingScalingPolicyConfiguration = list(
        DisableScaleIn = TRUE|FALSE,
        ScaleInCooldown = 123,
        ScaleOutCooldown = 123,
        TargetValue = 123.0
      )
    )
  ),
  ReplicaUpdates = list(
    list(
      RegionName = "string",
      ReplicaGlobalSecondaryIndexUpdates = list(
        list(
          IndexName = "string",
          ProvisionedReadCapacityAutoScalingUpdate = list(
            MinimumUnits = 123,
            MaximumUnits = 123,
            AutoScalingDisabled = TRUE|FALSE,
            AutoScalingRoleArn = "string",
            ScalingPolicyUpdate = list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        )
      ),
      ReplicaProvisionedReadCapacityAutoScalingUpdate = list(
        MinimumUnits = 123,
        MaximumUnits = 123,
        AutoScalingDisabled = TRUE|FALSE,
        AutoScalingRoleArn = "string",
        ScalingPolicyUpdate = list(
          PolicyName = "string",
          TargetTrackingScalingPolicyConfiguration = list(
            DisableScaleIn = TRUE|FALSE,
            ScaleInCooldown = 123,
            ScaleOutCooldown = 123,
            TargetValue = 123.0
          )
        )
      )
    )
  )
)