EC2 / Client / modify_default_credit_specification

modify_default_credit_specification#

EC2.Client.modify_default_credit_specification(**kwargs)#

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

ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services 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 GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_default_credit_specification(
    DryRun=True|False,
    InstanceFamily='t2'|'t3'|'t3a'|'t4g',
    CpuCredits='string'
)
Parameters:

  • DryRun (boolean) – Checks whether you have the required permissions for the operation, 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 (string) –

    [REQUIRED]

    The instance family.

  • CpuCredits (string) –

    [REQUIRED]

    The credit option for CPU usage of the instance family.

    Valid Values: standard | unlimited

Return type:

dict

Returns:

Response Syntax

{
    'InstanceFamilyCreditSpecification': {
        'InstanceFamily': 't2'|'t3'|'t3a'|'t4g',
        'CpuCredits': 'string'
    }
}

Response Structure

  • (dict) –

    • InstanceFamilyCreditSpecification (dict) –

      The default credit option for CPU usage of the instance family.

      • InstanceFamily (string) –

        The instance family.

      • CpuCredits (string) –

        The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.