AWS::CodeBuild::Fleet - AWS CloudFormation (original) (raw)

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, ... ]
    }
}

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

ComputeConfiguration

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

Required: No

Type: ComputeConfiguration

Update requires: No interruption

ComputeType

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

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.

If you use BUILD_GENERAL1_SMALL:

If you use BUILD_GENERAL1_LARGE:

For more information, see On-demand environment 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 | ATTRIBUTE_BASED_COMPUTE

Update requires: No interruption

EnvironmentType

The environment type of the compute fleet.

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 | LINUX_EC2 | ARM_EC2 | WINDOWS_EC2

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.

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.