Struct aws_sdk_iotwireless::operation::create_fuota_task::CreateFuotaTaskInput

#[non_exhaustive]
pub struct CreateFuotaTaskInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub client_request_token: Option<String>,
    pub lo_ra_wan: Option<LoRaWanFuotaTask>,
    pub firmware_update_image: Option<String>,
    pub firmware_update_role: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub redundancy_percent: Option<i32>,
    pub fragment_size_bytes: Option<i32>,
    pub fragment_interval_ms: Option<i32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of a FUOTA task.

description: Option<String>

The description of the new resource.

client_request_token: Option<String>

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

lo_ra_wan: Option<LoRaWanFuotaTask>

The LoRaWAN information used with a FUOTA task.

firmware_update_image: Option<String>

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

firmware_update_role: Option<String>

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

tags: Option<Vec<Tag>>

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

redundancy_percent: Option<i32>

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

fragment_size_bytes: Option<i32>

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

fragment_interval_ms: Option<i32>

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

Implementations

impl CreateFuotaTaskInput

pub fn name(&self) -> Option<&str>

The name of a FUOTA task.

pub fn description(&self) -> Option<&str>

The description of the new resource.

pub fn client_request_token(&self) -> Option<&str>

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

pub fn lo_ra_wan(&self) -> Option<&LoRaWanFuotaTask>

The LoRaWAN information used with a FUOTA task.

pub fn firmware_update_image(&self) -> Option<&str>

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

pub fn firmware_update_role(&self) -> Option<&str>

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

pub fn tags(&self) -> &[Tag]

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn redundancy_percent(&self) -> Option<i32>

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

pub fn fragment_size_bytes(&self) -> Option<i32>

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

pub fn fragment_interval_ms(&self) -> Option<i32>

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

impl CreateFuotaTaskInput

pub fn builder() -> CreateFuotaTaskInputBuilder

Creates a new builder-style object to manufacture CreateFuotaTaskInput.

Trait Implementations

impl Clone for CreateFuotaTaskInput

fn clone(&self) -> CreateFuotaTaskInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFuotaTaskInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateFuotaTaskInput

fn eq(&self, other: &CreateFuotaTaskInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateFuotaTaskInput