Skip to content

aws.dynamodb.describe_global_table_settings

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_global_table_settings
WHERE
"global_table_name" = 'VALUE';

Description

Describes Region-specific settings for a global table.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

Table Definition

Column NameColumn Data Type
global_table_name Required Input Column

The name of the global table.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
replica_settings

The Region-specific settings for the global table.

STRUCT(
"region_name" VARCHAR,
"replica_status" VARCHAR,
"replica_billing_mode_summary" STRUCT(
"billing_mode" VARCHAR,
"last_update_to_pay_per_request_date_time" TIMESTAMP_S
),
"replica_provisioned_read_capacity_units" BIGINT,
"replica_provisioned_read_capacity_auto_scaling_settings" STRUCT(
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"auto_scaling_disabled" BOOLEAN,
"auto_scaling_role_arn" VARCHAR,
"scaling_policies" STRUCT(
"policy_name" VARCHAR,
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)[]
),
"replica_provisioned_write_capacity_units" BIGINT,
"replica_provisioned_write_capacity_auto_scaling_settings" STRUCT(
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"auto_scaling_disabled" BOOLEAN,
"auto_scaling_role_arn" VARCHAR,
"scaling_policies" STRUCT(
"policy_name" VARCHAR,
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)[]
),
"replica_global_secondary_index_settings" STRUCT(
"index_name" VARCHAR,
"index_status" VARCHAR,
"provisioned_read_capacity_units" BIGINT,
"provisioned_read_capacity_auto_scaling_settings" STRUCT(
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"auto_scaling_disabled" BOOLEAN,
"auto_scaling_role_arn" VARCHAR,
"scaling_policies" STRUCT(
"policy_name" VARCHAR,
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)[]
),
"provisioned_write_capacity_units" BIGINT,
"provisioned_write_capacity_auto_scaling_settings" STRUCT(
"minimum_units" BIGINT,
"maximum_units" BIGINT,
"auto_scaling_disabled" BOOLEAN,
"auto_scaling_role_arn" VARCHAR,
"scaling_policies" STRUCT(
"policy_name" VARCHAR,
"target_tracking_scaling_policy_configuration" STRUCT(
"disable_scale_in" BOOLEAN,
"scale_in_cooldown" BIGINT,
"scale_out_cooldown" BIGINT,
"target_value" DOUBLE
)
)[]
)
)[],
"replica_table_class_summary" STRUCT(
"table_class" VARCHAR,
"last_update_date_time" TIMESTAMP_S
)
)[]
Show child fields
replica_settings[]
Show child fields
replica_settings[].region_name

The Region name of the replica.

replica_settings[].replica_billing_mode_summary

The read/write capacity mode of the replica.

Show child fields
replica_settings[].replica_billing_mode_summary.billing_mode

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

replica_settings[].replica_billing_mode_summary.last_update_to_pay_per_request_date_time

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

replica_settings[].replica_global_secondary_index_settings[]
Show child fields
replica_settings[].replica_global_secondary_index_settings[].index_name

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

replica_settings[].replica_global_secondary_index_settings[].index_status

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.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings

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

Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled

Disabled auto scaling for this global table or global secondary index.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.maximum_units

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.minimum_units

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_in_cooldown

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 auto scaling scales out your scalable target immediately.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.target_value

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_read_capacity_units

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings

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

Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled

Disabled auto scaling for this global table or global secondary index.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.maximum_units

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.minimum_units

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_in_cooldown

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 auto scaling scales out your scalable target immediately.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.target_value

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

replica_settings[].replica_global_secondary_index_settings[].provisioned_write_capacity_units

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

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings

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

Show child fields
replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled

Disabled auto scaling for this global table or global secondary index.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.maximum_units

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

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.minimum_units

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

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_in_cooldown

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 auto scaling scales out your scalable target immediately.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_settings[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.target_value

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

replica_settings[].replica_provisioned_read_capacity_units

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.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings

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

Show child fields
replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled

Disabled auto scaling for this global table or global secondary index.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.maximum_units

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

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.minimum_units

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

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.disable_scale_in

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.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_in_cooldown

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 auto scaling scales out your scalable target immediately.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.scale_out_cooldown

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.

replica_settings[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration.target_value

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

replica_settings[].replica_provisioned_write_capacity_units

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.

replica_settings[].replica_status

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.

replica_settings[].replica_table_class_summary

Contains details of the table class.

Show child fields
replica_settings[].replica_table_class_summary.last_update_date_time

The date and time at which the table class was last updated.

replica_settings[].replica_table_class_summary.table_class

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.