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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-04T00:39:30.385Z")
@Stability(Stable)
public class CfnFleet
extends CfnResource
implements IInspectable, 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")
                         .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
                                 .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())
                         .build())
                 .build())
         .displayName("displayName")
         .farmId("farmId")
         .maxWorkerCount(123)
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .minWorkerCount(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnFleet.AcceleratorCountRangeProperty	The range for the GPU fleet acceleration.
static interface	CfnFleet.AcceleratorTotalMemoryMiBRangeProperty	The range for memory, in MiB, to use for the accelerator.
static final class	CfnFleet.Builder	A fluent builder for CfnFleet.
static interface	CfnFleet.CustomerManagedFleetConfigurationProperty	The details of a customer managed fleet configuration.
static interface	CfnFleet.CustomerManagedWorkerCapabilitiesProperty	The worker capabilities for a customer managed workflow.
static interface	CfnFleet.Ec2EbsVolumeProperty	Specifies the EBS volume.
static interface	CfnFleet.FleetAmountCapabilityProperty	The fleet amount and attribute capabilities.
static interface	CfnFleet.FleetAttributeCapabilityProperty	Defines the fleet's capability name, minimum, and maximum.
static interface	CfnFleet.FleetCapabilitiesProperty	The amounts and attributes of fleets.
static interface	CfnFleet.FleetConfigurationProperty	Fleet configuration details.
static interface	CfnFleet.MemoryMiBRangeProperty	The range of memory in MiB.
static interface	CfnFleet.ServiceManagedEc2FleetConfigurationProperty	The configuration details for a service managed Amazon EC2 fleet.
static interface	CfnFleet.ServiceManagedEc2InstanceCapabilitiesProperty	The Amazon EC2 instance capabilities.
static interface	CfnFleet.ServiceManagedEc2InstanceMarketOptionsProperty	The details of the Amazon EC2 instance market options for a service managed fleet.
static interface	CfnFleet.VCpuCountRangeProperty	The allowable range of vCPU processing power for the fleet.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnFleet(software.constructs.Construct scope, String id, CfnFleetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) assigned to the fleet.
IResolvable	getAttrCapabilities()
String	getAttrFleetId()	The fleet ID.
String	getAttrStatus()	The status of the fleet.
Number	getAttrWorkerCount()	The number of workers in the fleet summary.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	The configuration details for the fleet.
String	getDescription()	A description that helps identify what the fleet is used for.
String	getDisplayName()	The display name of the fleet summary to update.
String	getFarmId()	The farm ID.
Number	getMaxWorkerCount()	The maximum number of workers specified in the fleet.
Number	getMinWorkerCount()	The minimum number of workers in the fleet.
String	getRoleArn()	The IAM role that workers in the fleet use when processing jobs.
List<CfnTag>	getTags()	The tags to add to your fleet.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfiguration(IResolvable value)	The configuration details for the fleet.
void	setConfiguration(CfnFleet.FleetConfigurationProperty value)	The configuration details for the fleet.
void	setDescription(String value)	A description that helps identify what the fleet is used for.
void	setDisplayName(String value)	The display name of the fleet summary to update.
void	setFarmId(String value)	The farm ID.
void	setMaxWorkerCount(Number value)	The maximum number of workers specified in the fleet.
void	setMinWorkerCount(Number value)	The minimum number of workers in the fleet.
void	setRoleArn(String value)	The IAM role that workers in the fleet use when processing jobs.
void	setTags(List<CfnTag> value)	The tags to add to your fleet.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

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

getConfiguration

@Stability(Stable)
@NotNull
public Object getConfiguration()

The configuration details for the fleet.

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.

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.