Class: Aws::IoT::Types::CreatePackageVersionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreatePackageVersionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[:description, :attributes, :recipe]

Instance Attribute Summary

• #artifact ⇒ Types::PackageVersionArtifact

  The various build components created during the build process such as libraries and configuration files that make up a software package version.

• #attributes ⇒ Hash<String,String>

  Metadata that can be used to define a package version’s configuration.

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

• #description ⇒ String

  A summary of the package version being created.

• #package_name ⇒ String

  The name of the associated software package.

• #recipe ⇒ String

  The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.

• #tags ⇒ Hash<String,String>

  Metadata that can be used to manage the package version.

• #version_name ⇒ String

  The name of the new package version.

Instance Attribute Details

#artifact ⇒ Types::PackageVersionArtifact

The various build components created during the build process such as libraries and configuration files that make up a software package version.

Returns:

• (Types::PackageVersionArtifact)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.

The combined size of all the attributes on a package version is limited to 3KB.

Returns:

• (Hash<String,String>)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#client_token ⇒ String

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#description ⇒ String

A summary of the package version being created. This can be used to outline the package’s contents or purpose.

Returns:

• (String)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#package_name ⇒ String

The name of the associated software package.

Returns:

• (String)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#recipe ⇒ String

The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.

Returns:

• (String)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata that can be used to manage the package version.

Returns:

• (Hash<String,String>)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end

#version_name ⇒ String

The name of the new package version.

Returns:

• (String)

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

class CreatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :recipe,
  :tags,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  include Aws::Structure
end