You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Imagebuilder::Types::CreateImagePipelineRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateImagePipelineRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ResourceName", # required
  description: "NonEmptyString",
  image_recipe_arn: "ImageRecipeArn", # required
  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",
    pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
  },
  status: "DISABLED", # accepts DISABLED, ENABLED
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token used to make this request idempotent.

Returns:

  • (String)

    The idempotency token used to make this request idempotent.

#descriptionString

The description of the image pipeline.

Returns:

  • (String)

    The description of the image pipeline.

#distribution_configuration_arnString

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

Returns:

  • (String)

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

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

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

#image_recipe_arnString

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

Returns:

  • (String)

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

#image_tests_configurationTypes::ImageTestsConfiguration

The image test configuration of the image pipeline.

Returns:

#infrastructure_configuration_arnString

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

Returns:

  • (String)

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

#nameString

The name of the image pipeline.

Returns:

  • (String)

    The name of the image pipeline.

#scheduleTypes::Schedule

The schedule of the image pipeline.

Returns:

#statusString

The status of the image pipeline.

Possible values:

  • DISABLED
  • ENABLED

Returns:

  • (String)

    The status of the image pipeline.

#tagsHash<String,String>

The tags of the image pipeline.

Returns:

  • (Hash<String,String>)

    The tags of the image pipeline.