@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 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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| 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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnFuotaTask(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFuotaTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnFuotaTask(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnFuotaTaskProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrFuotaTaskStatus()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull public String getAttrLoRaWanStartTime()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
Tags can have a minimum of 0 and a maximum of 50 items.
@Stability(value=Stable) @NotNull public String getFirmwareUpdateImage()
@Stability(value=Stable)
public void setFirmwareUpdateImage(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getFirmwareUpdateRole()
@Stability(value=Stable)
public void setFirmwareUpdateRole(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getLoRaWan()
@Stability(value=Stable)
public void setLoRaWan(@NotNull
CfnFuotaTask.LoRaWANProperty value)
@Stability(value=Stable)
public void setLoRaWan(@NotNull
IResolvable value)
@Stability(value=Stable) @Nullable public String getAssociateMulticastGroup()
@Stability(value=Stable)
public void setAssociateMulticastGroup(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getAssociateWirelessDevice()
@Stability(value=Stable)
public void setAssociateWirelessDevice(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getDisassociateMulticastGroup()
@Stability(value=Stable)
public void setDisassociateMulticastGroup(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getDisassociateWirelessDevice()
@Stability(value=Stable)
public void setDisassociateWirelessDevice(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getName()
@Stability(value=Stable)
public void setName(@Nullable
String value)
Copyright © 2022. All rights reserved.