CfnFleetProps Struct

Properties for defining a CfnFleet.

Source: Generated code
Type last changed: v2.168.0 · 20 Nov 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnFleetProps: codebuild.CfnFleetProps = {
  baseCapacity: 123,
  computeConfiguration: {
    disk: 123,
    instanceType: 'instanceType',
    machineType: 'machineType',
    memory: 123,
    vCpu: 123,
  },
  computeType: 'computeType',
  environmentType: 'environmentType',
  fleetProxyConfiguration: {
    defaultBehavior: 'defaultBehavior',
    orderedProxyRules: [{
      effect: 'effect',
      entities: ['entities'],
      type: 'type',
    }],
  },
  fleetServiceRole: 'fleetServiceRole',
  fleetVpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
    vpcId: 'vpcId',
  },
  imageId: 'imageId',
  name: 'name',
  overflowBehavior: 'overflowBehavior',
  scalingConfiguration: {
    maxCapacity: 123,
    scalingType: 'scalingType',
    targetTrackingScalingConfigs: [{
      metricType: 'metricType',
      targetValue: 123,
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

baseCapacitynumberbase_capacityint | floatbaseCapacityNumberBaseCapacitydoubleBaseCapacity*float64#

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

computeConfigurationIResolvable | CfnFleet.ComputeConfigurationPropertycompute_configurationtyping.Union[IResolvable, ComputeConfigurationProperty]computeConfigurationIResolvableComputeConfigurationIResolvableComputeConfigurationinterface{}#

The compute configuration of the compute fleet.

This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE .

computeTypestringcompute_typestrcomputeTypeStringComputeTypestringComputeType*string#

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

notes

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

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.

environmentTypestringenvironment_typestrenvironmentTypeStringEnvironmentTypestringEnvironmentType*string#

The environment type of the compute fleet.

notes

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 .

fleetProxyConfigurationIResolvable | CfnFleet.ProxyConfigurationPropertyfleet_proxy_configurationtyping.Union[IResolvable, ProxyConfigurationProperty]fleetProxyConfigurationIResolvableFleetProxyConfigurationIResolvableFleetProxyConfigurationinterface{}#

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

fleetServiceRolestringfleet_service_rolestrfleetServiceRoleStringFleetServiceRolestringFleetServiceRole*string#

The service role associated with the compute fleet.

notes

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

fleetVpcConfigIResolvable | CfnFleet.VpcConfigPropertyfleet_vpc_configtyping.Union[IResolvable, VpcConfigProperty]fleetVpcConfigIResolvableFleetVpcConfigIResolvableFleetVpcConfiginterface{}#

Information about the VPC configuration that AWS CodeBuild accesses.

imageIdstringimage_idstrimageIdStringImageIdstringImageId*string#

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

namestringnamestrnameStringNamestringName*string#

The name of the compute fleet.

overflowBehaviorstringoverflow_behaviorstroverflowBehaviorStringOverflowBehaviorstringOverflowBehavior*string#

The compute fleet overflow behavior.

notes

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.

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 .

scalingConfigurationIResolvable | CfnFleet.ScalingConfigurationInputPropertyscaling_configurationtyping.Union[IResolvable, ScalingConfigurationInputProperty]scalingConfigurationIResolvableScalingConfigurationIResolvableScalingConfigurationinterface{}#

The scaling configuration of the compute fleet.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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.

CfnFleetProps Struct ​

Example ​

Properties ​

CfnFleetProps Struct

Example

Properties