Package software.amazon.awscdk.services.deadline

Class CfnQueueEnvironment

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.CfnQueueEnvironment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-11T03:45:52.485Z")
@Stability(Stable)
public class CfnQueueEnvironment
extends CfnResource
implements IInspectable

Creates an environment for a queue that defines how jobs in the queue run.

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.*;
 CfnQueueEnvironment cfnQueueEnvironment = CfnQueueEnvironment.Builder.create(this, "MyCfnQueueEnvironment")
         .farmId("farmId")
         .priority(123)
         .queueId("queueId")
         .template("template")
         .templateType("templateType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnQueueEnvironment.Builder	A fluent builder for CfnQueueEnvironment.

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

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnQueueEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnQueueEnvironment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnQueueEnvironment(software.constructs.Construct scope, String id, CfnQueueEnvironmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrName()	The name of the queue environment.
String	getAttrQueueEnvironmentId()	The queue environment ID.
protected Map<String,Object>	getCfnProperties()
String	getFarmId()	The identifier assigned to the farm that contains the queue.
Number	getPriority()	The queue environment's priority.
String	getQueueId()	The unique identifier of the queue that contains the environment.
String	getTemplate()	A JSON or YAML template that describes the processing environment for the queue.
String	getTemplateType()	Specifies whether the template for the queue environment is JSON or YAML.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFarmId(String value)	The identifier assigned to the farm that contains the queue.
void	setPriority(Number value)	The queue environment's priority.
void	setQueueId(String value)	The unique identifier of the queue that contains the environment.
void	setTemplate(String value)	A JSON or YAML template that describes the processing environment for the queue.
void	setTemplateType(String value)	Specifies whether the template for the queue environment is JSON or YAML.

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

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnQueueEnvironment

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

CfnQueueEnvironment

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

CfnQueueEnvironment

@Stability(Stable)
public CfnQueueEnvironment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnQueueEnvironmentProps 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.

getAttrName

@Stability(Stable)
@NotNull
public String getAttrName()

The name of the queue environment.

getAttrQueueEnvironmentId

@Stability(Stable)
@NotNull
public String getAttrQueueEnvironmentId()

The queue environment ID.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFarmId

@Stability(Stable)
@NotNull
public String getFarmId()

The identifier assigned to the farm that contains the queue.

setFarmId

@Stability(Stable)
public void setFarmId(@NotNull
 String value)

The identifier assigned to the farm that contains the queue.

getPriority

@Stability(Stable)
@NotNull
public Number getPriority()

The queue environment's priority.

setPriority

@Stability(Stable)
public void setPriority(@NotNull
 Number value)

The queue environment's priority.

getQueueId

@Stability(Stable)
@NotNull
public String getQueueId()

The unique identifier of the queue that contains the environment.

setQueueId

@Stability(Stable)
public void setQueueId(@NotNull
 String value)

The unique identifier of the queue that contains the environment.

getTemplate

@Stability(Stable)
@NotNull
public String getTemplate()

A JSON or YAML template that describes the processing environment for the queue.

setTemplate

@Stability(Stable)
public void setTemplate(@NotNull
 String value)

A JSON or YAML template that describes the processing environment for the queue.

getTemplateType

@Stability(Stable)
@NotNull
public String getTemplateType()

Specifies whether the template for the queue environment is JSON or YAML.

setTemplateType

@Stability(Stable)
public void setTemplateType(@NotNull
 String value)

Specifies whether the template for the queue environment is JSON or YAML.