AWS::Deadline::LimitCfnLimit
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.
Import
import { CfnLimit } from 'aws-cdk-lib/aws-deadline';Or use the module namespace:
import * as deadline from 'aws-cdk-lib/aws-deadline';
// deadline.CfnLimitProperties
Configuration passed to the constructor as CfnLimitProps.
amountRequirementNameRequiredstringThe 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.
displayNameRequiredstringThe 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.
farmIdRequiredstringThe unique identifier of the farm that contains the limit.
maxCountRequirednumberThe 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.
descriptionOptionalstringA 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: - ""
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-deadlineAWS::Deadline::Limit