Skip to content

CreateFarmRequest

Source code in docs_src/capo_deadline/types/create_farm_request.py
class CreateFarmRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the farm.</p> <important> <p>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.</p> </important>"""
    description: "capo_deadline.types.description.Description"
    """<p>The description of the farm.</p> <important> <p>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.</p> </important>"""
    kms_key_arn: NotRequired["capo_deadline.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN of the KMS key to use on the farm.</p>"""
    cost_scale_factor: "capo_deadline.types.cost_scale_factor.CostScaleFactor"
    """<p>A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment. The default value is 1.</p>"""
    tags: NotRequired["capo_deadline.types.tags.Tags"]
    """<p>The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The unique token which the server uses to recognize retries of the same request.

cost_scale_factor instance-attribute

cost_scale_factor: CostScaleFactor

A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment. The default value is 1.

description instance-attribute

description: Description

The description of the farm.

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.

display_name instance-attribute

display_name: ResourceName

The display name of the farm.

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.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The ARN of the KMS key to use on the farm.

tags instance-attribute

tags: NotRequired[Tags]

The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.