Package software.amazon.awscdk.services.deadline

Class CfnFarm

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.deadline.CfnFarm
All Implemented Interfaces:
IInspectable, ITaggableV2, IFarmRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:36.162Z") @Stability(Stable) public class CfnFarm extends CfnResource implements IInspectable, IFarmRef, ITaggableV2
Creates a farm to allow space for queues and fleets.

Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

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.*;
 CfnFarm cfnFarm = CfnFarm.Builder.create(this, "MyCfnFarm")
         .displayName("displayName")
         // the properties below are optional
         .description("description")
         .kmsKeyArn("kmsKeyArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFarm

      protected CfnFarm(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFarm

      protected CfnFarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFarm

      @Stability(Stable) public CfnFarm(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFarmProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) assigned to the farm.

    • getAttrFarmId

      @Stability(Stable) @NotNull public String getAttrFarmId()
      The farm ID.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFarmRef

      @Stability(Stable) @NotNull public FarmReference getFarmRef()
      A reference to a Farm resource.
      Specified by:
      getFarmRef in interface IFarmRef

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the farm.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The display name of the farm.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the farm that helps identify what the farm is used for.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the farm that helps identify what the farm is used for.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The ARN for the KMS key.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The ARN for the KMS key.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to your farm.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to your farm.