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

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::CreateImageRequest

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.

• #container_recipe_arn ⇒ String

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

• #distribution_configuration_arn ⇒ String

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

• #enhanced_image_metadata_enabled ⇒ Boolean

  Collects additional information about the image being created, including the operating system (OS) version and package list.

• #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.

• #image_recipe_arn ⇒ String

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

• #image_scanning_configuration ⇒ Types::ImageScanningConfiguration

  Contains settings for vulnerability scans.

• #image_tests_configuration ⇒ Types::ImageTestsConfiguration

  The image tests configuration of the image.

• #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.

• #tags ⇒ Hash<String,String>

  The tags of the image.

• #workflows ⇒ Array<Types::WorkflowConfiguration>

  Contains an array of workflow configuration objects.

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 1557

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

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

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

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_image_metadata_enabled ⇒ Boolean

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Returns:

• (Boolean)

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

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

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

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

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#image_scanning_configuration ⇒ Types::ImageScanningConfiguration

Contains settings for vulnerability scans.

Returns:

• (Types::ImageScanningConfiguration)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#image_tests_configuration ⇒ Types::ImageTestsConfiguration

The image tests configuration of the image.

Returns:

• (Types::ImageTestsConfiguration)

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

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

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags of the image.

Returns:

• (Hash<String,String>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#workflows ⇒ Array<Types::WorkflowConfiguration>

Contains an array of workflow configuration objects.

Returns:

• (Array<Types::WorkflowConfiguration>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end