software.amazon.awscdk.services.iotwireless

Class CfnFuotaTask

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

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.078Z")
 @Stability(value=Stable)
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 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
	CfnFuotaTask(software.constructs.Construct scope, 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
String	getAssociateMulticastGroup() The ID of the multicast group to associate with a FUOTA task.
String	getAssociateWirelessDevice() The ID of the wireless device to associate with a multicast group.
String	getAttrArn() The ARN of a FUOTA task.
String	getAttrFuotaTaskStatus() The status of a FUOTA task.
String	getAttrId() The ID of a FUOTA task.
String	getAttrLoRaWanStartTime() Start time of a FUOTA task.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the new resource.
String	getDisassociateMulticastGroup() The ID of the multicast group to disassociate from a FUOTA task.
String	getDisassociateWirelessDevice() The ID of the wireless device to disassociate from a FUOTA task.
String	getFirmwareUpdateImage() The S3 URI points to a firmware update image that is to be used with a FUOTA task.
String	getFirmwareUpdateRole() The firmware update role that is to be used with a FUOTA task.
Object	getLoRaWan() The LoRaWAN information used with a FUOTA task.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssociateMulticastGroup(String value) The ID of the multicast group to associate with a FUOTA task.
void	setAssociateWirelessDevice(String value) The ID of the wireless device to associate with a multicast group.
void	setDescription(String value) The description of the new resource.
void	setDisassociateMulticastGroup(String value) The ID of the multicast group to disassociate from a FUOTA task.
void	setDisassociateWirelessDevice(String value) The ID of the wireless device to disassociate from a FUOTA task.
void	setFirmwareUpdateImage(String value) The S3 URI points to a firmware update image that is to be used with a FUOTA task.
void	setFirmwareUpdateRole(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(String value) The name of a FUOTA task.

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

CfnFuotaTask

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

CfnFuotaTask

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

CfnFuotaTask

@Stability(value=Stable)
public CfnFuotaTask(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             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

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

getAttrFuotaTaskStatus

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

The status of a FUOTA task.

getAttrId

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

The ID of a FUOTA task.

getAttrLoRaWanStartTime

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

Start time of a FUOTA task.

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.

getFirmwareUpdateImage

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

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

setFirmwareUpdateImage

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

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

getFirmwareUpdateRole

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

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

setFirmwareUpdateRole

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

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

getLoRaWan

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

The LoRaWAN information used with a FUOTA task.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@NotNull
                                                CfnFuotaTask.LoRaWANProperty value)

The LoRaWAN information used with a FUOTA task.

setLoRaWan

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

The LoRaWAN information used with a FUOTA task.

getAssociateMulticastGroup

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

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

setAssociateMulticastGroup

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

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

getAssociateWirelessDevice

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

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

setAssociateWirelessDevice

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

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

getDescription

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

The description of the new resource.

setDescription

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

The description of the new resource.

getDisassociateMulticastGroup

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

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

setDisassociateMulticastGroup

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

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

getDisassociateWirelessDevice

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

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

setDisassociateWirelessDevice

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

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

getName

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

The name of a FUOTA task.

setName

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

The name of a FUOTA task.