Describe Global Table Settings

dynamodb_describe_global_table_settings

R Documentation

Describes Region-specific settings for a global table

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.

Usage

dynamodb_describe_global_table_settings(GlobalTableName)

Arguments

GlobalTableName

[required] The name of the global table to describe.

Value

A list with the following syntax:

list(
  GlobalTableName = "string",
  ReplicaSettings = list(
    list(
      RegionName = "string",
      ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
      ReplicaBillingModeSummary = list(
        BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
        LastUpdateToPayPerRequestDateTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      ReplicaProvisionedReadCapacityUnits = 123,
      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
            )
          )
        )
      ),
      ReplicaProvisionedWriteCapacityUnits = 123,
      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
            )
          )
        )
      ),
      ReplicaGlobalSecondaryIndexSettings = list(
        list(
          IndexName = "string",
          IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE",
          ProvisionedReadCapacityUnits = 123,
          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
                )
              )
            )
          ),
          ProvisionedWriteCapacityUnits = 123,
          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
                )
              )
            )
          )
        )
      ),
      ReplicaTableClassSummary = list(
        TableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS",
        LastUpdateDateTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax

svc$describe_global_table_settings(
  GlobalTableName = "string"
)