Package software.amazon.awscdk.services.codebuild

Class CfnFleet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codebuild.CfnFleet
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IFleetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:36.585Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable, IFleetRef, ITaggableV2
The AWS::CodeBuild::Fleet resource configures a compute fleet, a set of dedicated instances for your build environment.

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.*;
 CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
         .baseCapacity(123)
         .computeConfiguration(ComputeConfigurationProperty.builder()
                 .disk(123)
                 .instanceType("instanceType")
                 .machineType("machineType")
                 .memory(123)
                 .vCpu(123)
                 .build())
         .computeType("computeType")
         .environmentType("environmentType")
         .fleetProxyConfiguration(ProxyConfigurationProperty.builder()
                 .defaultBehavior("defaultBehavior")
                 .orderedProxyRules(List.of(FleetProxyRuleProperty.builder()
                         .effect("effect")
                         .entities(List.of("entities"))
                         .type("type")
                         .build()))
                 .build())
         .fleetServiceRole("fleetServiceRole")
         .fleetVpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .vpcId("vpcId")
                 .build())
         .imageId("imageId")
         .name("name")
         .overflowBehavior("overflowBehavior")
         .scalingConfiguration(ScalingConfigurationInputProperty.builder()
                 .maxCapacity(123)
                 .scalingType("scalingType")
                 .targetTrackingScalingConfigs(List.of(TargetTrackingScalingConfigurationProperty.builder()
                         .metricType("metricType")
                         .targetValue(123)
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFleet

      @Stability(Stable) public CfnFleet(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnFleetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnFleet

      @Stability(Stable) public CfnFleet(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the compute fleet.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFleetRef

      @Stability(Stable) @NotNull public FleetReference getFleetRef()
      A reference to a Fleet resource.
      Specified by:
      getFleetRef in interface IFleetRef

    • getBaseCapacity

      @Stability(Stable) @Nullable public Number getBaseCapacity()
      The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

    • setBaseCapacity

      @Stability(Stable) public void setBaseCapacity(@Nullable Number value)
      The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

    • getComputeConfiguration

      @Stability(Stable) @Nullable public Object getComputeConfiguration()
      The compute configuration of the compute fleet.

      Returns union: either IResolvable or CfnFleet.ComputeConfigurationProperty

    • setComputeConfiguration

      @Stability(Stable) public void setComputeConfiguration(@Nullable IResolvable value)
      The compute configuration of the compute fleet.

    • setComputeConfiguration

      @Stability(Stable) public void setComputeConfiguration(@Nullable CfnFleet.ComputeConfigurationProperty value)
      The compute configuration of the compute fleet.

    • getComputeType

      @Stability(Stable) @Nullable public String getComputeType()
      Information about the compute resources the compute fleet uses.

      Available values include:.

    • setComputeType

      @Stability(Stable) public void setComputeType(@Nullable String value)
      Information about the compute resources the compute fleet uses.

      Available values include:.

    • getEnvironmentType

      @Stability(Stable) @Nullable public String getEnvironmentType()
      The environment type of the compute fleet.

    • setEnvironmentType

      @Stability(Stable) public void setEnvironmentType(@Nullable String value)
      The environment type of the compute fleet.

    • getFleetProxyConfiguration

      @Stability(Stable) @Nullable public Object getFleetProxyConfiguration()
      Information about the proxy configurations that apply network access control to your reserved capacity instances.

      Returns union: either IResolvable or CfnFleet.ProxyConfigurationProperty

    • setFleetProxyConfiguration

      @Stability(Stable) public void setFleetProxyConfiguration(@Nullable IResolvable value)
      Information about the proxy configurations that apply network access control to your reserved capacity instances.

    • setFleetProxyConfiguration

      @Stability(Stable) public void setFleetProxyConfiguration(@Nullable CfnFleet.ProxyConfigurationProperty value)
      Information about the proxy configurations that apply network access control to your reserved capacity instances.

    • getFleetServiceRole

      @Stability(Stable) @Nullable public String getFleetServiceRole()
      The service role associated with the compute fleet.

    • setFleetServiceRole

      @Stability(Stable) public void setFleetServiceRole(@Nullable String value)
      The service role associated with the compute fleet.

    • getFleetVpcConfig

      @Stability(Stable) @Nullable public Object getFleetVpcConfig()
      Information about the VPC configuration that AWS CodeBuild accesses.

      Returns union: either IResolvable or CfnFleet.VpcConfigProperty

    • setFleetVpcConfig

      @Stability(Stable) public void setFleetVpcConfig(@Nullable IResolvable value)
      Information about the VPC configuration that AWS CodeBuild accesses.

    • setFleetVpcConfig

      @Stability(Stable) public void setFleetVpcConfig(@Nullable CfnFleet.VpcConfigProperty value)
      Information about the VPC configuration that AWS CodeBuild accesses.

    • getImageId

      @Stability(Stable) @Nullable public String getImageId()
      The Amazon Machine Image (AMI) of the compute fleet.

    • setImageId

      @Stability(Stable) public void setImageId(@Nullable String value)
      The Amazon Machine Image (AMI) of the compute fleet.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the compute fleet.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the compute fleet.

    • getOverflowBehavior

      @Stability(Stable) @Nullable public String getOverflowBehavior()
      The compute fleet overflow behavior.

    • setOverflowBehavior

      @Stability(Stable) public void setOverflowBehavior(@Nullable String value)
      The compute fleet overflow behavior.

    • getScalingConfiguration

      @Stability(Stable) @Nullable public Object getScalingConfiguration()
      The scaling configuration of the compute fleet.

      Returns union: either IResolvable or CfnFleet.ScalingConfigurationInputProperty

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable IResolvable value)
      The scaling configuration of the compute fleet.

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable CfnFleet.ScalingConfigurationInputProperty value)
      The scaling configuration of the compute fleet.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tag key and value pairs associated with this compute fleet.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tag key and value pairs associated with this compute fleet.