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

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

Overview

Note:

When making an API call, you may pass CreateImageRequest data as a hash:

{
  image_recipe_arn: "ImageRecipeArn",
  container_recipe_arn: "ContainerRecipeArn",
  distribution_configuration_arn: "DistributionConfigurationArn",
  infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
  image_tests_configuration: {
    image_tests_enabled: false,
    timeout_minutes: 1,
  },
  enhanced_image_metadata_enabled: false,
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token used to make this request idempotent.

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

Returns:

  • (String)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#container_recipe_arnString

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

Returns:

  • (String)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#distribution_configuration_arnString

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

Returns:

  • (String)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#enhanced_image_metadata_enabledBoolean

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)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#image_recipe_arnString

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

Returns:

  • (String)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#image_tests_configurationTypes::ImageTestsConfiguration

The image tests configuration of the image.



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#infrastructure_configuration_arnString

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

Returns:

  • (String)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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

#tagsHash<String,String>

The tags of the image.

Returns:

  • (Hash<String,String>)


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1637

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