Package software.amazon.awscdk.services.codebuild

Interface CfnFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.840Z")
@Stability(Stable)
public interface CfnFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFleet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 CfnFleetProps cfnFleetProps = CfnFleetProps.builder()
         .baseCapacity(123)
         .computeType("computeType")
         .environmentType("environmentType")
         .fleetServiceRole("fleetServiceRole")
         .fleetVpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .vpcId("vpcId")
                 .build())
         .imageId("imageId")
         .name("name")
         .overflowBehavior("overflowBehavior")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleetProps.Builder	A builder for CfnFleetProps
static final class	CfnFleetProps.Jsii$Proxy	An implementation for CfnFleetProps

Method Summary

Modifier and Type	Method	Description
static CfnFleetProps.Builder	builder()
default Number	getBaseCapacity()	The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
default String	getComputeType()	Information about the compute resources the compute fleet uses.
default String	getEnvironmentType()	The environment type of the compute fleet.
default String	getFleetServiceRole()	The service role associated with the compute fleet.
default Object	getFleetVpcConfig()	Information about the VPC configuration that AWS CodeBuild accesses.
default String	getImageId()	The Amazon Machine Image (AMI) of the compute fleet.
default String	getName()	The name of the compute fleet.
default String	getOverflowBehavior()	The compute fleet overflow behavior.
default List<CfnTag>	getTags()	A list of tag key and value pairs associated with this compute fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBaseCapacity

@Stability(Stable)
@Nullable
default Number getBaseCapacity()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-basecapacity

getComputeType

@Stability(Stable)
@Nullable
default String getComputeType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-computetype

getEnvironmentType

@Stability(Stable)
@Nullable
default String getEnvironmentType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-environmenttype

getFleetServiceRole

@Stability(Stable)
@Nullable
default String getFleetServiceRole()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-fleetservicerole

getFleetVpcConfig

@Stability(Stable)
@Nullable
default Object getFleetVpcConfig()

Information about the VPC configuration that AWS CodeBuild accesses.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-fleetvpcconfig

getImageId

@Stability(Stable)
@Nullable
default String getImageId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-imageid

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the compute fleet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-name

getOverflowBehavior

@Stability(Stable)
@Nullable
default String getOverflowBehavior()

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.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-overflowbehavior

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-tags

builder

@Stability(Stable)
static CfnFleetProps.Builder builder()

Returns:

a CfnFleetProps.Builder of CfnFleetProps