Class: Aws::Imagebuilder::Types::UpdateImagePipelineRequest

Inherits:

Struct

Object
Struct
Aws::Imagebuilder::Types::UpdateImagePipelineRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-imagebuilder/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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 pipeline to update.
#description ⇒ String

The description of the image pipeline.
#distribution_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
#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_pipeline_arn ⇒ String

The Amazon Resource Name (ARN) of the image pipeline that you want to update.
#image_recipe_arn ⇒ String

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
#image_scanning_configuration ⇒ Types::ImageScanningConfiguration

Contains settings for vulnerability scans.
#image_tags ⇒ Hash<String,String>

The tags to be applied to the images produced by this pipeline.
#image_tests_configuration ⇒ Types::ImageTestsConfiguration

The image test configuration of the image pipeline.
#infrastructure_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
#logging_configuration ⇒ Types::PipelineLoggingConfiguration

Update logging configuration for the output image that’s created when the pipeline runs.
#schedule ⇒ Types::Schedule

The schedule of the image pipeline.
#status ⇒ String

The status of the image pipeline.
#workflows ⇒ Array<Types::WorkflowConfiguration>

Contains the workflows to run for the pipeline.

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 8565

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#container_recipe_arn ⇒ `String`

The Amazon Resource Name (ARN) of the container pipeline to update.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the image pipeline.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_configuration_arn ⇒ `String`

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  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 8565

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  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 8565

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_pipeline_arn ⇒ `String`

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_recipe_arn ⇒ `String`

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  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 8565

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_tags ⇒ `Hash<String,String>`

The tags to be applied to the images produced by this pipeline.

Returns:

(Hash<String,String>)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_tests_configuration ⇒ `Types::ImageTestsConfiguration`

The image test configuration of the image pipeline.

Returns:

(Types::ImageTestsConfiguration)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_configuration_arn ⇒ `String`

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configuration ⇒ `Types::PipelineLoggingConfiguration`

Update logging configuration for the output image that’s created when the pipeline runs.

Returns:

(Types::PipelineLoggingConfiguration)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ `Types::Schedule`

The schedule of the image pipeline.

Returns:

(Types::Schedule)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the image pipeline.

Returns:

(String)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

#workflows ⇒ `Array<Types::WorkflowConfiguration>`

Contains the workflows to run for the pipeline.

Returns:

(Array<Types::WorkflowConfiguration>)

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

class UpdateImagePipelineRequest < Struct.new(
  :image_pipeline_arn,
  :description,
  :image_recipe_arn,
  :container_recipe_arn,
  :infrastructure_configuration_arn,
  :distribution_configuration_arn,
  :image_tests_configuration,
  :enhanced_image_metadata_enabled,
  :schedule,
  :status,
  :client_token,
  :image_scanning_configuration,
  :workflows,
  :logging_configuration,
  :execution_role,
  :image_tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Imagebuilder::Types::UpdateImagePipelineRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

#container_recipe_arn ⇒ String

#description ⇒ String

#distribution_configuration_arn ⇒ String

#enhanced_image_metadata_enabled ⇒ Boolean

#execution_role ⇒ String

#image_pipeline_arn ⇒ String

#image_recipe_arn ⇒ String

#image_scanning_configuration ⇒ Types::ImageScanningConfiguration

#image_tags ⇒ Hash<String,String>

#image_tests_configuration ⇒ Types::ImageTestsConfiguration

#infrastructure_configuration_arn ⇒ String

#logging_configuration ⇒ Types::PipelineLoggingConfiguration

#schedule ⇒ Types::Schedule

#status ⇒ String

#workflows ⇒ Array<Types::WorkflowConfiguration>

#client_token ⇒ `String`

#container_recipe_arn ⇒ `String`

#description ⇒ `String`

#distribution_configuration_arn ⇒ `String`

#enhanced_image_metadata_enabled ⇒ `Boolean`

#execution_role ⇒ `String`

#image_pipeline_arn ⇒ `String`

#image_recipe_arn ⇒ `String`

#image_scanning_configuration ⇒ `Types::ImageScanningConfiguration`

#image_tags ⇒ `Hash<String,String>`

#image_tests_configuration ⇒ `Types::ImageTestsConfiguration`

#infrastructure_configuration_arn ⇒ `String`

#logging_configuration ⇒ `Types::PipelineLoggingConfiguration`

#schedule ⇒ `Types::Schedule`

#status ⇒ `String`

#workflows ⇒ `Array<Types::WorkflowConfiguration>`