Fleet

class aws_cdk.aws_codebuild.Fleet(scope, id, *, base_capacity, compute_type, environment_type, fleet_name=None)

Bases: Resource

Fleet for a reserved capacity CodeBuild project.

Fleets allow for process builds or tests to run immediately and reduces build durations, by reserving compute resources for your projects.

You will be charged for the resources in the fleet, even if they are idle.

See:: https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html
ExampleMetadata:: infused

Example:

fleet = codebuild.Fleet(self, "Fleet",
    compute_type=codebuild.FleetComputeType.MEDIUM,
    environment_type=codebuild.EnvironmentType.LINUX_CONTAINER,
    base_capacity=1
)

codebuild.Project(self, "Project",
    environment=codebuild.BuildEnvironment(
        fleet=fleet,
        build_image=codebuild.LinuxBuildImage.STANDARD_7_0
    )
)

Parameters:

scope (Construct) –
id (str) –
base_capacity (Union[int, float]) – The number of machines allocated to the compute ﬂeet. Deﬁnes the number of builds that can run in parallel. Minimum value of 1.
compute_type (FleetComputeType) – The instance type of the compute fleet.
environment_type (EnvironmentType) – The build environment (operating system/architecture/accelerator) type made available to projects using this fleet.
fleet_name (Optional[str]) – The name of the Fleet. Default: - CloudFormation generated name

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

compute_type

The compute type of the fleet.

See:: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.ComputeType.html

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

environment_type: The build environment (operating system/architecture/accelerator) type made available to projects using this fleet.

fleet_arn: The ARN of the fleet.

fleet_name: The name of the fleet.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_fleet_arn(scope, id, fleet_arn)

Creates a Fleet construct that represents an external fleet.

Parameters:

scope (Construct) – The scope creating construct (usually this).
id (str) – The construct’s id.
fleet_arn (str) – The ARN of the fleet.

Return type:

IFleet

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool