Package software.amazon.awscdk.services.deadline

Class CfnLimit

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.CfnLimit
All Implemented Interfaces:
IInspectable, ILimitRef, 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.885Z") @Stability(Stable) public class CfnLimit extends CfnResource implements IInspectable, ILimitRef
Creates a limit that manages the distribution of shared resources, such as floating licenses.

A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

You must add the amountRequirementName to a step in a job template to declare the limit requirement.

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.*;
 CfnLimit cfnLimit = CfnLimit.Builder.create(this, "MyCfnLimit")
         .amountRequirementName("amountRequirementName")
         .displayName("displayName")
         .farmId("farmId")
         .maxCount(123)
         // the properties below are optional
         .description("description")
         .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

    • CfnLimit

      protected CfnLimit(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLimit

      protected CfnLimit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLimit

      @Stability(Stable) public CfnLimit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLimitProps 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.

    • getAttrCurrentCount

      @Stability(Stable) @NotNull public Number getAttrCurrentCount()
      The number of resources from the limit that are being used by jobs.

      The result is delayed and may not be the count at the time that you called the operation.

    • getAttrLimitId

      @Stability(Stable) @NotNull public String getAttrLimitId()
      The unique identifier of the limit.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLimitRef

      @Stability(Stable) @NotNull public LimitReference getLimitRef()
      A reference to a Limit resource.
      Specified by:
      getLimitRef in interface ILimitRef

    • getAmountRequirementName

      @Stability(Stable) @NotNull public 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.

    • setAmountRequirementName

      @Stability(Stable) public void setAmountRequirementName(@NotNull String value)
      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.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the limit used in lists to identify the limit.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the limit used in lists to identify the limit.

    • getFarmId

      @Stability(Stable) @NotNull public String getFarmId()
      The unique identifier of the farm that contains the limit.

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The unique identifier of the farm that contains the limit.

    • getMaxCount

      @Stability(Stable) @NotNull public Number getMaxCount()
      The maximum number of resources constrained by this limit.

    • setMaxCount

      @Stability(Stable) public void setMaxCount(@NotNull Number value)
      The maximum number of resources constrained by this limit.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the limit.

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the limit.

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