software.amazon.awscdk.services.iotwireless

Interface CfnFuotaTaskProps

All Known Implementing Classes:

CfnFuotaTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.717Z")
public interface CfnFuotaTaskProps

Properties for defining a `CfnFuotaTask`.

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.*;
 CfnFuotaTaskProps cfnFuotaTaskProps = CfnFuotaTaskProps.builder()
         .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	Interface and Description
static class	CfnFuotaTaskProps.Builder A builder for CfnFuotaTaskProps
static class	CfnFuotaTaskProps.Jsii$Proxy An implementation for CfnFuotaTaskProps

Method Summary

Modifier and Type	Method and Description
static CfnFuotaTaskProps.Builder	builder()
default java.lang.String	getAssociateMulticastGroup() The ID of the multicast group to associate with a FUOTA task.
default java.lang.String	getAssociateWirelessDevice() The ID of the wireless device to associate with a multicast group.
default java.lang.String	getDescription() The description of the new resource.
default java.lang.String	getDisassociateMulticastGroup() The ID of the multicast group to disassociate from a FUOTA task.
default 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.
default java.lang.String	getName() The name of a FUOTA task.
default java.util.List<CfnTag>	getTags() The tags are an array of key-value pairs to attach to the specified resource.

Method Detail

getFirmwareUpdateImage

java.lang.String getFirmwareUpdateImage()

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

getFirmwareUpdateRole

java.lang.String getFirmwareUpdateRole()

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

getLoRaWan

java.lang.Object getLoRaWan()

The LoRaWAN information used with a FUOTA task.

getAssociateMulticastGroup

default java.lang.String getAssociateMulticastGroup()

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

getAssociateWirelessDevice

default java.lang.String getAssociateWirelessDevice()

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

getDescription

default java.lang.String getDescription()

The description of the new resource.

getDisassociateMulticastGroup

default java.lang.String getDisassociateMulticastGroup()

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

getDisassociateWirelessDevice

default java.lang.String getDisassociateWirelessDevice()

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

getName

default java.lang.String getName()

The name of a FUOTA task.

getTags

default java.util.List<CfnTag> 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.

builder

static CfnFuotaTaskProps.Builder builder()

Returns:

a CfnFuotaTaskProps.Builder of CfnFuotaTaskProps