software.amazon.awscdk.services.iotwireless

Class CfnTaskDefinition

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.118Z")
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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTaskDefinition(Construct scope, java.lang.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
java.lang.String	getAttrArn() The Amazon Resource Name of the resource.
java.lang.String	getAttrId() The ID of the new wireless gateway task definition.
java.lang.Object	getAutoCreateTasks() Whether to automatically create tasks using this task definition for all gateways with the specified current version.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getLoRaWanUpdateGatewayTaskEntry() `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`.
java.lang.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.
java.lang.String	getTaskDefinitionType() `AWS::IoTWireless::TaskDefinition.TaskDefinitionType`.
java.lang.Object	getUpdate() Information about the gateways to update.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAutoCreateTasks(java.lang.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(java.lang.String value) The name of the new resource.
void	setTaskDefinitionType(java.lang.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.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnTaskDefinition(Construct scope,
                         java.lang.String id,
                         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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name of the resource.

getAttrId

public java.lang.String getAttrId()

The ID of the new wireless gateway task definition.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.lang.Object getAutoCreateTasks()

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

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

setAutoCreateTasks

public void setAutoCreateTasks(java.lang.Boolean value)

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

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

setAutoCreateTasks

public void setAutoCreateTasks(IResolvable value)

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

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

getLoRaWanUpdateGatewayTaskEntry

public java.lang.Object getLoRaWanUpdateGatewayTaskEntry()

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

setLoRaWanUpdateGatewayTaskEntry

public void setLoRaWanUpdateGatewayTaskEntry(IResolvable value)

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

setLoRaWanUpdateGatewayTaskEntry

public void setLoRaWanUpdateGatewayTaskEntry(CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty value)

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

getName

public java.lang.String getName()

The name of the new resource.

setName

public void setName(java.lang.String value)

The name of the new resource.

getTaskDefinitionType

public java.lang.String getTaskDefinitionType()

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

setTaskDefinitionType

public void setTaskDefinitionType(java.lang.String value)

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

getUpdate

public java.lang.Object getUpdate()

Information about the gateways to update.

setUpdate

public void setUpdate(IResolvable value)

Information about the gateways to update.

setUpdate

public void setUpdate(CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty value)

Information about the gateways to update.