interface CfnLimitMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Deadline.Mixins.CfnLimitMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdeadline/mixins#CfnLimitMixinProps
Java	software.amazon.awscdk.mixins.preview.services.deadline.mixins.CfnLimitMixinProps
Python	aws_cdk.mixins_preview.aws_deadline.mixins.CfnLimitMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_deadline » mixins » CfnLimitMixinProps

Properties for CfnLimitPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as deadline_mixins } from '@aws-cdk/mixins-preview/aws-deadline';
const cfnLimitMixinProps: deadline_mixins.CfnLimitMixinProps = {
  amountRequirementName: 'amountRequirementName',
  description: 'description',
  displayName: 'displayName',
  farmId: 'farmId',
  maxCount: 123,
};

Properties

Name	Type	Description
amountRequirementName?	string	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.
description?	string	A description of the limit. A clear description helps you identify the purpose of the limit.
displayName?	string	The name of the limit used in lists to identify the limit.
farmId?	string	The unique identifier of the farm that contains the limit.
maxCount?	number	The maximum number of resources constrained by this limit.

---

amountRequirementName?

Type: string (optional)

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

---

description?

Type: string (optional, default: "")

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.

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

---

displayName?

Type: string (optional)

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

---

farmId?

Type: string (optional)

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

---

maxCount?

Type: number (optional)

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