Struct aws_sdk_iot::operation::create_ota_update::CreateOtaUpdateInput

#[non_exhaustive]
pub struct CreateOtaUpdateInput {

    pub ota_update_id: Option<String>,
    pub description: Option<String>,
    pub targets: Option<Vec<String>>,
    pub protocols: Option<Vec<Protocol>>,
    pub target_selection: Option<TargetSelection>,
    pub aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>,
    pub aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>,
    pub aws_job_abort_config: Option<AwsJobAbortConfig>,
    pub aws_job_timeout_config: Option<AwsJobTimeoutConfig>,
    pub files: Option<Vec<OtaUpdateFile>>,
    pub role_arn: Option<String>,
    pub additional_parameters: Option<HashMap<String, String>>,
    pub tags: Option<Vec<Tag>>,
}

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.

ota_update_id: Option<String>

The ID of the OTA update to be created.

description: Option<String>

The description of the OTA update.

targets: Option<Vec<String>>

The devices targeted to receive OTA updates.

protocols: Option<Vec<Protocol>>

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

target_selection: Option<TargetSelection>

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>

Configuration for the rollout of OTA updates.

aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>

Configuration information for pre-signed URLs.

aws_job_abort_config: Option<AwsJobAbortConfig>

The criteria that determine when and how a job abort takes place.

aws_job_timeout_config: Option<AwsJobTimeoutConfig>

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

files: Option<Vec<OtaUpdateFile>>

The files to be streamed by the OTA update.

role_arn: Option<String>

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

additional_parameters: Option<HashMap<String, String>>

A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.

tags: Option<Vec<Tag>>

Metadata which can be used to manage updates.

Implementations

impl CreateOtaUpdateInput

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

The ID of the OTA update to be created.

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

The description of the OTA update.

pub fn targets(&self) -> &[String]

The devices targeted to receive OTA updates.

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

pub fn protocols(&self) -> &[Protocol]

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

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

pub fn target_selection(&self) -> Option<&TargetSelection>

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

pub fn aws_job_executions_rollout_config( &self ) -> Option<&AwsJobExecutionsRolloutConfig>

Configuration for the rollout of OTA updates.

pub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>

Configuration information for pre-signed URLs.

pub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>

The criteria that determine when and how a job abort takes place.

pub fn aws_job_timeout_config(&self) -> Option<&AwsJobTimeoutConfig>

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

pub fn files(&self) -> &[OtaUpdateFile]

The files to be streamed by the OTA update.

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

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

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

pub fn additional_parameters(&self) -> Option<&HashMap<String, String>>

A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.

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

Metadata which can be used to manage updates.

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().

impl CreateOtaUpdateInput

pub fn builder() -> CreateOtaUpdateInputBuilder

Creates a new builder-style object to manufacture CreateOtaUpdateInput.

Trait Implementations

impl Clone for CreateOtaUpdateInput

fn clone(&self) -> CreateOtaUpdateInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOtaUpdateInput

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

Formats the value using the given formatter.

impl PartialEq for CreateOtaUpdateInput

fn eq(&self, other: &CreateOtaUpdateInput) -> 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 CreateOtaUpdateInput