Skip to content
v2.273.0

FleetProps Struct ​

Construction properties of a CodeBuild Fleet.

Example ​

ts
import { Size } from 'aws-cdk-lib';

const fleet = new codebuild.Fleet(this, 'MyFleet', {
  baseCapacity: 1,
  computeType: codebuild.FleetComputeType.CUSTOM_INSTANCE_TYPE,
  environmentType: codebuild.EnvironmentType.LINUX_CONTAINER,
  computeConfiguration: {
    instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.MEDIUM),
    // By default, 64 GiB of disk space is included. Any value optionally
    // specified here is _incremental_ on top of the included disk space.
    disk: Size.gibibytes(10),
  },
});

Properties ​

baseCapacitynumberbase_capacityint | floatbaseCapacityNumberBaseCapacitydoubleBaseCapacity*float64required#
The number of machines allocated to the compute fleet. Defines the number of builds that can run in parallel.

Minimum value of 1.

computeConfigurationComputeConfigurationcompute_configurationComputeConfigurationcomputeConfigurationComputeConfigurationComputeConfigurationComputeConfigurationComputeConfigurationComputeConfiguration= do not specify compute configura…#
The compute configuration of the compute fleet.

This is only permitted if computeType is set to ATTRIBUTE_BASED or CUSTOM_INSTANCE_TYPE. In such cases, this is required.

default

Default: do not specify compute configuration

computeTypeFleetComputeTypecompute_typeFleetComputeTypecomputeTypeFleetComputeTypeComputeTypeFleetComputeTypeComputeTypeFleetComputeTyperequired#
The instance type of the compute fleet.
environmentTypeEnvironmentTypeenvironment_typeEnvironmentTypeenvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTyperequired#
The build environment (operating system/architecture/accelerator) type made available to projects using this fleet.
fleetNamestringfleet_namestrfleetNameStringFleetNamestringFleetName*string= CloudFormation generated name#
The name of the Fleet.
overflowBehaviorFleetOverflowBehavioroverflow_behaviorFleetOverflowBehavioroverflowBehaviorFleetOverflowBehaviorOverflowBehaviorFleetOverflowBehaviorOverflowBehaviorFleetOverflowBehavior= undefined - AWS CodeBuild defaul…#
The compute fleet overflow behavior.

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

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

default

Default: undefined - AWS CodeBuild default behavior is QUEUE

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= A role will be created if any pe…#
Service Role assumed by Fleet instances.

This Role is not used by Project builds running on Fleet instances; Project builds assume the role on Project instead.

default

Default: A role will be created if any permissions are granted

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= A security group will be automat…#
What security groups to associate with the fleet's network interfaces. If none are provided, one will be created automatically.

Only used if vpc is supplied.

default

Default: A security group will be automatically created.

subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= private subnets if available els…#
Where to place the network interfaces within the VPC.
notes · default

To access AWS services, your fleet needs to be in one of the following types of subnets:

  1. Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
  2. Private subnets unconnected to the internet, but with VPC endpoints for the necessary services.

If you don't specify a subnet selection, the default behavior is to use PRIVATE_WITH_EGRESS subnets first if they exist, then PRIVATE_WITHOUT_EGRESS, and finally PUBLIC subnets. If your VPC doesn't have PRIVATE_WITH_EGRESS subnets but you need AWS service access, add VPC Endpoints to your private subnets.

Default: private subnets if available else public subnets

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc= No VPC is specified.#
VPC network to place fleet instance network interfaces.

Specify this if the fleet needs to access resources in a VPC.

Used as props by ​