We recommend new projects start with resources from the AWS provider.
aws-native.imagebuilder.ImagePipeline
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::ImageBuilder::ImagePipeline
Create ImagePipeline Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ImagePipeline(name: string, args?: ImagePipelineArgs, opts?: CustomResourceOptions);
@overload
def ImagePipeline(resource_name: str,
args: Optional[ImagePipelineArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ImagePipeline(resource_name: str,
opts: Optional[ResourceOptions] = None,
container_recipe_arn: Optional[str] = None,
description: Optional[str] = None,
distribution_configuration_arn: Optional[str] = None,
enhanced_image_metadata_enabled: Optional[bool] = None,
execution_role: Optional[str] = None,
image_recipe_arn: Optional[str] = None,
image_scanning_configuration: Optional[ImagePipelineImageScanningConfigurationArgs] = None,
image_tests_configuration: Optional[ImagePipelineImageTestsConfigurationArgs] = None,
infrastructure_configuration_arn: Optional[str] = None,
name: Optional[str] = None,
schedule: Optional[ImagePipelineScheduleArgs] = None,
status: Optional[ImagePipelineStatus] = None,
tags: Optional[Mapping[str, str]] = None,
workflows: Optional[Sequence[ImagePipelineWorkflowConfigurationArgs]] = None)
func NewImagePipeline(ctx *Context, name string, args *ImagePipelineArgs, opts ...ResourceOption) (*ImagePipeline, error)
public ImagePipeline(string name, ImagePipelineArgs? args = null, CustomResourceOptions? opts = null)
public ImagePipeline(String name, ImagePipelineArgs args)
public ImagePipeline(String name, ImagePipelineArgs args, CustomResourceOptions options)
type: aws-native:imagebuilder:ImagePipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ImagePipelineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ImagePipelineArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ImagePipelineArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ImagePipelineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ImagePipelineArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ImagePipeline Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ImagePipeline resource accepts the following input properties:
- Container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- Description string
- The description of the image pipeline.
- Distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- Enhanced
Image boolMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- Execution
Role string - The execution role name/ARN for the image build, if provided
- Image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- Image
Scanning Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Pipeline Image Scanning Configuration - Contains settings for vulnerability scans.
- Image
Tests Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Pipeline Image Tests Configuration - The image tests configuration of the image pipeline.
- Infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- Name string
- The name of the image pipeline.
- Schedule
Pulumi.
Aws Native. Image Builder. Inputs. Image Pipeline Schedule - The schedule of the image pipeline.
- Status
Pulumi.
Aws Native. Image Builder. Image Pipeline Status - The status of the image pipeline.
- Dictionary<string, string>
- The tags of this image pipeline.
- Workflows
List<Pulumi.
Aws Native. Image Builder. Inputs. Image Pipeline Workflow Configuration> - Workflows to define the image build process
- Container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- Description string
- The description of the image pipeline.
- Distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- Enhanced
Image boolMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- Execution
Role string - The execution role name/ARN for the image build, if provided
- Image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- Image
Scanning ImageConfiguration Pipeline Image Scanning Configuration Args - Contains settings for vulnerability scans.
- Image
Tests ImageConfiguration Pipeline Image Tests Configuration Args - The image tests configuration of the image pipeline.
- Infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- Name string
- The name of the image pipeline.
- Schedule
Image
Pipeline Schedule Args - The schedule of the image pipeline.
- Status
Image
Pipeline Status - The status of the image pipeline.
- map[string]string
- The tags of this image pipeline.
- Workflows
[]Image
Pipeline Workflow Configuration Args - Workflows to define the image build process
- container
Recipe StringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- description String
- The description of the image pipeline.
- distribution
Configuration StringArn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhanced
Image BooleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role String - The execution role name/ARN for the image build, if provided
- image
Recipe StringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning ImageConfiguration Pipeline Image Scanning Configuration - Contains settings for vulnerability scans.
- image
Tests ImageConfiguration Pipeline Image Tests Configuration - The image tests configuration of the image pipeline.
- infrastructure
Configuration StringArn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name String
- The name of the image pipeline.
- schedule
Image
Pipeline Schedule - The schedule of the image pipeline.
- status
Image
Pipeline Status - The status of the image pipeline.
- Map<String,String>
- The tags of this image pipeline.
- workflows
List<Image
Pipeline Workflow Configuration> - Workflows to define the image build process
- container
Recipe stringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- description string
- The description of the image pipeline.
- distribution
Configuration stringArn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhanced
Image booleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role string - The execution role name/ARN for the image build, if provided
- image
Recipe stringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning ImageConfiguration Pipeline Image Scanning Configuration - Contains settings for vulnerability scans.
- image
Tests ImageConfiguration Pipeline Image Tests Configuration - The image tests configuration of the image pipeline.
- infrastructure
Configuration stringArn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name string
- The name of the image pipeline.
- schedule
Image
Pipeline Schedule - The schedule of the image pipeline.
- status
Image
Pipeline Status - The status of the image pipeline.
- {[key: string]: string}
- The tags of this image pipeline.
- workflows
Image
Pipeline Workflow Configuration[] - Workflows to define the image build process
- container_
recipe_ strarn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- description str
- The description of the image pipeline.
- distribution_
configuration_ strarn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhanced_
image_ boolmetadata_ enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution_
role str - The execution role name/ARN for the image build, if provided
- image_
recipe_ strarn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image_
scanning_ Imageconfiguration Pipeline Image Scanning Configuration Args - Contains settings for vulnerability scans.
- image_
tests_ Imageconfiguration Pipeline Image Tests Configuration Args - The image tests configuration of the image pipeline.
- infrastructure_
configuration_ strarn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name str
- The name of the image pipeline.
- schedule
Image
Pipeline Schedule Args - The schedule of the image pipeline.
- status
Image
Pipeline Status - The status of the image pipeline.
- Mapping[str, str]
- The tags of this image pipeline.
- workflows
Sequence[Image
Pipeline Workflow Configuration Args] - Workflows to define the image build process
- container
Recipe StringArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
- description String
- The description of the image pipeline.
- distribution
Configuration StringArn - The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhanced
Image BooleanMetadata Enabled - Collects additional information about the image being created, including the operating system (OS) version and package list.
- execution
Role String - The execution role name/ARN for the image build, if provided
- image
Recipe StringArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- image
Scanning Property MapConfiguration - Contains settings for vulnerability scans.
- image
Tests Property MapConfiguration - The image tests configuration of the image pipeline.
- infrastructure
Configuration StringArn - The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name String
- The name of the image pipeline.
- schedule Property Map
- The schedule of the image pipeline.
- status "DISABLED" | "ENABLED"
- The status of the image pipeline.
- Map<String>
- The tags of this image pipeline.
- workflows List<Property Map>
- Workflows to define the image build process
Outputs
All input properties are implicitly available as output properties. Additionally, the ImagePipeline resource produces the following output properties:
Supporting Types
ImagePipelineEcrConfiguration, ImagePipelineEcrConfigurationArgs
- List<string>
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- Repository
Name string - 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 to use for vulnerability scans for your output container images.
- []string
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- Repository
Name string - 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 to use for vulnerability scans for your output container images.
- List<String>
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- repository
Name String - 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 to use for vulnerability scans for your output container images.
- string[]
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- repository
Name string - 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 to use for vulnerability scans for your output container images.
- Sequence[str]
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- repository_
name str - 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 to use for vulnerability scans for your output container images.
- List<String>
- Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
- repository
Name String - 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 to use for vulnerability scans for your output container images.
ImagePipelineImageScanningConfiguration, ImagePipelineImageScanningConfigurationArgs
- Ecr
Configuration Pulumi.Aws Native. Image Builder. Inputs. Image Pipeline Ecr Configuration - Contains ECR settings for vulnerability scans.
- Image
Scanning boolEnabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
- Ecr
Configuration ImagePipeline Ecr Configuration - Contains ECR settings for vulnerability scans.
- Image
Scanning boolEnabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
- ecr
Configuration ImagePipeline Ecr Configuration - Contains ECR settings for vulnerability scans.
- image
Scanning BooleanEnabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
- ecr
Configuration ImagePipeline Ecr Configuration - Contains ECR settings for vulnerability scans.
- image
Scanning booleanEnabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
- ecr_
configuration ImagePipeline Ecr Configuration - Contains ECR settings for vulnerability scans.
- image_
scanning_ boolenabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
- ecr
Configuration Property Map - Contains ECR settings for vulnerability scans.
- image
Scanning BooleanEnabled - This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ImagePipelineImageTestsConfiguration, ImagePipelineImageTestsConfigurationArgs
- Image
Tests boolEnabled - Defines if tests should be executed when building this image.
- Timeout
Minutes int - The maximum time in minutes that tests are permitted to run.
- Image
Tests boolEnabled - Defines if tests should be executed when building this image.
- Timeout
Minutes int - The maximum time in minutes that tests are permitted to run.
- image
Tests BooleanEnabled - Defines if tests should be executed when building this image.
- timeout
Minutes Integer - The maximum time in minutes that tests are permitted to run.
- image
Tests booleanEnabled - Defines if tests should be executed when building this image.
- timeout
Minutes number - The maximum time in minutes that tests are permitted to run.
- image_
tests_ boolenabled - Defines if tests should be executed when building this image.
- timeout_
minutes int - The maximum time in minutes that tests are permitted to run.
- image
Tests BooleanEnabled - Defines if tests should be executed when building this image.
- timeout
Minutes Number - The maximum time in minutes that tests are permitted to run.
ImagePipelineSchedule, ImagePipelineScheduleArgs
- Pipeline
Execution Pulumi.Start Condition Aws Native. Image Builder. Image Pipeline Schedule Pipeline Execution Start Condition - The condition configures when the pipeline should trigger a new image build.
- Schedule
Expression string - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- Pipeline
Execution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition - The condition configures when the pipeline should trigger a new image build.
- Schedule
Expression string - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipeline
Execution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition - The condition configures when the pipeline should trigger a new image build.
- schedule
Expression String - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipeline
Execution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition - The condition configures when the pipeline should trigger a new image build.
- schedule
Expression string - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipeline_
execution_ Imagestart_ condition Pipeline Schedule Pipeline Execution Start Condition - The condition configures when the pipeline should trigger a new image build.
- schedule_
expression str - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipeline
Execution "EXPRESSION_MATCH_ONLY" | "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"Start Condition - The condition configures when the pipeline should trigger a new image build.
- schedule
Expression String - The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
ImagePipelineSchedulePipelineExecutionStartCondition, ImagePipelineSchedulePipelineExecutionStartConditionArgs
- Expression
Match Only - EXPRESSION_MATCH_ONLY
- Expression
Match And Dependency Updates Available - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- Image
Pipeline Schedule Pipeline Execution Start Condition Expression Match Only - EXPRESSION_MATCH_ONLY
- Image
Pipeline Schedule Pipeline Execution Start Condition Expression Match And Dependency Updates Available - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- Expression
Match Only - EXPRESSION_MATCH_ONLY
- Expression
Match And Dependency Updates Available - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- Expression
Match Only - EXPRESSION_MATCH_ONLY
- Expression
Match And Dependency Updates Available - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- EXPRESSION_MATCH_ONLY
- EXPRESSION_MATCH_ONLY
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- "EXPRESSION_MATCH_ONLY"
- EXPRESSION_MATCH_ONLY
- "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
ImagePipelineStatus, ImagePipelineStatusArgs
- Disabled
- DISABLED
- Enabled
- ENABLED
- Image
Pipeline Status Disabled - DISABLED
- Image
Pipeline Status Enabled - ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- DISABLED
- DISABLED
- ENABLED
- ENABLED
- "DISABLED"
- DISABLED
- "ENABLED"
- ENABLED
ImagePipelineWorkflowConfiguration, ImagePipelineWorkflowConfigurationArgs
- On
Failure Pulumi.Aws Native. Image Builder. Image Pipeline Workflow Configuration On Failure - Define execution decision in case of workflow failure
- Parallel
Group string - The parallel group name
- Parameters
List<Pulumi.
Aws Native. Image Builder. Inputs. Image Pipeline Workflow Parameter> - The parameters associated with the workflow
- Workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- On
Failure ImagePipeline Workflow Configuration On Failure - Define execution decision in case of workflow failure
- Parallel
Group string - The parallel group name
- Parameters
[]Image
Pipeline Workflow Parameter - The parameters associated with the workflow
- Workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- on
Failure ImagePipeline Workflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel
Group String - The parallel group name
- parameters
List<Image
Pipeline Workflow Parameter> - The parameters associated with the workflow
- workflow
Arn String - The Amazon Resource Name (ARN) of the workflow
- on
Failure ImagePipeline Workflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel
Group string - The parallel group name
- parameters
Image
Pipeline Workflow Parameter[] - The parameters associated with the workflow
- workflow
Arn string - The Amazon Resource Name (ARN) of the workflow
- on_
failure ImagePipeline Workflow Configuration On Failure - Define execution decision in case of workflow failure
- parallel_
group str - The parallel group name
- parameters
Sequence[Image
Pipeline Workflow Parameter] - The parameters associated with the workflow
- workflow_
arn str - The Amazon Resource Name (ARN) of the workflow
- on
Failure "CONTINUE" | "ABORT" - Define execution decision in case of workflow failure
- parallel
Group String - The parallel group name
- parameters List<Property Map>
- The parameters associated with the workflow
- workflow
Arn String - The Amazon Resource Name (ARN) of the workflow
ImagePipelineWorkflowConfigurationOnFailure, ImagePipelineWorkflowConfigurationOnFailureArgs
- Continue
- CONTINUE
- Abort
- ABORT
- Image
Pipeline Workflow Configuration On Failure Continue - CONTINUE
- Image
Pipeline Workflow Configuration On Failure Abort - ABORT
- Continue
- CONTINUE
- Abort
- ABORT
- Continue
- CONTINUE
- Abort
- ABORT
- CONTINUE_
- CONTINUE
- ABORT
- ABORT
- "CONTINUE"
- CONTINUE
- "ABORT"
- ABORT
ImagePipelineWorkflowParameter, ImagePipelineWorkflowParameterArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.