Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. deadline
  5. Limit

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.deadline.Limit

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Deadline::Limit Resource Type

Create Limit Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Limit(name: string, args: LimitArgs, opts?: CustomResourceOptions);
@overload
def Limit(resource_name: str,
          args: LimitArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Limit(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          amount_requirement_name: Optional[str] = None,
          display_name: Optional[str] = None,
          farm_id: Optional[str] = None,
          max_count: Optional[int] = None,
          description: Optional[str] = None)
func NewLimit(ctx *Context, name string, args LimitArgs, opts ...ResourceOption) (*Limit, error)
public Limit(string name, LimitArgs args, CustomResourceOptions? opts = null)
public Limit(String name, LimitArgs args)
public Limit(String name, LimitArgs args, CustomResourceOptions options)

type: aws-native:deadline:Limit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LimitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LimitArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LimitArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Limit Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Limit resource accepts the following input properties:

AmountRequirementName This property is required. 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.
DisplayName This property is required. string

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.

FarmId This property is required. string
The unique identifier of the farm that contains the limit.
MaxCount This property is required. int

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.

Description 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.

AmountRequirementName This property is required. 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.
DisplayName This property is required. string

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.

FarmId This property is required. string
The unique identifier of the farm that contains the limit.
MaxCount This property is required. int

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.

Description 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.

amountRequirementName This property is required. 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.
displayName This property is required. String

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.

farmId This property is required. String
The unique identifier of the farm that contains the limit.
maxCount This property is required. Integer

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.

description 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.

amountRequirementName This property is required. 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.
displayName This property is required. string

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.

farmId This property is required. string
The unique identifier of the farm that contains the limit.
maxCount This property is required. number

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.

description 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.

amount_requirement_name This property is required. str
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.
display_name This property is required. str

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.

farm_id This property is required. str
The unique identifier of the farm that contains the limit.
max_count This property is required. int

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.

description str

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.

amountRequirementName This property is required. 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.
displayName This property is required. String

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.

farmId This property is required. String
The unique identifier of the farm that contains the limit.
maxCount This property is required. Number

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.

description 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Limit resource produces the following output properties:

CurrentCount int
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.
Id string
The provider-assigned unique ID for this managed resource.
LimitId string
The unique identifier of the limit.
CurrentCount int
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.
Id string
The provider-assigned unique ID for this managed resource.
LimitId string
The unique identifier of the limit.
currentCount Integer
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.
id String
The provider-assigned unique ID for this managed resource.
limitId String
The unique identifier of the limit.
currentCount number
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.
id string
The provider-assigned unique ID for this managed resource.
limitId string
The unique identifier of the limit.
current_count int
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.
id str
The provider-assigned unique ID for this managed resource.
limit_id str
The unique identifier of the limit.
currentCount Number
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.
id String
The provider-assigned unique ID for this managed resource.
limitId String
The unique identifier of the limit.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native