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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  aws_job_executions_rollout_config: {
    maximum_per_minute: 1,
  },
  files: [ # required
    {
      file_name: "FileName",
      file_version: "OTAUpdateFileVersion",
      file_location: {
        stream: {
          stream_id: "StreamId",
          file_id: 1,
        },
        s3_location: {
          bucket: "S3Bucket",
          key: "S3Key",
          version: "S3Version",
        },
      },
      code_signing: {
        aws_signer_job_id: "SigningJobId",
        start_signing_job_parameter: {
          signing_profile_parameter: {
            certificate_arn: "CertificateArn",
            platform: "Platform",
            certificate_path_on_device: "CertificatePathOnDevice",
          },
          signing_profile_name: "SigningProfileName",
          destination: {
            s3_destination: {
              bucket: "S3Bucket",
              prefix: "Prefix",
            },
          },
        },
        custom_code_signing: {
          signature: {
            inline_document: "data",
          },
          certificate_chain: {
            certificate_name: "CertificateName",
            inline_document: "InlineDocument",
          },
          hash_algorithm: "HashAlgorithm",
          signature_algorithm: "SignatureAlgorithm",
        },
      },
      attributes: {
        "AttributeKey" => "Value",
      },
    },
  ],
  role_arn: "RoleArn", # required
  additional_parameters: {
    "AttributeKey" => "Value",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#additional_parameters ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#aws_job_executions_rollout_config ⇒ Types::AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

Returns:



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#description ⇒ String

The description of the OTA update.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#files ⇒ Array<Types::OTAUpdateFile>

The files to be streamed by the OTA update.

Returns:



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#ota_update_id ⇒ String

The ID of the OTA update to be created.

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#role_arn ⇒ String

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

Returns:

  • (String) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

class CreateOTAUpdateRequest < Struct.new(
  :ota_update_id,
  :description,
  :targets,
  :target_selection,
  :aws_job_executions_rollout_config,
  :files,
  :role_arn,
  :additional_parameters)
  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) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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

#targets ⇒ Array<String>

The targeted devices to receive OTA updates.

Returns:

  • (Array<String>) 


2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/aws-sdk-iot/types.rb', line 2195

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