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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-17T05:10:08.528Z")
@Stability(Stable)
public class CfnFarm
extends CfnResource
implements IInspectable
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") .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFarm
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFarm
(software.amazon.jsii.JsiiObjectRef objRef) CfnFarm
(software.constructs.Construct scope, String id, CfnFarmProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) assigned to the farm.The farm ID.A description of the farm that helps identify what the farm is used for.The display name of the farm.The ARN for the KMS key.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) A description of the farm that helps identify what the farm is used for.void
setDisplayName
(String value) The display name of the farm.void
setKmsKeyArn
(String value) The ARN for the KMS key.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) assigned to the farm. -
getAttrFarmId
The farm ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDisplayName
The display name of the farm. -
setDisplayName
The display name of the farm. -
getDescription
A description of the farm that helps identify what the farm is used for. -
setDescription
A description of the farm that helps identify what the farm is used for. -
getKmsKeyArn
The ARN for the KMS key. -
setKmsKeyArn
The ARN for the KMS key.
-