Package software.amazon.awscdk.services.deadline

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.deadline.CfnFleet
All Implemented Interfaces:
IInspectable, ITaggableV2, IFleetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:34.854Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable, IFleetRef, ITaggableV2
Creates a fleet.

Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

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.deadline.*;
 CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
         .configuration(FleetConfigurationProperty.builder()
                 .customerManaged(CustomerManagedFleetConfigurationProperty.builder()
                         .mode("mode")
                         .workerCapabilities(CustomerManagedWorkerCapabilitiesProperty.builder()
                                 .cpuArchitectureType("cpuArchitectureType")
                                 .memoryMiB(MemoryMiBRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 .osFamily("osFamily")
                                 .vCpuCount(VCpuCountRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 // the properties below are optional
                                 .acceleratorCount(AcceleratorCountRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 .acceleratorTypes(List.of("acceleratorTypes"))
                                 .customAmounts(List.of(FleetAmountCapabilityProperty.builder()
                                         .min(123)
                                         .name("name")
                                         // the properties below are optional
                                         .max(123)
                                         .build()))
                                 .customAttributes(List.of(FleetAttributeCapabilityProperty.builder()
                                         .name("name")
                                         .values(List.of("values"))
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .storageProfileId("storageProfileId")
                         .tagPropagationMode("tagPropagationMode")
                         .build())
                 .serviceManagedEc2(ServiceManagedEc2FleetConfigurationProperty.builder()
                         .instanceCapabilities(ServiceManagedEc2InstanceCapabilitiesProperty.builder()
                                 .cpuArchitectureType("cpuArchitectureType")
                                 .memoryMiB(MemoryMiBRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 .osFamily("osFamily")
                                 .vCpuCount(VCpuCountRangeProperty.builder()
                                         .min(123)
                                         // the properties below are optional
                                         .max(123)
                                         .build())
                                 // the properties below are optional
                                 .acceleratorCapabilities(AcceleratorCapabilitiesProperty.builder()
                                         .selections(List.of(AcceleratorSelectionProperty.builder()
                                                 .name("name")
                                                 // the properties below are optional
                                                 .runtime("runtime")
                                                 .build()))
                                         // the properties below are optional
                                         .count(AcceleratorCountRangeProperty.builder()
                                                 .min(123)
                                                 // the properties below are optional
                                                 .max(123)
                                                 .build())
                                         .build())
                                 .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                                 .customAmounts(List.of(FleetAmountCapabilityProperty.builder()
                                         .min(123)
                                         .name("name")
                                         // the properties below are optional
                                         .max(123)
                                         .build()))
                                 .customAttributes(List.of(FleetAttributeCapabilityProperty.builder()
                                         .name("name")
                                         .values(List.of("values"))
                                         .build()))
                                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                                 .rootEbsVolume(Ec2EbsVolumeProperty.builder()
                                         .iops(123)
                                         .sizeGiB(123)
                                         .throughputMiB(123)
                                         .build())
                                 .build())
                         .instanceMarketOptions(ServiceManagedEc2InstanceMarketOptionsProperty.builder()
                                 .type("type")
                                 .build())
                         // the properties below are optional
                         .storageProfileId("storageProfileId")
                         .vpcConfiguration(VpcConfigurationProperty.builder()
                                 .resourceConfigurationArns(List.of("resourceConfigurationArns"))
                                 .build())
                         .build())
                 .build())
         .displayName("displayName")
         .farmId("farmId")
         .maxWorkerCount(123)
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .hostConfiguration(HostConfigurationProperty.builder()
                 .scriptBody("scriptBody")
                 // the properties below are optional
                 .scriptTimeoutSeconds(123)
                 .build())
         .minWorkerCount(123)
         .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, @NotNull 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. 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 Amazon Resource Name (ARN) assigned to the fleet.

    • getAttrCapabilities

      @Stability(Stable) @NotNull public IResolvable getAttrCapabilities()

    • getAttrFleetId

      @Stability(Stable) @NotNull public String getAttrFleetId()
      The fleet ID.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the fleet.

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()
      A message that communicates a suspended status of the fleet.

    • getAttrWorkerCount

      @Stability(Stable) @NotNull public Number getAttrWorkerCount()
      The number of workers in the fleet summary.

    • 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

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      The configuration details for the fleet.

      Returns union: either IResolvable or CfnFleet.FleetConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      The configuration details for the fleet.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnFleet.FleetConfigurationProperty value)
      The configuration details for the fleet.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the fleet summary to update.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The display name of the fleet summary to update.

    • getFarmId

      @Stability(Stable) @NotNull public String getFarmId()
      The farm ID.

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The farm ID.

    • getMaxWorkerCount

      @Stability(Stable) @NotNull public Number getMaxWorkerCount()
      The maximum number of workers specified in the fleet.

    • setMaxWorkerCount

      @Stability(Stable) public void setMaxWorkerCount(@NotNull Number value)
      The maximum number of workers specified in the fleet.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The IAM role that workers in the fleet use when processing jobs.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The IAM role that workers in the fleet use when processing jobs.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description that helps identify what the fleet is used for.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description that helps identify what the fleet is used for.

    • getHostConfiguration

      @Stability(Stable) @Nullable public Object getHostConfiguration()
      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

      Returns union: either IResolvable or CfnFleet.HostConfigurationProperty

    • setHostConfiguration

      @Stability(Stable) public void setHostConfiguration(@Nullable IResolvable value)
      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

    • setHostConfiguration

      @Stability(Stable) public void setHostConfiguration(@Nullable CfnFleet.HostConfigurationProperty value)
      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

    • getMinWorkerCount

      @Stability(Stable) @Nullable public Number getMinWorkerCount()
      The minimum number of workers in the fleet.

    • setMinWorkerCount

      @Stability(Stable) public void setMinWorkerCount(@Nullable Number value)
      The minimum number of workers in the fleet.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to your fleet.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to your fleet.