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:
- ContainerRecipe 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.
- DistributionConfiguration stringArn 
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- EnhancedImage boolMetadata Enabled 
- Collects additional information about the image being created, including the operating system (OS) version and package list.
- ExecutionRole string
- The execution role name/ARN for the image build, if provided
- ImageRecipe stringArn 
- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- ImageScanning Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Pipeline Image Scanning Configuration 
- Contains settings for vulnerability scans.
- ImageTests Pulumi.Configuration Aws Native. Image Builder. Inputs. Image Pipeline Image Tests Configuration 
- The image tests configuration of the image pipeline.
- InfrastructureConfiguration 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
- ContainerRecipe 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.
- DistributionConfiguration stringArn 
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- EnhancedImage boolMetadata Enabled 
- Collects additional information about the image being created, including the operating system (OS) version and package list.
- ExecutionRole string
- The execution role name/ARN for the image build, if provided
- ImageRecipe stringArn 
- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- ImageScanning ImageConfiguration Pipeline Image Scanning Configuration Args 
- Contains settings for vulnerability scans.
- ImageTests ImageConfiguration Pipeline Image Tests Configuration Args 
- The image tests configuration of the image pipeline.
- InfrastructureConfiguration stringArn 
- The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- Name string
- The name of the image pipeline.
- Schedule
ImagePipeline Schedule Args 
- The schedule of the image pipeline.
- Status
ImagePipeline Status 
- The status of the image pipeline.
- map[string]string
- The tags of this image pipeline.
- Workflows
[]ImagePipeline Workflow Configuration Args 
- Workflows to define the image build process
- containerRecipe 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.
- distributionConfiguration StringArn 
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhancedImage BooleanMetadata Enabled 
- Collects additional information about the image being created, including the operating system (OS) version and package list.
- executionRole String
- The execution role name/ARN for the image build, if provided
- imageRecipe StringArn 
- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- imageScanning ImageConfiguration Pipeline Image Scanning Configuration 
- Contains settings for vulnerability scans.
- imageTests ImageConfiguration Pipeline Image Tests Configuration 
- The image tests configuration of the image pipeline.
- infrastructureConfiguration StringArn 
- The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name String
- The name of the image pipeline.
- schedule
ImagePipeline Schedule 
- The schedule of the image pipeline.
- status
ImagePipeline Status 
- The status of the image pipeline.
- Map<String,String>
- The tags of this image pipeline.
- workflows
List<ImagePipeline Workflow Configuration> 
- Workflows to define the image build process
- containerRecipe 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.
- distributionConfiguration stringArn 
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhancedImage booleanMetadata Enabled 
- Collects additional information about the image being created, including the operating system (OS) version and package list.
- executionRole string
- The execution role name/ARN for the image build, if provided
- imageRecipe stringArn 
- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- imageScanning ImageConfiguration Pipeline Image Scanning Configuration 
- Contains settings for vulnerability scans.
- imageTests ImageConfiguration Pipeline Image Tests Configuration 
- The image tests configuration of the image pipeline.
- infrastructureConfiguration stringArn 
- The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- name string
- The name of the image pipeline.
- schedule
ImagePipeline Schedule 
- The schedule of the image pipeline.
- status
ImagePipeline Status 
- The status of the image pipeline.
- {[key: string]: string}
- The tags of this image pipeline.
- workflows
ImagePipeline 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
ImagePipeline Schedule Args 
- The schedule of the image pipeline.
- status
ImagePipeline Status 
- The status of the image pipeline.
- Mapping[str, str]
- The tags of this image pipeline.
- workflows
Sequence[ImagePipeline Workflow Configuration Args] 
- Workflows to define the image build process
- containerRecipe 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.
- distributionConfiguration StringArn 
- The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhancedImage BooleanMetadata Enabled 
- Collects additional information about the image being created, including the operating system (OS) version and package list.
- executionRole String
- The execution role name/ARN for the image build, if provided
- imageRecipe StringArn 
- The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
- imageScanning Property MapConfiguration 
- Contains settings for vulnerability scans.
- imageTests Property MapConfiguration 
- The image tests configuration of the image pipeline.
- infrastructureConfiguration 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.
- RepositoryName 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.
- RepositoryName 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.
- repositoryName 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.
- repositoryName 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.
- repositoryName 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          
- EcrConfiguration Pulumi.Aws Native. Image Builder. Inputs. Image Pipeline Ecr Configuration 
- Contains ECR settings for vulnerability scans.
- ImageScanning 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.
- EcrConfiguration ImagePipeline Ecr Configuration 
- Contains ECR settings for vulnerability scans.
- ImageScanning 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.
- ecrConfiguration ImagePipeline Ecr Configuration 
- Contains ECR settings for vulnerability scans.
- imageScanning 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.
- ecrConfiguration ImagePipeline Ecr Configuration 
- Contains ECR settings for vulnerability scans.
- imageScanning 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.
- ecrConfiguration Property Map
- Contains ECR settings for vulnerability scans.
- imageScanning 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          
- ImageTests boolEnabled 
- Defines if tests should be executed when building this image.
- TimeoutMinutes int
- The maximum time in minutes that tests are permitted to run.
- ImageTests boolEnabled 
- Defines if tests should be executed when building this image.
- TimeoutMinutes int
- The maximum time in minutes that tests are permitted to run.
- imageTests BooleanEnabled 
- Defines if tests should be executed when building this image.
- timeoutMinutes Integer
- The maximum time in minutes that tests are permitted to run.
- imageTests booleanEnabled 
- Defines if tests should be executed when building this image.
- timeoutMinutes 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.
- imageTests BooleanEnabled 
- Defines if tests should be executed when building this image.
- timeoutMinutes Number
- The maximum time in minutes that tests are permitted to run.
ImagePipelineSchedule, ImagePipelineScheduleArgs      
- PipelineExecution 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.
- ScheduleExpression string
- The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- PipelineExecution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition 
- The condition configures when the pipeline should trigger a new image build.
- ScheduleExpression string
- The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipelineExecution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition 
- The condition configures when the pipeline should trigger a new image build.
- scheduleExpression String
- The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
- pipelineExecution ImageStart Condition Pipeline Schedule Pipeline Execution Start Condition 
- The condition configures when the pipeline should trigger a new image build.
- scheduleExpression 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.
- pipelineExecution "EXPRESSION_MATCH_ONLY" | "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"Start Condition 
- The condition configures when the pipeline should trigger a new image build.
- scheduleExpression String
- The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
ImagePipelineSchedulePipelineExecutionStartCondition, ImagePipelineSchedulePipelineExecutionStartConditionArgs              
- ExpressionMatch Only 
- EXPRESSION_MATCH_ONLY
- ExpressionMatch And Dependency Updates Available 
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- ImagePipeline Schedule Pipeline Execution Start Condition Expression Match Only 
- EXPRESSION_MATCH_ONLY
- ImagePipeline Schedule Pipeline Execution Start Condition Expression Match And Dependency Updates Available 
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- ExpressionMatch Only 
- EXPRESSION_MATCH_ONLY
- ExpressionMatch And Dependency Updates Available 
- EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
- ExpressionMatch Only 
- EXPRESSION_MATCH_ONLY
- ExpressionMatch 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
- ImagePipeline Status Disabled 
- DISABLED
- ImagePipeline Status Enabled 
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- DISABLED
- DISABLED
- ENABLED
- ENABLED
- "DISABLED"
- DISABLED
- "ENABLED"
- ENABLED
ImagePipelineWorkflowConfiguration, ImagePipelineWorkflowConfigurationArgs        
- OnFailure Pulumi.Aws Native. Image Builder. Image Pipeline Workflow Configuration On Failure 
- Define execution decision in case of workflow failure
- ParallelGroup string
- The parallel group name
- Parameters
List<Pulumi.Aws Native. Image Builder. Inputs. Image Pipeline Workflow Parameter> 
- The parameters associated with the workflow
- WorkflowArn string
- The Amazon Resource Name (ARN) of the workflow
- OnFailure ImagePipeline Workflow Configuration On Failure 
- Define execution decision in case of workflow failure
- ParallelGroup string
- The parallel group name
- Parameters
[]ImagePipeline Workflow Parameter 
- The parameters associated with the workflow
- WorkflowArn string
- The Amazon Resource Name (ARN) of the workflow
- onFailure ImagePipeline Workflow Configuration On Failure 
- Define execution decision in case of workflow failure
- parallelGroup String
- The parallel group name
- parameters
List<ImagePipeline Workflow Parameter> 
- The parameters associated with the workflow
- workflowArn String
- The Amazon Resource Name (ARN) of the workflow
- onFailure ImagePipeline Workflow Configuration On Failure 
- Define execution decision in case of workflow failure
- parallelGroup string
- The parallel group name
- parameters
ImagePipeline Workflow Parameter[] 
- The parameters associated with the workflow
- workflowArn 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[ImagePipeline Workflow Parameter] 
- The parameters associated with the workflow
- workflow_arn str
- The Amazon Resource Name (ARN) of the workflow
- onFailure "CONTINUE" | "ABORT"
- Define execution decision in case of workflow failure
- parallelGroup String
- The parallel group name
- parameters List<Property Map>
- The parameters associated with the workflow
- workflowArn String
- The Amazon Resource Name (ARN) of the workflow
ImagePipelineWorkflowConfigurationOnFailure, ImagePipelineWorkflowConfigurationOnFailureArgs            
- Continue
- CONTINUE
- Abort
- ABORT
- ImagePipeline Workflow Configuration On Failure Continue 
- CONTINUE
- ImagePipeline 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.