Class: Aws::Imagebuilder::Types::CreateImageRecipeRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_instance_configuration ⇒ Types::AdditionalInstanceConfiguration

Specify additional settings and launch scripts for your build instances.

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

The block device mappings of the image recipe.

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

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


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#components ⇒ Array<Types::ComponentConfiguration>

The components included in the image recipe.

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the image recipe.

Returns:

  • (String) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the image recipe.

Returns:

  • (String) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#parent_image ⇒ String

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: ‘arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x`. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Returns:

  • (String) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

The semantic version of the image recipe. 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) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags of the image recipe.

Returns:

  • (Hash<String,String>) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#working_directory ⇒ String

The working directory used during build and test workflows.

Returns:

  • (String) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/aws-sdk-imagebuilder/types.rb', line 1445

class CreateImageRecipeRequest < Struct.new(
  :name,
  :description,
  :semantic_version,
  :components,
  :parent_image,
  :block_device_mappings,
  :tags,
  :working_directory,
  :additional_instance_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end