Package software.amazon.awscdk.services.iotwireless

Class CfnFuotaTask

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.978Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFuotaTask

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

    • CfnFuotaTask

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

    • CfnFuotaTask

      @Stability(Stable) public CfnFuotaTask(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of a FUOTA task.

    • getAttrFuotaTaskStatus

      @Stability(Stable) @NotNull public String getAttrFuotaTaskStatus()
      The status of a FUOTA task.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of a FUOTA task.

    • getAttrLoRaWanStartTime

      @Stability(Stable) @NotNull public String getAttrLoRaWanStartTime()
      Start time of a FUOTA task.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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(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(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(Stable) @NotNull public String getFirmwareUpdateRole()
      The firmware update role that is to be used with a FUOTA task.

    • setFirmwareUpdateRole

      @Stability(Stable) public void setFirmwareUpdateRole(@NotNull String value)
      The firmware update role that is to be used with a FUOTA task.

    • getLoRaWan

      @Stability(Stable) @NotNull public Object getLoRaWan()
      The LoRaWAN information used with a FUOTA task.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@NotNull IResolvable value)
      The LoRaWAN information used with a FUOTA task.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@NotNull CfnFuotaTask.LoRaWANProperty value)
      The LoRaWAN information used with a FUOTA task.

    • getAssociateMulticastGroup

      @Stability(Stable) @Nullable public String getAssociateMulticastGroup()
      The ID of the multicast group to associate with a FUOTA task.

    • setAssociateMulticastGroup

      @Stability(Stable) public void setAssociateMulticastGroup(@Nullable String value)
      The ID of the multicast group to associate with a FUOTA task.

    • getAssociateWirelessDevice

      @Stability(Stable) @Nullable public String getAssociateWirelessDevice()
      The ID of the wireless device to associate with a multicast group.

    • setAssociateWirelessDevice

      @Stability(Stable) public void setAssociateWirelessDevice(@Nullable String value)
      The ID of the wireless device to associate with a multicast group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the new resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the new resource.

    • getDisassociateMulticastGroup

      @Stability(Stable) @Nullable public String getDisassociateMulticastGroup()
      The ID of the multicast group to disassociate from a FUOTA task.

    • setDisassociateMulticastGroup

      @Stability(Stable) public void setDisassociateMulticastGroup(@Nullable String value)
      The ID of the multicast group to disassociate from a FUOTA task.

    • getDisassociateWirelessDevice

      @Stability(Stable) @Nullable public String getDisassociateWirelessDevice()
      The ID of the wireless device to disassociate from a FUOTA task.

    • setDisassociateWirelessDevice

      @Stability(Stable) public void setDisassociateWirelessDevice(@Nullable String value)
      The ID of the wireless device to disassociate from a FUOTA task.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of a FUOTA task.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of a FUOTA task.