Package 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.102.0 (build e354887)",
           date="2024-08-23T05:56:18.340Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFuotaTaskProps.Builder	A builder for CfnFuotaTaskProps
static final class	CfnFuotaTaskProps.Jsii$Proxy	An implementation for CfnFuotaTaskProps

Method Summary

Modifier and Type	Method	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 Details

getFirmwareUpdateImage

@Stability(Stable)
@NotNull
String getFirmwareUpdateImage()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdateimage

getFirmwareUpdateRole

@Stability(Stable)
@NotNull
String getFirmwareUpdateRole()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdaterole

getLoRaWan

@Stability(Stable)
@NotNull
Object getLoRaWan()

The LoRaWAN information used with a FUOTA task.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-lorawan

getAssociateMulticastGroup

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatemulticastgroup

getAssociateWirelessDevice

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatewirelessdevice

getDescription

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

The description of the new resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-description

getDisassociateMulticastGroup

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatemulticastgroup

getDisassociateWirelessDevice

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatewirelessdevice

getName

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

The name of a FUOTA task.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-name

getTags

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-tags

builder

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

Returns:

a CfnFuotaTaskProps.Builder of CfnFuotaTaskProps