software.amazon.awscdk.services.iotwireless

Class CfnTaskDefinition

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.iotwireless.CfnTaskDefinition

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.086Z")
 @Stability(value=Stable)
public class CfnTaskDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTWireless::TaskDefinition`.

Creates a gateway task definition.

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.iotwireless.*;
 CfnTaskDefinition cfnTaskDefinition = CfnTaskDefinition.Builder.create(this, "MyCfnTaskDefinition")
         .autoCreateTasks(false)
         // the properties below are optional
         .loRaWanUpdateGatewayTaskEntry(LoRaWANUpdateGatewayTaskEntryProperty.builder()
                 .currentVersion(LoRaWANGatewayVersionProperty.builder()
                         .model("model")
                         .packageVersion("packageVersion")
                         .station("station")
                         .build())
                 .updateVersion(LoRaWANGatewayVersionProperty.builder()
                         .model("model")
                         .packageVersion("packageVersion")
                         .station("station")
                         .build())
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskDefinitionType("taskDefinitionType")
         .update(UpdateWirelessGatewayTaskCreateProperty.builder()
                 .loRaWan(LoRaWANUpdateGatewayTaskCreateProperty.builder()
                         .currentVersion(LoRaWANGatewayVersionProperty.builder()
                                 .model("model")
                                 .packageVersion("packageVersion")
                                 .station("station")
                                 .build())
                         .sigKeyCrc(123)
                         .updateSignature("updateSignature")
                         .updateVersion(LoRaWANGatewayVersionProperty.builder()
                                 .model("model")
                                 .packageVersion("packageVersion")
                                 .station("station")
                                 .build())
                         .build())
                 .updateDataRole("updateDataRole")
                 .updateDataSource("updateDataSource")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTaskDefinition.Builder A fluent builder for CfnTaskDefinition.
static interface	CfnTaskDefinition.LoRaWANGatewayVersionProperty LoRaWANGatewayVersion object.
static interface	CfnTaskDefinition.LoRaWANUpdateGatewayTaskCreateProperty The signature used to verify the update firmware.
static interface	CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty LoRaWANUpdateGatewayTaskEntry object.
static interface	CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty UpdateWirelessGatewayTaskCreate object.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.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
	CfnTaskDefinition(software.constructs.Construct scope, String id, CfnTaskDefinitionProps props) Create a new `AWS::IoTWireless::TaskDefinition`.
protected	CfnTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name of the resource.
String	getAttrId() The ID of the new wireless gateway task definition.
Object	getAutoCreateTasks() Whether to automatically create tasks using this task definition for all gateways with the specified current version.
protected Map<String,Object>	getCfnProperties()
Object	getLoRaWanUpdateGatewayTaskEntry() `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.
String	getName() The name of the new resource.
TagManager	getTags() The tags are an array of key-value pairs to attach to the specified resource.
String	getTaskDefinitionType() `AWS::IoTWireless::TaskDefinition.TaskDefinitionType`.
Object	getUpdate() Information about the gateways to update.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoCreateTasks(Boolean value) Whether to automatically create tasks using this task definition for all gateways with the specified current version.
void	setAutoCreateTasks(IResolvable value) Whether to automatically create tasks using this task definition for all gateways with the specified current version.
void	setLoRaWanUpdateGatewayTaskEntry(CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty value) `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.
void	setLoRaWanUpdateGatewayTaskEntry(IResolvable value) `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.
void	setName(String value) The name of the new resource.
void	setTaskDefinitionType(String value) `AWS::IoTWireless::TaskDefinition.TaskDefinitionType`.
void	setUpdate(CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty value) Information about the gateways to update.
void	setUpdate(IResolvable value) Information about the gateways to update.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 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

CfnTaskDefinition

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

CfnTaskDefinition

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

CfnTaskDefinition

@Stability(value=Stable)
public CfnTaskDefinition(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnTaskDefinitionProps props)

Create a new `AWS::IoTWireless::TaskDefinition`.

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 of the resource.

getAttrId

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

The ID of the new wireless gateway task definition.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags are an array of key-value pairs to attach to the specified resource.

Tags can have a minimum of 0 and a maximum of 50 items.

getAutoCreateTasks

@Stability(value=Stable)
 @NotNull
public Object getAutoCreateTasks()

Whether to automatically create tasks using this task definition for all gateways with the specified current version.

If false , the task must me created by calling CreateWirelessGatewayTask .

setAutoCreateTasks

@Stability(value=Stable)
public void setAutoCreateTasks(@NotNull
                                                        Boolean value)

Whether to automatically create tasks using this task definition for all gateways with the specified current version.

If false , the task must me created by calling CreateWirelessGatewayTask .

setAutoCreateTasks

@Stability(value=Stable)
public void setAutoCreateTasks(@NotNull
                                                        IResolvable value)

Whether to automatically create tasks using this task definition for all gateways with the specified current version.

If false , the task must me created by calling CreateWirelessGatewayTask .

getLoRaWanUpdateGatewayTaskEntry

@Stability(value=Stable)
 @Nullable
public Object getLoRaWanUpdateGatewayTaskEntry()

`AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.

setLoRaWanUpdateGatewayTaskEntry

@Stability(value=Stable)
public void setLoRaWanUpdateGatewayTaskEntry(@Nullable
                                                                      CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty value)

`AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.

setLoRaWanUpdateGatewayTaskEntry

@Stability(value=Stable)
public void setLoRaWanUpdateGatewayTaskEntry(@Nullable
                                                                      IResolvable value)

`AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.

getName

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

The name of the new resource.

setName

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

The name of the new resource.

getTaskDefinitionType

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

`AWS::IoTWireless::TaskDefinition.TaskDefinitionType`.

setTaskDefinitionType

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

`AWS::IoTWireless::TaskDefinition.TaskDefinitionType`.

getUpdate

@Stability(value=Stable)
 @Nullable
public Object getUpdate()

Information about the gateways to update.

setUpdate

@Stability(value=Stable)
public void setUpdate(@Nullable
                                               CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty value)

Information about the gateways to update.

setUpdate

@Stability(value=Stable)
public void setUpdate(@Nullable
                                               IResolvable value)

Information about the gateways to update.