CreateImagePipelineRequest

CreateImagePipelineRequest schema from EC2 Image Builder

Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

Properties

Name Type Description
name object
description object
imageRecipeArn object
containerRecipeArn object
infrastructureConfigurationArn object
distributionConfigurationArn object
imageTestsConfiguration object
enhancedImageMetadataEnabled object
schedule object
status object
tags object
clientToken object
imageScanningConfiguration object
View JSON Schema on GitHub

JSON Schema

ec2-image-builder-create-image-pipeline-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-schema/ec2-image-builder-create-image-pipeline-request-schema.json",
  "title": "CreateImagePipelineRequest",
  "description": "CreateImagePipelineRequest schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the image pipeline."
        }
      ]
    },
    "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 created by this image pipeline."
        }
      ]
    },
    "containerRecipeArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContainerRecipeArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline."
        }
      ]
    },
    "infrastructureConfigurationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InfrastructureConfigurationArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline."
        }
      ]
    },
    "distributionConfigurationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DistributionConfigurationArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline."
        }
      ]
    },
    "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."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "The tags 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": [
    "name",
    "infrastructureConfigurationArn",
    "clientToken"
  ]
}