AWS::CodeBuild::Fleet - AWS CloudFormation
SyntaxPropertiesReturn values

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,
      "ComputeType" : String,
      "EnvironmentType" : String,
      "FleetServiceRole" : String,
      "FleetVpcConfig" : VpcConfig,
      "ImageId" : String,
      "Name" : String,
      "OverflowBehavior" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

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

Properties

BaseCapacity

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

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE

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 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.

Required: No

Type: String

Allowed values: WINDOWS_SERVER_2019_CONTAINER | WINDOWS_SERVER_2022_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER | MAC_ARM

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.

Required: No

Type: String

Allowed values: QUEUE | ON_DEMAND

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.