CfnFarmMixinProps

class aws_cdk.mixins_preview.aws_deadline.mixins.CfnFarmMixinProps(*, description=None, display_name=None, kms_key_arn=None, tags=None)

Bases: object

Properties for CfnFarmPropsMixin.

Parameters:

  • description (Optional[str]) – A description of the farm that helps identify what the farm is used for. .. epigraph:: 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: - “”

  • display_name (Optional[str]) – The display name of the farm. .. epigraph:: 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 (Optional[str]) – The ARN for the KMS key.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_deadline import mixins as deadline_mixins

cfn_farm_mixin_props = deadline_mixins.CfnFarmMixinProps(
    description="description",
    display_name="displayName",
    kms_key_arn="kmsKeyArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the farm that helps identify what the farm is used for.

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-farm.html#cfn-deadline-farm-description

display_name

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-displayname

kms_key_arn

The ARN for the KMS key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-kmskeyarn

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-tags