Amazon EC2 Image Builder · JSON Structure

Ec2 Image Builder Update Image Pipeline Request Structure

UpdateImagePipelineRequest schema from EC2 Image Builder

Type: object Properties: 12 Required: 3
Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

UpdateImagePipelineRequest is a JSON Structure definition published by Amazon EC2 Image Builder, describing 12 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

imagePipelineArn description imageRecipeArn containerRecipeArn infrastructureConfigurationArn distributionConfigurationArn imageTestsConfiguration enhancedImageMetadataEnabled schedule status clientToken imageScanningConfiguration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-structure/ec2-image-builder-update-image-pipeline-request-structure.json",
  "name": "UpdateImagePipelineRequest",
  "description": "UpdateImagePipelineRequest schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "imagePipelineArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImagePipelineArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the image pipeline that you want to update."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The description of the image pipeline."
        }
      ]
    },
    "imageRecipeArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageRecipeArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline."
        }
      ]
    },
    "containerRecipeArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContainerRecipeArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the container pipeline to update."
        }
      ]
    },
    "infrastructureConfigurationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InfrastructureConfigurationArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated."
        }
      ]
    },
    "distributionConfigurationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DistributionConfigurationArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated."
        }
      ]
    },
    "imageTestsConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageTestsConfiguration"
        },
        {
          "description": "The image test configuration of the image pipeline."
        }
      ]
    },
    "enhancedImageMetadataEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "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."
        }
      ]
    },
    "schedule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Schedule"
        },
        {
          "description": "The schedule of the image pipeline."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineStatus"
        },
        {
          "description": "The status of the image pipeline."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "The idempotency token used to make this request idempotent."
        }
      ]
    },
    "imageScanningConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageScanningConfiguration"
        },
        {
          "description": "Contains settings for vulnerability scans."
        }
      ]
    }
  },
  "required": [
    "imagePipelineArn",
    "infrastructureConfigurationArn",
    "clientToken"
  ]
}