Fleet L2 construct
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.
Example
const fleet = new codebuild.Fleet(this, 'Fleet', {
computeType: codebuild.FleetComputeType.MEDIUM,
environmentType: codebuild.EnvironmentType.LINUX_CONTAINER,
baseCapacity: 1,
});
new codebuild.Project(this, 'Project', {
environment: {
fleet,
buildImage: codebuild.LinuxBuildImage.STANDARD_7_0,
},
// ...
})
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
)
)
Fleet fleet = Fleet.Builder.create(this, "Fleet")
.computeType(FleetComputeType.MEDIUM)
.environmentType(EnvironmentType.LINUX_CONTAINER)
.baseCapacity(1)
.build();
Project.Builder.create(this, "Project")
.environment(BuildEnvironment.builder()
.fleet(fleet)
.buildImage(LinuxBuildImage.STANDARD_7_0)
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
var fleet = new Fleet(this, "Fleet", new FleetProps {
ComputeType = FleetComputeType.MEDIUM,
EnvironmentType = EnvironmentType.LINUX_CONTAINER,
BaseCapacity = 1
});
new Project(this, "Project", new ProjectProps {
Environment = new BuildEnvironment {
Fleet = fleet,
BuildImage = LinuxBuildImage.STANDARD_7_0
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
fleet := codebuild.NewFleet(this, jsii.String("Fleet"), &FleetProps{
ComputeType: codebuild.FleetComputeType_MEDIUM,
EnvironmentType: codebuild.EnvironmentType_LINUX_CONTAINER,
BaseCapacity: jsii.Number(1),
})
codebuild.NewProject(this, jsii.String("Project"), &ProjectProps{
Environment: &BuildEnvironment{
Fleet: *Fleet,
BuildImage: codebuild.LinuxBuildImage_STANDARD_7_0(),
},
})
Initializer
new Fleet(scope: Construct, id: string, props: FleetProps)
Fleet(scope: Construct, id: str, props: FleetProps)
new Fleet(Construct scope, String id, FleetProps props)
new Fleet(Construct scope, string id, FleetProps props)
NewFleet(Scope Construct, Id *string, Props FleetProps)
Construct Props
baseCapacitynumberbase_capacityint | floatbaseCapacityNumberBaseCapacitydoubleBaseCapacity*float64required#Minimum value of 1.
computeConfigurationComputeConfigurationcompute_configurationComputeConfigurationcomputeConfigurationComputeConfigurationComputeConfigurationComputeConfigurationComputeConfigurationComputeConfiguration= do not specify compute configura…#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#environmentTypeEnvironmentTypeenvironment_typeEnvironmentTypeenvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTyperequired#fleetNamestringfleet_namestrfleetNameStringFleetNamestringFleetName*string= CloudFormation generated name#overflowBehaviorFleetOverflowBehavioroverflow_behaviorFleetOverflowBehavioroverflowBehaviorFleetOverflowBehaviorOverflowBehaviorFleetOverflowBehaviorOverflowBehaviorFleetOverflowBehavior= undefined - AWS CodeBuild defaul…#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
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…#Only used if vpc is supplied.
default
Default: A security group will be automatically created.
subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= private subnets if available els…#notes · default
To access AWS services, your fleet needs to be in one of the following types of subnets:
- Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
- 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
Properties
computeTypeFleetComputeTypecompute_typeFleetComputeTypecomputeTypeFleetComputeTypeComputeTypeFleetComputeTypeComputeTypeFleetComputeTyperequired#connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
environmentTypeEnvironmentTypeenvironment_typeEnvironmentTypeenvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTypeEnvironmentTyperequired#fleetRefFleetReferencefleet_refFleetReferencefleetRefFleetReferenceFleetRefFleetReferenceFleetRefFleetReferencerequired#grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromFleetArn(scope: Construct, id: string, fleetArn: string): IFleet@staticmethod def from_fleet_arn(scope: Construct, id: str, fleet_arn: str) -> IFleetpublic static IFleet fromFleetArn(Construct scope, String id, String fleetArn)public static IFleet FromFleetArn(Construct scope, string id, string fleetArn)func FromFleetArn(Scope Construct, Id *string, FleetArn *string) IFleetstatic#3 parameters
Parameters
scopescopescopescopeScope— The scope creating construct (usuallythis).ididididId— The construct's id.fleetArnfleet_arnfleetArnfleetArnFleetArn— The ARN of the fleet.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.