Package software.amazon.awscdk.cfnpropertymixins.services.deadline

Class CfnFleetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.deadline.CfnFleetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleetPropsMixin>

Enclosing class:

CfnFleetPropsMixin

@Stability(Stable)
public static final class CfnFleetPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFleetPropsMixin>

A fluent builder for CfnFleetPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnFleetPropsMixin	build()
CfnFleetPropsMixin.Builder	configuration(CfnFleetPropsMixin.FleetConfigurationProperty configuration)	The configuration details for the fleet.
CfnFleetPropsMixin.Builder	configuration(IResolvable configuration)	The configuration details for the fleet.
static CfnFleetPropsMixin.Builder	create()
static CfnFleetPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnFleetPropsMixin.Builder	description(String description)	A description that helps identify what the fleet is used for.
CfnFleetPropsMixin.Builder	displayName(String displayName)	The display name of the fleet summary to update.
CfnFleetPropsMixin.Builder	farmId(String farmId)	The farm ID.
CfnFleetPropsMixin.Builder	hostConfiguration(CfnFleetPropsMixin.HostConfigurationProperty hostConfiguration)	Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
CfnFleetPropsMixin.Builder	hostConfiguration(IResolvable hostConfiguration)	Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
CfnFleetPropsMixin.Builder	maxWorkerCount(Number maxWorkerCount)	The maximum number of workers specified in the fleet.
CfnFleetPropsMixin.Builder	minWorkerCount(Number minWorkerCount)	The minimum number of workers in the fleet.
CfnFleetPropsMixin.Builder	roleArn(String roleArn)	The IAM role that workers in the fleet use when processing jobs.
CfnFleetPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to add to your fleet.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnFleetPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnFleetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnFleetPropsMixin.Builder create()

Returns:

a new instance of CfnFleetPropsMixin.Builder.

configuration

@Stability(Stable)
public CfnFleetPropsMixin.Builder configuration(IResolvable configuration)

The configuration details for the fleet.

Parameters:

configuration - The configuration details for the fleet. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnFleetPropsMixin.Builder configuration(CfnFleetPropsMixin.FleetConfigurationProperty configuration)

The configuration details for the fleet.

Parameters:

configuration - The configuration details for the fleet. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFleetPropsMixin.Builder description(String description)

A description that helps identify what the fleet is used for.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Default: - ""

Parameters:

description - A description that helps identify what the fleet is used for. This parameter is required.

Returns:

this

See Also:

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

displayName

@Stability(Stable)
public CfnFleetPropsMixin.Builder displayName(String displayName)

The display name of the fleet summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Parameters:

displayName - The display name of the fleet summary to update. This parameter is required.

Returns:

this

See Also:

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

farmId

@Stability(Stable)
public CfnFleetPropsMixin.Builder farmId(String farmId)

The farm ID.

Parameters:

farmId - The farm ID. This parameter is required.

Returns:

this

See Also:

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

hostConfiguration

@Stability(Stable)
public CfnFleetPropsMixin.Builder hostConfiguration(IResolvable hostConfiguration)

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").

Parameters:

hostConfiguration - Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. This parameter is required.

Returns:

this

See Also:

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

hostConfiguration

@Stability(Stable)
public CfnFleetPropsMixin.Builder hostConfiguration(CfnFleetPropsMixin.HostConfigurationProperty hostConfiguration)

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").

Parameters:

hostConfiguration - Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. This parameter is required.

Returns:

this

See Also:

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

maxWorkerCount

@Stability(Stable)
public CfnFleetPropsMixin.Builder maxWorkerCount(Number maxWorkerCount)

The maximum number of workers specified in the fleet.

Parameters:

maxWorkerCount - The maximum number of workers specified in the fleet. This parameter is required.

Returns:

this

See Also:

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

minWorkerCount

@Stability(Stable)
public CfnFleetPropsMixin.Builder minWorkerCount(Number minWorkerCount)

The minimum number of workers in the fleet.

Default: - 0

Parameters:

minWorkerCount - The minimum number of workers in the fleet. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnFleetPropsMixin.Builder roleArn(String roleArn)

The IAM role that workers in the fleet use when processing jobs.

Parameters:

roleArn - The IAM role that workers in the fleet use when processing jobs. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnFleetPropsMixin.Builder tags(List<? extends CfnTag> tags)

The tags to add to your fleet.

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Parameters:

tags - The tags to add to your fleet. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFleetPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFleetPropsMixin>

Returns:

a newly built instance of CfnFleetPropsMixin.