Package software.amazon.awscdk.services.deadline

Class CfnWorker

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.CfnWorker
All Implemented Interfaces:
IInspectable, IWorkerRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:07.509Z") @Stability(Stable) public class CfnWorker extends CfnResource implements IInspectable, IWorkerRef, ITaggableV2
Definition of AWS::Deadline::Worker Resource Type.

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.*;
 CfnWorker cfnWorker = CfnWorker.Builder.create(this, "MyCfnWorker")
         .farmId("farmId")
         .fleetId("fleetId")
         // the properties below are optional
         .hostProperties(HostPropertiesRequestProperty.builder()
                 .hostName("hostName")
                 .ipAddresses(IpAddressesProperty.builder()
                         .ipV4Addresses(List.of("ipV4Addresses"))
                         .ipV6Addresses(List.of("ipV6Addresses"))
                         .build())
                 .build())
         .tags(List.of(TagsItemsProperty.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

    • CfnWorker

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

    • CfnWorker

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

    • CfnWorker

      @Stability(Stable) public CfnWorker(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkerProps props)
      Create a new AWS::Deadline::Worker.

      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

    • arnForWorker

      @Stability(Stable) @NotNull public static String arnForWorker(@NotNull IWorkerRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnWorker

      @Stability(Stable) @NotNull public static Boolean isCfnWorker(@NotNull Object x)
      Checks whether the given object is a CfnWorker.

      Parameters:
      x - This parameter is required.

    • 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) of the worker.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time the resource was created.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public String getAttrCreatedBy()
      The user or system that created this resource.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the worker.

    • getAttrWorkerId

      @Stability(Stable) @NotNull public String getAttrWorkerId()
      The worker 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

    • getCfnPropertyNames

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

    • getWorkerRef

      @Stability(Stable) @NotNull public WorkerReference getWorkerRef()
      A reference to a Worker resource.
      Specified by:
      getWorkerRef in interface IWorkerRef

    • getFarmId

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

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The farm ID.

    • getFleetId

      @Stability(Stable) @NotNull public String getFleetId()
      The fleet ID.

    • setFleetId

      @Stability(Stable) public void setFleetId(@NotNull String value)
      The fleet ID.

    • getHostProperties

      @Stability(Stable) @Nullable public Object getHostProperties()
      The host property details.

      Returns union: either IResolvable or CfnWorker.HostPropertiesRequestProperty

    • setHostProperties

      @Stability(Stable) public void setHostProperties(@Nullable IResolvable value)
      The host property details.

    • setHostProperties

      @Stability(Stable) public void setHostProperties(@Nullable CfnWorker.HostPropertiesRequestProperty value)
      The host property details.

    • getTags

      @Stability(Stable) @Nullable public List<CfnWorker.TagsItemsProperty> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnWorker.TagsItemsProperty> value)
      An array of key-value pairs to apply to this resource.