1. Packages
  2. AWS Native
  3. API Docs
  4. imagebuilder
  5. ImagePipeline

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

aws-native.imagebuilder.ImagePipeline

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

    Resource schema for AWS::ImageBuilder::ImagePipeline

    Create ImagePipeline Resource

    new ImagePipeline(name: string, args?: ImagePipelineArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def ImagePipeline(resource_name: str,
                      args: Optional[ImagePipelineArgs] = None,
                      opts: Optional[ResourceOptions] = 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.
    
    
    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

    The ImagePipeline resource accepts the following input properties:

    ContainerRecipeArn string
    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.
    DistributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    EnhancedImageMetadataEnabled bool
    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
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    ImageTestsConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    Name string
    The name of the image pipeline.
    Schedule Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineSchedule
    The schedule of the image pipeline.
    Status Pulumi.AwsNative.ImageBuilder.ImagePipelineStatus
    The status of the image pipeline.
    Tags Dictionary<string, string>
    The tags of this image pipeline.
    Workflows List<Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineWorkflowConfiguration>
    Workflows to define the image build process
    ContainerRecipeArn string
    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.
    DistributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    EnhancedImageMetadataEnabled bool
    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
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration ImagePipelineImageScanningConfigurationArgs
    Contains settings for vulnerability scans.
    ImageTestsConfiguration ImagePipelineImageTestsConfigurationArgs
    The image tests configuration of the image pipeline.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    Name string
    The name of the image pipeline.
    Schedule ImagePipelineScheduleArgs
    The schedule of the image pipeline.
    Status ImagePipelineStatus
    The status of the image pipeline.
    Tags map[string]string
    The tags of this image pipeline.
    Workflows []ImagePipelineWorkflowConfigurationArgs
    Workflows to define the image build process
    containerRecipeArn String
    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.
    distributionConfigurationArn String
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled Boolean
    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
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn String
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    name String
    The name of the image pipeline.
    schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags Map<String,String>
    The tags of this image pipeline.
    workflows List<ImagePipelineWorkflowConfiguration>
    Workflows to define the image build process
    containerRecipeArn string
    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.
    distributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled boolean
    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
    imageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    name string
    The name of the image pipeline.
    schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags {[key: string]: string}
    The tags of this image pipeline.
    workflows ImagePipelineWorkflowConfiguration[]
    Workflows to define the image build process
    container_recipe_arn str
    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_arn str
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhanced_image_metadata_enabled bool
    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_arn str
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    image_scanning_configuration ImagePipelineImageScanningConfigurationArgs
    Contains settings for vulnerability scans.
    image_tests_configuration ImagePipelineImageTestsConfigurationArgs
    The image tests configuration of the image pipeline.
    infrastructure_configuration_arn str
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    name str
    The name of the image pipeline.
    schedule ImagePipelineScheduleArgs
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags Mapping[str, str]
    The tags of this image pipeline.
    workflows Sequence[ImagePipelineWorkflowConfigurationArgs]
    Workflows to define the image build process
    containerRecipeArn String
    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.
    distributionConfigurationArn String
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled Boolean
    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
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration Property Map
    Contains settings for vulnerability scans.
    imageTestsConfiguration Property Map
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn String
    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.
    tags 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:

    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the image pipeline.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ImagePipelineEcrConfiguration, ImagePipelineEcrConfigurationArgs

    ContainerTags 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.
    ContainerTags []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.
    containerTags 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.
    containerTags 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.
    container_tags 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.
    containerTags 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.AwsNative.ImageBuilder.Inputs.ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    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 ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    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 ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled Boolean
    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 ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled boolean
    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 ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    image_scanning_enabled bool
    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.
    imageScanningEnabled Boolean
    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

    ImageTestsEnabled bool
    Defines if tests should be executed when building this image.
    TimeoutMinutes int
    The maximum time in minutes that tests are permitted to run.
    ImageTestsEnabled bool
    Defines if tests should be executed when building this image.
    TimeoutMinutes int
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled Boolean
    Defines if tests should be executed when building this image.
    timeoutMinutes Integer
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled boolean
    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_enabled bool
    Defines if tests should be executed when building this image.
    timeout_minutes int
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled Boolean
    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

    PipelineExecutionStartCondition Pulumi.AwsNative.ImageBuilder.ImagePipelineSchedulePipelineExecutionStartCondition
    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.
    PipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    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.
    pipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    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.
    pipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    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_start_condition ImagePipelineSchedulePipelineExecutionStartCondition
    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.
    pipelineExecutionStartCondition "EXPRESSION_MATCH_ONLY" | "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    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

    ExpressionMatchOnly
    EXPRESSION_MATCH_ONLY
    ExpressionMatchAndDependencyUpdatesAvailable
    EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
    ImagePipelineSchedulePipelineExecutionStartConditionExpressionMatchOnly
    EXPRESSION_MATCH_ONLY
    ImagePipelineSchedulePipelineExecutionStartConditionExpressionMatchAndDependencyUpdatesAvailable
    EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
    ExpressionMatchOnly
    EXPRESSION_MATCH_ONLY
    ExpressionMatchAndDependencyUpdatesAvailable
    EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
    ExpressionMatchOnly
    EXPRESSION_MATCH_ONLY
    ExpressionMatchAndDependencyUpdatesAvailable
    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
    ImagePipelineStatusDisabled
    DISABLED
    ImagePipelineStatusEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    ImagePipelineWorkflowConfiguration, ImagePipelineWorkflowConfigurationArgs

    OnFailure Pulumi.AwsNative.ImageBuilder.ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters List<Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineWorkflowParameter>
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    OnFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters []ImagePipelineWorkflowParameter
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup String
    The parallel group name
    parameters List<ImagePipelineWorkflowParameter>
    The parameters associated with the workflow
    workflowArn String
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup string
    The parallel group name
    parameters ImagePipelineWorkflowParameter[]
    The parameters associated with the workflow
    workflowArn string
    The Amazon Resource Name (ARN) of the workflow
    on_failure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallel_group str
    The parallel group name
    parameters Sequence[ImagePipelineWorkflowParameter]
    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
    ImagePipelineWorkflowConfigurationOnFailureContinue
    CONTINUE
    ImagePipelineWorkflowConfigurationOnFailureAbort
    ABORT
    Continue
    CONTINUE
    Abort
    ABORT
    Continue
    CONTINUE
    Abort
    ABORT
    CONTINUE_
    CONTINUE
    ABORT
    ABORT
    "CONTINUE"
    CONTINUE
    "ABORT"
    ABORT

    ImagePipelineWorkflowParameter, ImagePipelineWorkflowParameterArgs

    Name string
    Value List<string>
    Name string
    Value []string
    name String
    value List<String>
    name string
    value string[]
    name str
    value Sequence[str]
    name String
    value List<String>

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi