You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateOTAUpdateRequest data as a hash:

{
  ota_update_id: "OTAUpdateId", # required
  description: "OTAUpdateDescription",
  targets: ["Target"], # required
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  files: [ # required
    {
      file_name: "FileName",
      file_version: "OTAUpdateFileVersion",
      file_source: {
        stream_id: "StreamId",
        file_id: 1,
      },
      code_signing: {
        aws_signer_job_id: "SigningJobId",
        custom_code_signing: {
          signature: {
            stream: {
              stream_id: "StreamId",
              file_id: 1,
            },
            inline_document: "data",
          },
          certificate_chain: {
            stream: {
              stream_id: "StreamId",
              file_id: 1,
            },
            certificate_name: "CertificateName",
            inline_document: "InlineDocument",
          },
          hash_algorithm: "HashAlgorithm",
          signature_algorithm: "SignatureAlgorithm",
        },
      },
      attributes: {
        "Key" => "Value",
      },
    },
  ],
  role_arn: "RoleArn", # required
  additional_parameters: {
    "Key" => "Value",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#additional_parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#descriptionString

The description of the OTA update.

Returns:

  • (String)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#filesArray<Types::OTAUpdateFile>

The files to be streamed by the OTA update.

Returns:



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#ota_update_idString

The ID of the OTA update to be created.

Returns:

  • (String)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#role_arnString

The IAM role that allows access to the AWS IoT Jobs service.

Returns:

  • (String)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#target_selectionString

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)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end

#targetsArray<String>

The targeted devices to receive OTA updates.

Returns:

  • (Array<String>)


1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1288

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :files,
  :role_arn,
  :additional_parameters)
  include Aws::Structure
end