Interface ICfnLimitProps

Properties for defining a CfnLimit.

Namespace: Amazon.CDK.AWS.Deadline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnLimitProps

Syntax (vb)

Public Interface ICfnLimitProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Deadline;

             var cfnLimitProps = new CfnLimitProps {
                 AmountRequirementName = "amountRequirementName",
                 DisplayName = "displayName",
                 FarmId = "farmId",
                 MaxCount = 123,

                 // the properties below are optional
                 Description = "description"
             };

Synopsis

Properties

AmountRequirementName	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	A description of the limit. A clear description helps you identify the purpose of the limit.
DisplayName	The name of the limit used in lists to identify the limit.
FarmId	The unique identifier of the farm that contains the limit.
MaxCount	The maximum number of resources constrained by this limit.

Properties

AmountRequirementName

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.

string AmountRequirementName { get; }

Property Value

string

Remarks

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

Description

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

string? Description { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-description

DisplayName

The name of the limit used in lists to identify the limit.

string DisplayName { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-displayname

FarmId

The unique identifier of the farm that contains the limit.

string FarmId { get; }

Property Value

string

Remarks

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

MaxCount

The maximum number of resources constrained by this limit.

double MaxCount { get; }

Property Value

double

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-maxcount