Class: Aws::IoT::Types::CreateOTAUpdateRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateOTAUpdateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_parameters ⇒ Hash<String,String>

  A list of additional OTA update parameters, which are name-value pairs.

• #aws_job_abort_config ⇒ Types::AwsJobAbortConfig

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

• #aws_job_executions_rollout_config ⇒ Types::AwsJobExecutionsRolloutConfig

  Configuration for the rollout of OTA updates.

• #aws_job_presigned_url_config ⇒ Types::AwsJobPresignedUrlConfig

  Configuration information for pre-signed URLs.

• #aws_job_timeout_config ⇒ Types::AwsJobTimeoutConfig

  Specifies the amount of time each device has to finish its execution of the job.

• #description ⇒ String

  The description of the OTA update.

• #files ⇒ Array<Types::OTAUpdateFile>

  The files to be streamed by the OTA update.

• #ota_update_id ⇒ String

  The ID of the OTA update to be created.

• #protocols ⇒ Array<String>

  The protocol used to transfer the OTA update image.

• #role_arn ⇒ 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.

• #tags ⇒ Array<Types::Tag>

  Metadata which can be used to manage updates.

• #target_selection ⇒ String

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

• #targets ⇒ Array<String>

  The devices targeted to receive OTA updates.

Instance Attribute Details

#additional_parameters ⇒ Hash<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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aws_job_abort_config ⇒ Types::AwsJobAbortConfig

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

Returns:

• (Types::AwsJobAbortConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aws_job_executions_rollout_config ⇒ Types::AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Returns:

• (Types::AwsJobExecutionsRolloutConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aws_job_presigned_url_config ⇒ Types::AwsJobPresignedUrlConfig

Configuration information for pre-signed URLs.

Returns:

• (Types::AwsJobPresignedUrlConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aws_job_timeout_config ⇒ Types::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`.

Returns:

• (Types::AwsJobTimeoutConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the OTA update.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#files ⇒ Array<Types::OTAUpdateFile>

The files to be streamed by the OTA update.

Returns:

• (Array<Types::OTAUpdateFile>)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ota_update_id ⇒ String

The ID of the OTA update to be created.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#protocols ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage updates.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_selection ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<String>

The devices targeted to receive OTA updates.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-iot/types.rb', line 3231

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :protocols,
  :target_selection,
  :aws_job_executions_rollout_config,
  :aws_job_presigned_url_config,
  :aws_job_abort_config,
  :aws_job_timeout_config,
  :files,
  :role_arn,
  :additional_parameters,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end