Package software.amazon.awscdk.services.robomaker

Class CfnRobot

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.robomaker.CfnRobot
All Implemented Interfaces:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:06.818Z") @Stability(Stable) public class CfnRobot extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.IInspectable
A CloudFormation `AWS::RoboMaker::Robot`.

The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.

We recommend migrating to AWS IoT Greengrass Version 2. For more information, see Support Changes: May 2, 2022 in the AWS RoboMaker Developer Guide .

The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot.

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.robomaker.*;
 CfnRobot cfnRobot = CfnRobot.Builder.create(this, "MyCfnRobot")
         .architecture("architecture")
         .greengrassGroupId("greengrassGroupId")
         // the properties below are optional
         .fleet("fleet")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnRobot.Builder
    A fluent builder for CfnRobot.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

    software.amazon.awscdk.core.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

    software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.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
     
    CfnRobot(software.amazon.awscdk.core.Construct scope, String id, CfnRobotProps props)
    Create a new `AWS::RoboMaker::Robot`.
    protected
    CfnRobot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnRobot(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArchitecture()
    The architecture of the robot.
    String
    getAttrArn()
    The Amazon Resource Name (ARN) of the robot.
    protected Map<String,Object>
    getCfnProperties()
     
    String
    getFleet()
    The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.
    String
    getGreengrassGroupId()
    The Greengrass group associated with the robot.
    String
    getName()
    The name of the robot.
    software.amazon.awscdk.core.TagManager
    getTags()
    A map that contains tag keys and tag values that are attached to the robot.
    void
    inspect(software.amazon.awscdk.core.TreeInspector inspector)
    Examines the CloudFormation resource and discloses attributes.
    protected Map<String,Object>
    renderProperties(Map<String,Object> props)
     
    void
    setArchitecture(String value)
    The architecture of the robot.
    void
    setFleet(String value)
    The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.
    void
    setGreengrassGroupId(String value)
    The Greengrass group associated with the robot.
    void
    setName(String value)
    The name of the robot.

    Methods inherited from class software.amazon.awscdk.core.CfnResource

    addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

    Methods inherited from class software.amazon.awscdk.core.CfnRefElement

    getRef

    Methods inherited from class software.amazon.awscdk.core.CfnElement

    getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

    Methods inherited from class software.amazon.awscdk.core.Construct

    getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

    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

    • CfnRobot

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

    • CfnRobot

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

    • CfnRobot

      @Stability(Stable) public CfnRobot(@NotNull software.amazon.awscdk.core.Construct scope, @NotNull String id, @NotNull CfnRobotProps props)
      Create a new `AWS::RoboMaker::Robot`.

      Parameters:
      scope - - scope in which this resource is defined. This parameter is required.
      id - - scoped id of the resource. This parameter is required.
      props - - resource properties. This parameter is required.

  • Method Details

    • inspect

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

      Specified by:
      inspect in interface software.amazon.awscdk.core.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 software.amazon.awscdk.core.CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the robot.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class software.amazon.awscdk.core.CfnResource

    • getTags

      @Stability(Stable) @NotNull public software.amazon.awscdk.core.TagManager getTags()
      A map that contains tag keys and tag values that are attached to the robot.

    • getArchitecture

      @Stability(Stable) @NotNull public String getArchitecture()
      The architecture of the robot.

    • setArchitecture

      @Stability(Stable) public void setArchitecture(@NotNull String value)
      The architecture of the robot.

    • getGreengrassGroupId

      @Stability(Stable) @NotNull public String getGreengrassGroupId()
      The Greengrass group associated with the robot.

    • setGreengrassGroupId

      @Stability(Stable) public void setGreengrassGroupId(@NotNull String value)
      The Greengrass group associated with the robot.

    • getFleet

      @Stability(Stable) @Nullable public String getFleet()
      The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.

    • setFleet

      @Stability(Stable) public void setFleet(@Nullable String value)
      The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the robot.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the robot.