AWS::CodeBuild::Fleet

The AWS::CodeBuild::Fleet resource configures a compute fleet, a set of dedicated instances for your build environment.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::CodeBuild::Fleet",
  "Properties" : {
      "BaseCapacity" : Integer,
      "ComputeConfiguration" : ComputeConfiguration,
      "ComputeType" : String,
      "EnvironmentType" : String,
      "FleetProxyConfiguration" : ProxyConfiguration,
      "FleetServiceRole" : String,
      "FleetVpcConfig" : VpcConfig,
      "ImageId" : String,
      "Name" : String,
      "OverflowBehavior" : String,
      "ScalingConfiguration" : ScalingConfigurationInput,
      "Tags" : [ Tag, ... ]
    }
}

YAML


Type: AWS::CodeBuild::Fleet
Properties:
  BaseCapacity: Integer
  ComputeConfiguration: 
    ComputeConfiguration
  ComputeType: String
  EnvironmentType: String
  FleetProxyConfiguration: 
    ProxyConfiguration
  FleetServiceRole: String
  FleetVpcConfig: 
    VpcConfig
  ImageId: String
  Name: String
  OverflowBehavior: String
  ScalingConfiguration: 
    ScalingConfigurationInput
  Tags: 
    - Tag

Properties

BaseCapacity

The initial number of machines allocated to the compute ﬂeet, which deﬁnes the number of builds that can run in parallel.

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

ComputeConfiguration

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

Required: No

Type: ComputeConfiguration

Update requires: No interruption

ComputeType

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

ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

Note
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB 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 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the AWS CodeBuild User Guide.

Required: No

Type: String

Update requires: No interruption

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 ARM_EC2 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_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_EC2 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 MAC_ARM is available only in regions US East (Ohio), US East (N. Virginia), US West (Oregon), Europe (Frankfurt), and Asia Pacific (Sydney).
The environment type WINDOWS_EC2 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 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.

Required: No

Type: String

Update requires: No interruption

FleetProxyConfiguration

Information about the proxy configurations that apply network access control to your reserved capacity instances.

Required: No

Type: ProxyConfiguration

Update requires: No interruption

FleetServiceRole

The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the AWS CodeBuild User Guide.

Required: No

Type: String

Pattern: ^(?:arn:)[a-zA-Z+-=,._:/@]+$

Update requires: No interruption

FleetVpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

Required: No

Type: VpcConfig

Update requires: No interruption

ImageId

The Amazon Machine Image (AMI) of the compute fleet.

Required: No

Type: String

Pattern: ^((aws/codebuild/[A-Za-z-]+:[0-9]+(-[0-9._]+)?)|ami-[a-z0-9]{1,1020})$

Update requires: No interruption

Name

The name of the compute fleet.

Required: No

Type: String

Minimum: 2

Maximum: 128

Update requires: No interruption

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.

Note
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to AWS services required to create a VPC network interface.

Required: No

Type: String

Allowed values: QUEUE | ON_DEMAND

Update requires: No interruption

ScalingConfiguration

The scaling configuration of the compute fleet.

Required: No

Type: ScalingConfigurationInput

Update requires: No interruption

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 compute fleet tags.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the AWS CodeBuild compute fleet.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn: The ARN of the compute fleet.

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS CodeBuild

ComputeConfiguration

AWS::CodeBuild::Fleet

Syntax

JSON

YAML

Properties

Note

Note

Return values

Ref

Fn::GetAtt