software.amazon.awscdk.services.iotwireless

Interface CfnFuotaTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFuotaTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.079Z")
 @Stability(value=Stable)
public interface CfnFuotaTaskProps
extends software.amazon.jsii.JsiiSerializable

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFirmwareUpdateImage

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

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

getFirmwareUpdateRole

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

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

getLoRaWan

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

The LoRaWAN information used with a FUOTA task.

getAssociateMulticastGroup

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

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

getAssociateWirelessDevice

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

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

getDescription

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

The description of the new resource.

getDisassociateMulticastGroup

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

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

getDisassociateWirelessDevice

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

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

getName

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

The name of a FUOTA task.

getTags

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
static CfnFuotaTaskProps.Builder builder()

Returns:

a CfnFuotaTaskProps.Builder of CfnFuotaTaskProps