UpdateFleet - AWS CodeBuild

UpdateFleet

Updates a compute fleet.

Request Syntax

{ "arn": "string", "baseCapacity": number, "computeType": "string", "environmentType": "string", "overflowBehavior": "string", "scalingConfiguration": { "maxCapacity": number, "scalingType": "string", "targetTrackingScalingConfigs": [ { "metricType": "string", "targetValue": number } ] }, "tags": [ { "key": "string", "value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

arn

The ARN of the compute fleet.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

baseCapacity

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

computeType

Information about the compute resources the compute fleet uses. Available values include:

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.

  • BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.

  • BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_SMALL:

  • For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.

  • For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.

  • For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

  • For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

  • For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

  • For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see Build environment compute types in the AWS CodeBuild User Guide.

Type: String

Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB

Required: No

environmentType

The environment type of the compute fleet.

  • The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).

  • The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

  • The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).

  • The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).

  • The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the AWS CodeBuild user guide.

Type: String

Valid Values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER | WINDOWS_SERVER_2019_CONTAINER | LINUX_LAMBDA_CONTAINER | ARM_LAMBDA_CONTAINER

Required: No

overflowBehavior

The compute fleet overflow behavior.

  • For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.

  • For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.

Type: String

Valid Values: QUEUE | ON_DEMAND

Required: No

scalingConfiguration

The scaling configuration of the compute fleet.

Type: ScalingConfigurationInput object

Required: No

tags

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{ "fleet": { "arn": "string", "baseCapacity": number, "computeType": "string", "created": number, "environmentType": "string", "id": "string", "lastModified": number, "name": "string", "overflowBehavior": "string", "scalingConfiguration": { "desiredCapacity": number, "maxCapacity": number, "scalingType": "string", "targetTrackingScalingConfigs": [ { "metricType": "string", "targetValue": number } ] }, "status": { "context": "string", "message": "string", "statusCode": "string" }, "tags": [ { "key": "string", "value": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

fleet

A Fleet object.

Type: Fleet object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountLimitExceededException

An AWS service limit was exceeded for the calling AWS account.

HTTP Status Code: 400

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: