software.amazon.awscdk.services.iotwireless

Class CfnFuotaTask

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.CfnFuotaTask

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.716Z")
public class CfnFuotaTask
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTWireless::FuotaTask`.

A FUOTA task.

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.*;
 CfnFuotaTask cfnFuotaTask = CfnFuotaTask.Builder.create(this, "MyCfnFuotaTask")
         .firmwareUpdateImage("firmwareUpdateImage")
         .firmwareUpdateRole("firmwareUpdateRole")
         .loRaWan(LoRaWANProperty.builder()
                 .rfRegion("rfRegion")
                 // the properties below are optional
                 .startTime("startTime")
                 .build())
         // the properties below are optional
         .associateMulticastGroup("associateMulticastGroup")
         .associateWirelessDevice("associateWirelessDevice")
         .description("description")
         .disassociateMulticastGroup("disassociateMulticastGroup")
         .disassociateWirelessDevice("disassociateWirelessDevice")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFuotaTask.Builder A fluent builder for CfnFuotaTask.
static interface	CfnFuotaTask.LoRaWANProperty The LoRaWAN information used with a FUOTA task.

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
	CfnFuotaTask(Construct scope, java.lang.String id, CfnFuotaTaskProps props) Create a new `AWS::IoTWireless::FuotaTask`.
protected	CfnFuotaTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFuotaTask(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAssociateMulticastGroup() The ID of the multicast group to associate with a FUOTA task.
java.lang.String	getAssociateWirelessDevice() The ID of the wireless device to associate with a multicast group.
java.lang.String	getAttrArn() The ARN of a FUOTA task.
java.lang.String	getAttrFuotaTaskStatus() The status of a FUOTA task.
java.lang.String	getAttrId() The ID of a FUOTA task.
java.lang.String	getAttrLoRaWanStartTime() Start time of a FUOTA task.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the new resource.
java.lang.String	getDisassociateMulticastGroup() The ID of the multicast group to disassociate from a FUOTA task.
java.lang.String	getDisassociateWirelessDevice() The ID of the wireless device to disassociate from a FUOTA task.
java.lang.String	getFirmwareUpdateImage() The S3 URI points to a firmware update image that is to be used with a FUOTA task.
java.lang.String	getFirmwareUpdateRole() The firmware update role that is to be used with a FUOTA task.
java.lang.Object	getLoRaWan() The LoRaWAN information used with a FUOTA task.
java.lang.String	getName() The name of a FUOTA task.
TagManager	getTags() The tags are an array of key-value pairs to attach to the specified resource.
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	setAssociateMulticastGroup(java.lang.String value) The ID of the multicast group to associate with a FUOTA task.
void	setAssociateWirelessDevice(java.lang.String value) The ID of the wireless device to associate with a multicast group.
void	setDescription(java.lang.String value) The description of the new resource.
void	setDisassociateMulticastGroup(java.lang.String value) The ID of the multicast group to disassociate from a FUOTA task.
void	setDisassociateWirelessDevice(java.lang.String value) The ID of the wireless device to disassociate from a FUOTA task.
void	setFirmwareUpdateImage(java.lang.String value) The S3 URI points to a firmware update image that is to be used with a FUOTA task.
void	setFirmwareUpdateRole(java.lang.String value) The firmware update role that is to be used with a FUOTA task.
void	setLoRaWan(CfnFuotaTask.LoRaWANProperty value) The LoRaWAN information used with a FUOTA task.
void	setLoRaWan(IResolvable value) The LoRaWAN information used with a FUOTA task.
void	setName(java.lang.String value) The name of a FUOTA task.

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

CfnFuotaTask

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

CfnFuotaTask

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

CfnFuotaTask

public CfnFuotaTask(Construct scope,
                    java.lang.String id,
                    CfnFuotaTaskProps props)

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

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 ARN of a FUOTA task.

getAttrFuotaTaskStatus

public java.lang.String getAttrFuotaTaskStatus()

The status of a FUOTA task.

getAttrId

public java.lang.String getAttrId()

The ID of a FUOTA task.

getAttrLoRaWanStartTime

public java.lang.String getAttrLoRaWanStartTime()

Start time of a FUOTA task.

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.

getFirmwareUpdateImage

public java.lang.String getFirmwareUpdateImage()

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

setFirmwareUpdateImage

public void setFirmwareUpdateImage(java.lang.String value)

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

getFirmwareUpdateRole

public java.lang.String getFirmwareUpdateRole()

The firmware update role that is to be used with a FUOTA task.

setFirmwareUpdateRole

public void setFirmwareUpdateRole(java.lang.String value)

The firmware update role that is to be used with a FUOTA task.

getLoRaWan

public java.lang.Object getLoRaWan()

The LoRaWAN information used with a FUOTA task.

setLoRaWan

public void setLoRaWan(IResolvable value)

The LoRaWAN information used with a FUOTA task.

setLoRaWan

public void setLoRaWan(CfnFuotaTask.LoRaWANProperty value)

The LoRaWAN information used with a FUOTA task.

getAssociateMulticastGroup

public java.lang.String getAssociateMulticastGroup()

The ID of the multicast group to associate with a FUOTA task.

setAssociateMulticastGroup

public void setAssociateMulticastGroup(java.lang.String value)

The ID of the multicast group to associate with a FUOTA task.

getAssociateWirelessDevice

public java.lang.String getAssociateWirelessDevice()

The ID of the wireless device to associate with a multicast group.

setAssociateWirelessDevice

public void setAssociateWirelessDevice(java.lang.String value)

The ID of the wireless device to associate with a multicast group.

getDescription

public java.lang.String getDescription()

The description of the new resource.

setDescription

public void setDescription(java.lang.String value)

The description of the new resource.

getDisassociateMulticastGroup

public java.lang.String getDisassociateMulticastGroup()

The ID of the multicast group to disassociate from a FUOTA task.

setDisassociateMulticastGroup

public void setDisassociateMulticastGroup(java.lang.String value)

The ID of the multicast group to disassociate from a FUOTA task.

getDisassociateWirelessDevice

public java.lang.String getDisassociateWirelessDevice()

The ID of the wireless device to disassociate from a FUOTA task.

setDisassociateWirelessDevice

public void setDisassociateWirelessDevice(java.lang.String value)

The ID of the wireless device to disassociate from a FUOTA task.

getName

public java.lang.String getName()

The name of a FUOTA task.

setName

public void setName(java.lang.String value)

The name of a FUOTA task.