Class: Aws::Imagebuilder::Types::CreateImageRequest

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

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


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#container_recipe_arn ⇒ String

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Returns:

  • (String) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Returns:

  • (String) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_image_metadata_enabled ⇒ Boolean

Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

Returns:

  • (Boolean) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ String

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Returns:

  • (String) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#image_recipe_arn ⇒ String

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Returns:

  • (String) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#image_scanning_configuration ⇒ Types::ImageScanningConfiguration

Contains settings for vulnerability scans.

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#image_tests_configuration ⇒ Types::ImageTestsConfiguration

The image tests configuration of the image.

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Returns:

  • (String) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configuration ⇒ Types::ImageLoggingConfiguration

The logging configuration for the image build process.

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags of the image.

Returns:

  • (Hash<String,String>) 


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#workflows ⇒ Array<Types::WorkflowConfiguration>

Contains an array of workflow configuration objects.

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1774

class CreateImageRequest < Struct.new(
  :image_recipe_arn,
  :container_recipe_arn,
  :distribution_configuration_arn,
  :infrastructure_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :tags,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :execution_role,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end