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:

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

@Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-20T14:12:13.104Z")
 @Stability(value=Stable)
public class CfnRobot
extends CfnResource
implements 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 and Description
static 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRobot(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 and 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.
TagManager	getTags() A map that contains tag keys and tag values that are attached to the robot.
void	inspect(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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRobot

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

CfnRobot

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

CfnRobot

@Stability(value=Stable)
public CfnRobot(@NotNull
                                         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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the robot.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A map that contains tag keys and tag values that are attached to the robot.

getArchitecture

@Stability(value=Stable)
 @NotNull
public String getArchitecture()

The architecture of the robot.

setArchitecture

@Stability(value=Stable)
public void setArchitecture(@NotNull
                                                     String value)

The architecture of the robot.

getGreengrassGroupId

@Stability(value=Stable)
 @NotNull
public String getGreengrassGroupId()

The Greengrass group associated with the robot.

setGreengrassGroupId

@Stability(value=Stable)
public void setGreengrassGroupId(@NotNull
                                                          String value)

The Greengrass group associated with the robot.

getFleet

@Stability(value=Stable)
 @Nullable
public String getFleet()

The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.

setFleet

@Stability(value=Stable)
public void setFleet(@Nullable
                                              String value)

The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the robot.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the robot.