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

Interface CfnLimitMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLimitMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.017Z")
@Stability(Stable)
public interface CfnLimitMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnLimitPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.deadline.*;
 CfnLimitMixinProps cfnLimitMixinProps = CfnLimitMixinProps.builder()
         .amountRequirementName("amountRequirementName")
         .description("description")
         .displayName("displayName")
         .farmId("farmId")
         .maxCount(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLimitMixinProps.Builder	A builder for CfnLimitMixinProps
static final class	CfnLimitMixinProps.Jsii$Proxy	An implementation for CfnLimitMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnLimitMixinProps.Builder	builder()
default String	getAmountRequirementName()	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.
default String	getDescription()	A description of the limit.
default String	getDisplayName()	The name of the limit used in lists to identify the limit.
default String	getFarmId()	The unique identifier of the farm that contains the limit.
default Number	getMaxCount()	The maximum number of resources constrained by this limit.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmountRequirementName

@Stability(Stable)
@Nullable
default String getAmountRequirementName()

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.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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: - ""

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

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.

See Also:

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

getFarmId

@Stability(Stable)
@Nullable
default String getFarmId()

The unique identifier of the farm that contains the limit.

See Also:

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

getMaxCount

@Stability(Stable)
@Nullable
default Number getMaxCount()

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.

See Also:

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

builder

@Stability(Stable)
static CfnLimitMixinProps.Builder builder()

Returns:

a CfnLimitMixinProps.Builder of CfnLimitMixinProps