Package software.amazon.awscdk.services.deadline

Interface CfnFarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:08.960Z")
@Stability(Stable)
public interface CfnFarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFarm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.deadline.*;
 CfnFarmProps cfnFarmProps = CfnFarmProps.builder()
         .displayName("displayName")
         // the properties below are optional
         .description("description")
         .kmsKeyArn("kmsKeyArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFarmProps.Builder	A builder for CfnFarmProps
static final class	CfnFarmProps.Jsii$Proxy	An implementation for CfnFarmProps

Method Summary

Modifier and Type	Method	Description
static CfnFarmProps.Builder	builder()
default String	getDescription()	A description of the farm that helps identify what the farm is used for.
String	getDisplayName()	The display name of the farm.
default String	getKmsKeyArn()	The ARN for the KMS key.
default List<CfnTag>	getTags()	The tags to add to your farm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The display name of the farm.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

Default: - ""

See Also:

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

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The ARN for the KMS key.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnFarmProps.Builder builder()

Returns:

a CfnFarmProps.Builder of CfnFarmProps