paws.compute (version 0.1.12)

ec2_modify_default_credit_specification: Modifies the default credit option for CPU usage of burstable performance instances

Description

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

modify_default_credit_specification is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call get_default_credit_specification and check DefaultCreditSpecification for updates.

For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

Usage

ec2_modify_default_credit_specification(DryRun, InstanceFamily,
  CpuCredits)

Value

A list with the following syntax:

list(
  InstanceFamilyCreditSpecification = list(
    InstanceFamily = "t2"|"t3"|"t3a"|"t4g",
    CpuCredits = "string"
  )
)

Arguments

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

InstanceFamily

[required] The instance family.

CpuCredits

[required] The credit option for CPU usage of the instance family.

Valid Values: standard | unlimited

Request syntax

svc$modify_default_credit_specification(
  DryRun = TRUE|FALSE,
  InstanceFamily = "t2"|"t3"|"t3a"|"t4g",
  CpuCredits = "string"
)