paws.database (version 0.1.12)

dynamodb_update_global_table_settings: Updates settings for a global table

Description

Updates settings for a global table.

Usage

dynamodb_update_global_table_settings(GlobalTableName,
  GlobalTableBillingMode, GlobalTableProvisionedWriteCapacityUnits,
  GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate,
  GlobalTableGlobalSecondaryIndexSettingsUpdate, ReplicaSettingsUpdate)

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

GlobalTableBillingMode

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

• PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

GlobalTableProvisionedWriteCapacityUnits

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

GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

Auto scaling settings for managing provisioned write capacity for the global table.

GlobalTableGlobalSecondaryIndexSettingsUpdate

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

ReplicaSettingsUpdate

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

Request syntax

svc$update_global_table_settings(
  GlobalTableName = "string",
  GlobalTableBillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
  GlobalTableProvisionedWriteCapacityUnits = 123,
  GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate = list(
    MinimumUnits = 123,
    MaximumUnits = 123,
    AutoScalingDisabled = TRUE|FALSE,
    AutoScalingRoleArn = "string",
    ScalingPolicyUpdate = list(
      PolicyName = "string",
      TargetTrackingScalingPolicyConfiguration = list(
        DisableScaleIn = TRUE|FALSE,
        ScaleInCooldown = 123,
        ScaleOutCooldown = 123,
        TargetValue = 123.0
      )
    )
  ),
  GlobalTableGlobalSecondaryIndexSettingsUpdate = list(
    list(
      IndexName = "string",
      ProvisionedWriteCapacityUnits = 123,
      ProvisionedWriteCapacityAutoScalingSettingsUpdate = list(
        MinimumUnits = 123,
        MaximumUnits = 123,
        AutoScalingDisabled = TRUE|FALSE,
        AutoScalingRoleArn = "string",
        ScalingPolicyUpdate = list(
          PolicyName = "string",
          TargetTrackingScalingPolicyConfiguration = list(
            DisableScaleIn = TRUE|FALSE,
            ScaleInCooldown = 123,
            ScaleOutCooldown = 123,
            TargetValue = 123.0
          )
        )
      )
    )
  ),
  ReplicaSettingsUpdate = list(
    list(
      RegionName = "string",
      ReplicaProvisionedReadCapacityUnits = 123,
      ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate = list(
        MinimumUnits = 123,
        MaximumUnits = 123,
        AutoScalingDisabled = TRUE|FALSE,
        AutoScalingRoleArn = "string",
        ScalingPolicyUpdate = list(
          PolicyName = "string",
          TargetTrackingScalingPolicyConfiguration = list(
            DisableScaleIn = TRUE|FALSE,
            ScaleInCooldown = 123,
            ScaleOutCooldown = 123,
            TargetValue = 123.0
          )
        )
      ),
      ReplicaGlobalSecondaryIndexSettingsUpdate = list(
        list(
          IndexName = "string",
          ProvisionedReadCapacityUnits = 123,
          ProvisionedReadCapacityAutoScalingSettingsUpdate = list(
            MinimumUnits = 123,
            MaximumUnits = 123,
            AutoScalingDisabled = TRUE|FALSE,
            AutoScalingRoleArn = "string",
            ScalingPolicyUpdate = list(
              PolicyName = "string",
              TargetTrackingScalingPolicyConfiguration = list(
                DisableScaleIn = TRUE|FALSE,
                ScaleInCooldown = 123,
                ScaleOutCooldown = 123,
                TargetValue = 123.0
              )
            )
          )
        )
      )
    )
  )
)