Class: Aws::Imagebuilder::Types::CreateContainerRecipeRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::CreateContainerRecipeRequest

Defined in:

gems/aws-sdk-imagebuilder/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.

• #components ⇒ Array<Types::ComponentConfiguration>

  Components for build and test that are included in the container recipe.

• #container_type ⇒ String

  The type of container to create.

• #description ⇒ String

  The description of the container recipe.

• #dockerfile_template_data ⇒ String

  The Dockerfile template used to build your image as an inline data blob.

• #dockerfile_template_uri ⇒ String

  The Amazon S3 URI for the Dockerfile that will be used to build your container image.

• #image_os_version_override ⇒ String

  Specifies the operating system version for the base image.

• #instance_configuration ⇒ Types::InstanceConfiguration

  A group of options that can be used to configure an instance for building and testing container images.

• #kms_key_id ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template.

• #name ⇒ String

  The name of the container recipe.

• #parent_image ⇒ String

  The base image for the container recipe.

• #platform_override ⇒ String

  Specifies the operating system platform when you use a custom base image.

• #semantic_version ⇒ String

  The semantic version of the container recipe.

• #tags ⇒ Hash<String,String>

  Tags that are attached to the container recipe.

• #target_repository ⇒ Types::TargetContainerRepository

  The destination repository for the container image.

• #working_directory ⇒ String

  The working directory for use during build and test workflows.

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.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#components ⇒ Array<Types::ComponentConfiguration>

Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Returns:

• (Array<Types::ComponentConfiguration>)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#container_type ⇒ String

The type of container to create.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the container recipe.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dockerfile_template_data ⇒ String

The Dockerfile template used to build your image as an inline data blob.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dockerfile_template_uri ⇒ String

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#image_os_version_override ⇒ String

Specifies the operating system version for the base image.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configuration ⇒ Types::InstanceConfiguration

A group of options that can be used to configure an instance for building and testing container images.

Returns:

• (Types::InstanceConfiguration)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the container recipe.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#parent_image ⇒ String

The base image for the container recipe.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#platform_override ⇒ String

Specifies the operating system platform when you use a custom base image.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

The semantic version of the container 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, with an upper limit of 2³⁰-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)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags that are attached to the container recipe.

Returns:

• (Hash<String,String>)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_repository ⇒ Types::TargetContainerRepository

The destination repository for the container image.

Returns:

• (Types::TargetContainerRepository)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#working_directory ⇒ String

The working directory for use during build and test workflows.

Returns:

• (String)

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

class CreateContainerRecipeRequest < Struct.new(
  :container_type,
  :name,
  :description,
  :semantic_version,
  :components,
  :instance_configuration,
  :dockerfile_template_data,
  :dockerfile_template_uri,
  :platform_override,
  :image_os_version_override,
  :parent_image,
  :tags,
  :working_directory,
  :target_repository,
  :kms_key_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end