CfnLimitProps Struct
Properties for defining a CfnLimit.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';
const cfnLimitProps: deadline.CfnLimitProps = {
amountRequirementName: 'amountRequirementName',
displayName: 'displayName',
farmId: 'farmId',
maxCount: 123,
// the properties below are optional
description: 'description',
};
Properties
amountRequirementNamestringamount_requirement_namestramountRequirementNameStringAmountRequirementNamestringAmountRequirementName*stringrequired#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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= ""#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.
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.
The unique identifier of the farm that contains the limit.
The maximum number of resources constrained by this limit.
notes
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.