CfnImagePipelineProps

class aws_cdk.aws_imagebuilder.CfnImagePipelineProps(*, infrastructure_configuration_arn, name, container_recipe_arn=None, description=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, execution_role=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, schedule=None, status=None, tags=None, workflows=None)

Bases: object

Properties for defining a CfnImagePipeline.

Parameters:

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.
container_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
description (Optional[str]) – The description of this image pipeline.
distribution_configuration_arn (Optional[str]) – The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
enhanced_image_metadata_enabled (Union[bool, IResolvable, None]) – 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.
execution_role (Optional[str]) – The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
image_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
image_scanning_configuration (Union[IResolvable, ImageScanningConfigurationProperty, Dict[str, Any], None]) – Contains settings for vulnerability scans.
image_tests_configuration (Union[IResolvable, ImageTestsConfigurationProperty, Dict[str, Any], None]) – The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
schedule (Union[IResolvable, ScheduleProperty, Dict[str, Any], None]) – The schedule of the image pipeline. A schedule configures how often and when a pipeline automatically creates a new image.
status (Optional[str]) – The status of the image pipeline.
tags (Optional[Mapping[str, str]]) – The tags of this image pipeline.
workflows (Union[IResolvable, Sequence[Union[IResolvable, WorkflowConfigurationProperty, Dict[str, Any]]], None]) – Contains the workflows that run for the image pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

cfn_image_pipeline_props = imagebuilder.CfnImagePipelineProps(
    infrastructure_configuration_arn="infrastructureConfigurationArn",
    name="name",

    # the properties below are optional
    container_recipe_arn="containerRecipeArn",
    description="description",
    distribution_configuration_arn="distributionConfigurationArn",
    enhanced_image_metadata_enabled=False,
    execution_role="executionRole",
    image_recipe_arn="imageRecipeArn",
    image_scanning_configuration=imagebuilder.CfnImagePipeline.ImageScanningConfigurationProperty(
        ecr_configuration=imagebuilder.CfnImagePipeline.EcrConfigurationProperty(
            container_tags=["containerTags"],
            repository_name="repositoryName"
        ),
        image_scanning_enabled=False
    ),
    image_tests_configuration=imagebuilder.CfnImagePipeline.ImageTestsConfigurationProperty(
        image_tests_enabled=False,
        timeout_minutes=123
    ),
    schedule=imagebuilder.CfnImagePipeline.ScheduleProperty(
        pipeline_execution_start_condition="pipelineExecutionStartCondition",
        schedule_expression="scheduleExpression"
    ),
    status="status",
    tags={
        "tags_key": "tags"
    },
    workflows=[imagebuilder.CfnImagePipeline.WorkflowConfigurationProperty(
        on_failure="onFailure",
        parallel_group="parallelGroup",
        parameters=[imagebuilder.CfnImagePipeline.WorkflowParameterProperty(
            name="name",
            value=["value"]
        )],
        workflow_arn="workflowArn"
    )]
)

Attributes

container_recipe_arn

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-containerrecipearn

description

The description of this image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-description

distribution_configuration_arn

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-distributionconfigurationarn

enhanced_image_metadata_enabled

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-enhancedimagemetadataenabled

execution_role

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-executionrole

image_recipe_arn

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagerecipearn

image_scanning_configuration

Contains settings for vulnerability scans.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration

image_tests_configuration

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration

infrastructure_configuration_arn

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-infrastructureconfigurationarn

name

The name of the image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-name

schedule

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-schedule

status

The status of the image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-status

tags

The tags of this image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-tags

workflows

Contains the workflows that run for the image pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-workflows