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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/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

The additional settings and launch scripts for your build instances.

Returns:



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#ami_tags ⇒ Hash<String,String>

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Returns:

  • (Hash<String,String>) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#ami_watermarks ⇒ Array<String>

The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

Returns:

  • (Array<String>) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

The block device mappings of the image recipe.

Returns:



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#client_token ⇒ String

A unique, case-sensitive identifier you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error. 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.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#components ⇒ Array<Types::ComponentConfiguration>

The components included in the image recipe.

Returns:



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#description ⇒ String

The description of the image recipe.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#dry_run ⇒ Boolean

Validates the required permissions and request parameters without making the request. If validation succeeds, the operation returns a DryRunOperationException error response.

Returns:

  • (Boolean) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#name ⇒ String

The name of the image recipe.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#parent_image ⇒ String

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:

  • AMI ID

  • Image Builder image Amazon Resource Name (ARN)

  • Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

  • Amazon Web Services Marketplace product ID

If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI, and the AMI must be in the source Region.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#semantic_version ⇒ String

The semantic version of the image recipe. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 230-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.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#tags ⇒ Hash<String,String>

The tags of the image recipe.

Returns:

  • (Hash<String,String>) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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

#working_directory ⇒ String

The working directory used during build and test workflows.

Returns:

  • (String) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1658

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