Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dynamodb ]

update-global-table-settings

Description

Updates settings for a global table.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-global-table-settings
--global-table-name <value>
[--global-table-provisioned-write-capacity-units <value>]
[--global-table-provisioned-write-capacity-auto-scaling-settings-update <value>]
[--global-table-global-secondary-index-settings-update <value>]
[--replica-settings-update <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--global-table-name (string)

The name of the global table

--global-table-provisioned-write-capacity-units (long)

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

--global-table-provisioned-write-capacity-auto-scaling-settings-update (structure)

AutoScaling settings for managing provisioned write capacity for the global table.

Shorthand Syntax:

MinimumUnits=long,MaximumUnits=long,AutoScalingDisabled=boolean,AutoScalingRoleArn=string,ScalingPolicyUpdate={PolicyName=string,TargetTrackingScalingPolicyConfiguration={DisableScaleIn=boolean,ScaleInCooldown=integer,ScaleOutCooldown=integer,TargetValue=double}}

JSON Syntax:

{
  "MinimumUnits": long,
  "MaximumUnits": long,
  "AutoScalingDisabled": true|false,
  "AutoScalingRoleArn": "string",
  "ScalingPolicyUpdate": {
    "PolicyName": "string",
    "TargetTrackingScalingPolicyConfiguration": {
      "DisableScaleIn": true|false,
      "ScaleInCooldown": integer,
      "ScaleOutCooldown": integer,
      "TargetValue": double
    }
  }
}

--global-table-global-secondary-index-settings-update (list)

Represents the settings of a global secondary index for a global table that will be modified.

JSON Syntax:

[
  {
    "IndexName": "string",
    "ProvisionedWriteCapacityUnits": long,
    "ProvisionedWriteCapacityAutoScalingSettingsUpdate": {
      "MinimumUnits": long,
      "MaximumUnits": long,
      "AutoScalingDisabled": true|false,
      "AutoScalingRoleArn": "string",
      "ScalingPolicyUpdate": {
        "PolicyName": "string",
        "TargetTrackingScalingPolicyConfiguration": {
          "DisableScaleIn": true|false,
          "ScaleInCooldown": integer,
          "ScaleOutCooldown": integer,
          "TargetValue": double
        }
      }
    }
  }
  ...
]

--replica-settings-update (list)

Represents the settings for a global table in a region that will be modified.

JSON Syntax:

[
  {
    "RegionName": "string",
    "ReplicaProvisionedReadCapacityUnits": long,
    "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": {
      "MinimumUnits": long,
      "MaximumUnits": long,
      "AutoScalingDisabled": true|false,
      "AutoScalingRoleArn": "string",
      "ScalingPolicyUpdate": {
        "PolicyName": "string",
        "TargetTrackingScalingPolicyConfiguration": {
          "DisableScaleIn": true|false,
          "ScaleInCooldown": integer,
          "ScaleOutCooldown": integer,
          "TargetValue": double
        }
      }
    },
    "ReplicaGlobalSecondaryIndexSettingsUpdate": [
      {
        "IndexName": "string",
        "ProvisionedReadCapacityUnits": long,
        "ProvisionedReadCapacityAutoScalingSettingsUpdate": {
          "MinimumUnits": long,
          "MaximumUnits": long,
          "AutoScalingDisabled": true|false,
          "AutoScalingRoleArn": "string",
          "ScalingPolicyUpdate": {
            "PolicyName": "string",
            "TargetTrackingScalingPolicyConfiguration": {
              "DisableScaleIn": true|false,
              "ScaleInCooldown": integer,
              "ScaleOutCooldown": integer,
              "TargetValue": double
            }
          }
        }
      }
      ...
    ]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

GlobalTableName -> (string)

The name of the global table.

ReplicaSettings -> (list)

The region specific settings for the global table.

(structure)

Represents the properties of a replica.

RegionName -> (string)

The region name of the replica.

ReplicaStatus -> (string)

The current state of the region:

  • CREATING - The region is being created.
  • UPDATING - The region is being updated.
  • DELETING - The region is being deleted.
  • ACTIVE - The region is ready for use.

ReplicaProvisionedReadCapacityUnits -> (long)

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException . For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .

ReplicaProvisionedReadCapacityAutoScalingSettings -> (structure)

Autoscaling settings for a global table replica's read capacity units.

MinimumUnits -> (long)

The minimum capacity units that a global table or global secondary index should be scaled down to.

MaximumUnits -> (long)

The maximum capacity units that a global table or global secondary index should be scaled up to.

AutoScalingDisabled -> (boolean)

Disabled autoscaling for this global table or global secondary index.

AutoScalingRoleArn -> (string)

Role ARN used for configuring autoScaling policy.

ScalingPolicies -> (list)

Information about the scaling policies.

(structure)

Represents the properties of the scaling policy.

PolicyName -> (string)

The name of the scaling policy.

TargetTrackingScalingPolicyConfiguration -> (structure)

Represents a target tracking scaling policy configuration.

DisableScaleIn -> (boolean)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

ScaleInCooldown -> (integer)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

ScaleOutCooldown -> (integer)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

TargetValue -> (double)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

ReplicaProvisionedWriteCapacityUnits -> (long)

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException . For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .

ReplicaProvisionedWriteCapacityAutoScalingSettings -> (structure)

AutoScaling settings for a global table replica's write capacity units.

MinimumUnits -> (long)

The minimum capacity units that a global table or global secondary index should be scaled down to.

MaximumUnits -> (long)

The maximum capacity units that a global table or global secondary index should be scaled up to.

AutoScalingDisabled -> (boolean)

Disabled autoscaling for this global table or global secondary index.

AutoScalingRoleArn -> (string)

Role ARN used for configuring autoScaling policy.

ScalingPolicies -> (list)

Information about the scaling policies.

(structure)

Represents the properties of the scaling policy.

PolicyName -> (string)

The name of the scaling policy.

TargetTrackingScalingPolicyConfiguration -> (structure)

Represents a target tracking scaling policy configuration.

DisableScaleIn -> (boolean)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

ScaleInCooldown -> (integer)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

ScaleOutCooldown -> (integer)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

TargetValue -> (double)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

ReplicaGlobalSecondaryIndexSettings -> (list)

Replica global secondary index settings for the global table.

(structure)

Represents the properties of a global secondary index.

IndexName -> (string)

The name of the global secondary index. The name must be unique among all other indexes on this table.

IndexStatus -> (string)

The current status of the global secondary index:

  • CREATING - The global secondary index is being created.
  • UPDATING - The global secondary index is being updated.
  • DELETING - The global secondary index is being deleted.
  • ACTIVE - The global secondary index is ready for use.

ProvisionedReadCapacityUnits -> (long)

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .

ProvisionedReadCapacityAutoScalingSettings -> (structure)

Autoscaling settings for a global secondary index replica's read capacity units.

MinimumUnits -> (long)

The minimum capacity units that a global table or global secondary index should be scaled down to.

MaximumUnits -> (long)

The maximum capacity units that a global table or global secondary index should be scaled up to.

AutoScalingDisabled -> (boolean)

Disabled autoscaling for this global table or global secondary index.

AutoScalingRoleArn -> (string)

Role ARN used for configuring autoScaling policy.

ScalingPolicies -> (list)

Information about the scaling policies.

(structure)

Represents the properties of the scaling policy.

PolicyName -> (string)

The name of the scaling policy.

TargetTrackingScalingPolicyConfiguration -> (structure)

Represents a target tracking scaling policy configuration.

DisableScaleIn -> (boolean)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

ScaleInCooldown -> (integer)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

ScaleOutCooldown -> (integer)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

TargetValue -> (double)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

ProvisionedWriteCapacityUnits -> (long)

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException .

ProvisionedWriteCapacityAutoScalingSettings -> (structure)

AutoScaling settings for a global secondary index replica's write capacity units.

MinimumUnits -> (long)

The minimum capacity units that a global table or global secondary index should be scaled down to.

MaximumUnits -> (long)

The maximum capacity units that a global table or global secondary index should be scaled up to.

AutoScalingDisabled -> (boolean)

Disabled autoscaling for this global table or global secondary index.

AutoScalingRoleArn -> (string)

Role ARN used for configuring autoScaling policy.

ScalingPolicies -> (list)

Information about the scaling policies.

(structure)

Represents the properties of the scaling policy.

PolicyName -> (string)

The name of the scaling policy.

TargetTrackingScalingPolicyConfiguration -> (structure)

Represents a target tracking scaling policy configuration.

DisableScaleIn -> (boolean)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

ScaleInCooldown -> (integer)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

ScaleOutCooldown -> (integer)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

TargetValue -> (double)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).