@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:22.716Z") 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFuotaTask(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFuotaTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFuotaTask(Construct scope, java.lang.String id, 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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrFuotaTaskStatus()
public java.lang.String getAttrId()
public java.lang.String getAttrLoRaWanStartTime()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Tags can have a minimum of 0 and a maximum of 50 items.
public java.lang.String getFirmwareUpdateImage()
public void setFirmwareUpdateImage(java.lang.String value)
public java.lang.String getFirmwareUpdateRole()
public void setFirmwareUpdateRole(java.lang.String value)
public java.lang.Object getLoRaWan()
public void setLoRaWan(IResolvable value)
public void setLoRaWan(CfnFuotaTask.LoRaWANProperty value)
public java.lang.String getAssociateMulticastGroup()
public void setAssociateMulticastGroup(java.lang.String value)
public java.lang.String getAssociateWirelessDevice()
public void setAssociateWirelessDevice(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDisassociateMulticastGroup()
public void setDisassociateMulticastGroup(java.lang.String value)
public java.lang.String getDisassociateWirelessDevice()
public void setDisassociateWirelessDevice(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)