CfnFleetProps
- class aws_cdk.aws_codebuild.CfnFleetProps(*, base_capacity=None, compute_type=None, environment_type=None, fleet_service_role=None, fleet_vpc_config=None, image_id=None, name=None, overflow_behavior=None, tags=None)
Bases:
object
Properties for defining a
CfnFleet
.- Parameters:
base_capacity (
Union
[int
,float
,None
]) – The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.compute_type (
Optional
[str
]) – 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 useBUILD_GENERAL1_SMALL
: - For environment typeLINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. - For environment typeLINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment typeARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds. If you useBUILD_GENERAL1_LARGE
: - For environment typeLINUX_CONTAINER
, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment typeLINUX_GPU_CONTAINER
, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment typeARM_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.environment_type (
Optional
[str
]) –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 typeLINUX_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 typeLINUX_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 typeWINDOWS_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 typeWINDOWS_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 .fleet_service_role (
Optional
[str
]) – 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 .fleet_vpc_config (
Union
[IResolvable
,VpcConfigProperty
,Dict
[str
,Any
],None
]) – Information about the VPC configuration that AWS CodeBuild accesses.image_id (
Optional
[str
]) – The Amazon Machine Image (AMI) of the compute fleet.name (
Optional
[str
]) – The name of the compute fleet.overflow_behavior (
Optional
[str
]) – The compute fleet overflow behavior. - For overflow behaviorQUEUE
, your overflow builds need to wait on the existing fleet instance to become available. - For overflow behaviorON_DEMAND
, your overflow builds run on CodeBuild on-demand. .. epigraph:: 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 .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_codebuild as codebuild cfn_fleet_props = codebuild.CfnFleetProps( base_capacity=123, compute_type="computeType", environment_type="environmentType", fleet_service_role="fleetServiceRole", fleet_vpc_config=codebuild.CfnFleet.VpcConfigProperty( security_group_ids=["securityGroupIds"], subnets=["subnets"], vpc_id="vpcId" ), image_id="imageId", name="name", overflow_behavior="overflowBehavior", tags=[CfnTag( key="key", value="value" )] )
Attributes
- base_capacity
The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
- compute_type
.
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:
- Type:
Information about the compute resources the compute fleet uses. Available values include
- environment_type
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 .
- fleet_service_role
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 .
- fleet_vpc_config
Information about the VPC configuration that AWS CodeBuild accesses.
- image_id
The Amazon Machine Image (AMI) of the compute fleet.
- name
The name of the compute fleet.
- overflow_behavior
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 .
- 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.