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

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 UpdateImagePipelineRequest data as a hash:

{
  image_pipeline_arn: "ImagePipelineArn", # required
  description: "NonEmptyString",
  image_recipe_arn: "ImageRecipeArn",
  container_recipe_arn: "ContainerRecipeArn",
  infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
  distribution_configuration_arn: "DistributionConfigurationArn",
  image_tests_configuration: {
    image_tests_enabled: false,
    timeout_minutes: 1,
  },
  enhanced_image_metadata_enabled: false,
  schedule: {
    schedule_expression: "NonEmptyString",
    timezone: "Timezone",
    pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
  },
  status: "DISABLED", # accepts DISABLED, ENABLED
  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)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#container_recipe_arnString

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

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#descriptionString

The description of the image pipeline.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#distribution_configuration_arnString

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

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#image_pipeline_arnString

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

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#image_recipe_arnString

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

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#image_tests_configurationTypes::ImageTestsConfiguration

The image test configuration of the image pipeline.



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#infrastructure_configuration_arnString

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

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#scheduleTypes::Schedule

The schedule of the image pipeline.

Returns:



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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

#statusString

The status of the image pipeline.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5599

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