AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lambda ]

update-capacity-provider

Description

Updates the configuration of an existing capacity provider.

See also: AWS API Documentation

Synopsis

  update-capacity-provider
--capacity-provider-name <value>
[--capacity-provider-scaling-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--capacity-provider-name (string)

The name of the capacity provider to update.

--capacity-provider-scaling-config (structure)

The updated scaling configuration for the capacity provider.

MaxVCpuCount -> (integer)

The maximum number of vCPUs that the capacity provider can provision across all compute instances.

ScalingMode -> (string)

The scaling mode that determines how the capacity provider responds to changes in demand.

ScalingPolicies -> (list)

A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.

(structure)

A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

PredefinedMetricType -> (string)

The predefined metric type to track for scaling decisions.

TargetValue -> (double)

The target value for the metric that the scaling policy attempts to maintain through scaling actions.

Shorthand Syntax:

MaxVCpuCount=integer,ScalingMode=string,ScalingPolicies=[{PredefinedMetricType=string,TargetValue=double},{PredefinedMetricType=string,TargetValue=double}]

JSON Syntax:

{
  "MaxVCpuCount": integer,
  "ScalingMode": "Auto"|"Manual",
  "ScalingPolicies": [
    {
      "PredefinedMetricType": "LambdaCapacityProviderAverageCPUUtilization",
      "TargetValue": double
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

CapacityProvider -> (structure)

Information about the updated capacity provider.

CapacityProviderArn -> (string)

The Amazon Resource Name (ARN) of the capacity provider.

State -> (string)

The current state of the capacity provider.

VpcConfig -> (structure)

The VPC configuration for the capacity provider.

SubnetIds -> (list)

A list of subnet IDs where the capacity provider launches compute instances.

(string)

SecurityGroupIds -> (list)

A list of security group IDs that control network access for compute instances managed by the capacity provider.

(string)

PermissionsConfig -> (structure)

The permissions configuration for the capacity provider.

CapacityProviderOperatorRoleArn -> (string)

The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.

InstanceRequirements -> (structure)

The instance requirements for compute resources managed by the capacity provider.

Architectures -> (list)

A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64 .

(string)

AllowedInstanceTypes -> (list)

A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.

(string)

ExcludedInstanceTypes -> (list)

A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

(string)

CapacityProviderScalingConfig -> (structure)

The scaling configuration for the capacity provider.

MaxVCpuCount -> (integer)

The maximum number of vCPUs that the capacity provider can provision across all compute instances.

ScalingMode -> (string)

The scaling mode that determines how the capacity provider responds to changes in demand.

ScalingPolicies -> (list)

A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.

(structure)

A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

PredefinedMetricType -> (string)

The predefined metric type to track for scaling decisions.

TargetValue -> (double)

The target value for the metric that the scaling policy attempts to maintain through scaling actions.

KmsKeyArn -> (string)

The ARN of the KMS key used to encrypt the capacity provider’s resources.

LastModified -> (string)

The date and time when the capacity provider was last modified.