paws.database (version 0.1.12)

dynamodb_describe_global_table_settings: Describes Region-specific settings for a global table

Description

Describes Region-specific settings for a global table.

This operation only applies to Version 2017.11.29 of global tables.

Usage

dynamodb_describe_global_table_settings(GlobalTableName)

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

Arguments

GlobalTableName

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

Request syntax

svc$describe_global_table_settings(
  GlobalTableName = "string"
)