Class: Aws::Imagebuilder::Types::ImportVmImageRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::ImportVmImageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure idempotency of the request.

• #description ⇒ String

  The description for the base image that is created by the import process.

• #name ⇒ String

  The name of the base image that is created by the import process.

• #os_version ⇒ String

  The operating system version for the imported VM.

• #platform ⇒ String

  The operating system platform for the imported VM.

• #semantic_version ⇒ String

  The semantic version to attach to the base image that was created during the import process.

• #tags ⇒ Hash<String,String>

  Tags that are attached to the import resources.

• #vm_import_task_id ⇒ String

  The ‘importTaskId` (API) or `ImportTaskId` (CLI) from the Amazon EC2 VM import process.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see [Ensuring idempotency] in the *Amazon EC2 API Reference*.

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the base image that is created by the import process.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the base image that is created by the import process.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#os_version ⇒ String

The operating system version for the imported VM.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The operating system platform for the imported VM.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

<note markdown=“1”> The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.

**Assignment:** For the first three nodes you can assign any

positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

**Patterns:** You can use any numeric pattern that adheres to the

assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags that are attached to the import resources.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#vm_import_task_id ⇒ String

The ‘importTaskId` (API) or `ImportTaskId` (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 4593

class ImportVmImageRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :platform,
  :os_version,
  :vm_import_task_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end