The maximum time in minutes that tests are permitted to run.
The timeoutMinutes attribute is not currently active. This value is ignored.
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
timezone: allOf: - $ref: '#/components/schemas/Timezone' - description: The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC. pipelineExecutionStartCondition: allOf: - $ref: '#/components/schemas/PipelineExecutionStartCondition' - description: The condition configures when the pipeline should trigger a new image build. When thepipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.
status:
description: The status of the image pipeline.
type: string
enum:
- DISABLED
- ENABLED
tags:
description: The tags of the image pipeline.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
clientToken:
description: The idempotency token used to make this request idempotent.
type: string
minLength: 1
maxLength: 36
imageScanningConfiguration:
description: Contains settings for Image Builder image resource and container image scans.
type: object
properties:
imageScanningEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration:
allOf:
- $ref: '#/components/schemas/EcrConfiguration'
- description: Contains Amazon ECR settings for vulnerability scans.
summary: Amazon EC2 Image Builder Create Image Pipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- CreateImagePipeline
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
schemas:
StringList:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
NonEmptyString:
type: string
minLength: 1
maxLength: 1024
ImageTestsTimeoutMinutes:
type: integer
minimum: 60
maximum: 1440
ImagePipelineArn:
type: string
pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$
ServiceException: {}
ForbiddenException: {}
PipelineExecutionStartCondition:
type: string
enum:
- EXPRESSION_MATCH_ONLY
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
ServiceUnavailableException: {}
ResourceAlreadyExistsException: {}
Timezone:
type: string
pattern: '[a-zA-Z0-9]{2,}(?:\/[a-zA-z0-9-_+]+)*'
minLength: 3
maxLength: 100
IdempotentParameterMismatchException: {}
CallRateLimitExceededException: {}
TagValue:
type: string
maxLength: 256
ClientToken:
type: string
minLength: 1
maxLength: 36
ClientException: {}
InvalidRequestException: {}
CreateImagePipelineResponse:
type: object
properties:
requestId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The request ID that uniquely identifies this request.
example: example-id-1234
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: The idempotency token used to make this request idempotent.
example: example-string
imagePipelineArn:
allOf:
- $ref: '#/components/schemas/ImagePipelineArn'
- description: The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
example: arn:aws:service:us-east-1:123456789012:resource/example
NullableBoolean:
type: boolean
ResourceInUseException: {}
ServiceQuotaExceededException: {}
EcrConfiguration:
type: object
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
example: example-resource-name
containerTags:
allOf:
- $ref: '#/components/schemas/StringList'
- description: Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.
example: example-string
description: Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/imagebuilder/
x-hasEquivalentPaths: true