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

Class CfnLimitPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLimitPropsMixin>

Enclosing class:

CfnLimitPropsMixin

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

A fluent builder for CfnLimitPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLimitPropsMixin.Builder	amountRequirementName(String amountRequirementName)	The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
CfnLimitPropsMixin	build()
static CfnLimitPropsMixin.Builder	create()
static CfnLimitPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLimitPropsMixin.Builder	description(String description)	A description of the limit.
CfnLimitPropsMixin.Builder	displayName(String displayName)	The name of the limit used in lists to identify the limit.
CfnLimitPropsMixin.Builder	farmId(String farmId)	The unique identifier of the farm that contains the limit.
CfnLimitPropsMixin.Builder	maxCount(Number maxCount)	The maximum number of resources constrained by this limit.

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 CfnLimitPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLimitPropsMixin.Builder.

create

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

Returns:

a new instance of CfnLimitPropsMixin.Builder.

amountRequirementName

@Stability(Stable)
public CfnLimitPropsMixin.Builder amountRequirementName(String amountRequirementName)

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

Parameters:

amountRequirementName - The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement. This parameter is required.

Returns:

this

See Also:

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

description

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

A description of the limit. A clear description helps you identify the purpose of the limit.

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 of the limit. A clear description helps you identify the purpose of the limit. This parameter is required.

Returns:

this

See Also:

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

displayName

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

The name of the limit used in lists to identify the limit.

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 name of the limit used in lists to identify the limit. This parameter is required.

Returns:

this

See Also:

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

farmId

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

The unique identifier of the farm that contains the limit.

Parameters:

farmId - The unique identifier of the farm that contains the limit. This parameter is required.

Returns:

this

See Also:

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

maxCount

@Stability(Stable)
public CfnLimitPropsMixin.Builder maxCount(Number maxCount)

The maximum number of resources constrained by this limit.

When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

Parameters:

maxCount - The maximum number of resources constrained by this limit. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLimitPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnLimitPropsMixin.