Skip to content
AWS for Query.Farm

aws.dynamodb.describe_table_replica_auto_scaling

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_table_replica_auto_scaling
WHERE
"table_name" = 'VALUE';

Description

Describes auto scaling settings across replicas of the global table at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Table Definition

Column NameColumn Data Type
table_name Required Input Column

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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
table_auto_scaling_description

Represents the auto scaling properties of the table.

STRUCT(
    "table_name" VARCHAR,
    "table_status" VARCHAR,
    "replicas" STRUCT(
        "region_name" VARCHAR,
        "global_secondary_indexes" STRUCT(
            "index_name" VARCHAR,
            "index_status" VARCHAR,
            "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_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_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_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_status" VARCHAR
    )[]
)
Show child fields
table_auto_scaling_description.replicas[]
Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[]
Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].index_name

The name of the global secondary index.

table_auto_scaling_description.replicas[].global_secondary_indexes[].index_status

The current state of the replica global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings

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

Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled

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

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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).

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings

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

Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled

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

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

table_auto_scaling_description.replicas[].global_secondary_indexes[].provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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.

table_auto_scaling_description.replicas[].global_secondary_indexes[].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).

table_auto_scaling_description.replicas[].region_name

The Region where the replica exists.

table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings

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

Show child fields
table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_disabled

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

table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

table_auto_scaling_description.replicas[].replica_provisioned_read_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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).

table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings

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

Show child fields
table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_disabled

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

table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings.auto_scaling_role_arn

Role ARN used for configuring the auto scaling policy.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[]
Show child fields
table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].policy_name

The name of the scaling policy.

table_auto_scaling_description.replicas[].replica_provisioned_write_capacity_auto_scaling_settings.scaling_policies[].target_tracking_scaling_policy_configuration

Represents a target tracking scaling policy configuration.

Show child fields
table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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.

table_auto_scaling_description.replicas[].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).

table_auto_scaling_description.replicas[].replica_status

The current state of the replica:

  • CREATING - The replica is being created.

  • UPDATING - The replica is being updated.

  • DELETING - The replica is being deleted.

  • ACTIVE - The replica is ready for use.

table_auto_scaling_description.table_name

The name of the table.

table_auto_scaling_description.table_status

The current state of the table:

  • CREATING - The table is being created.

  • UPDATING - The table is being updated.

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.