CfnImagePipelinePropsMixin

class aws_cdk.mixins_preview.aws_imagebuilder.mixins.CfnImagePipelinePropsMixin(props, *, strategy=None)

Bases: Mixin

An image pipeline is the automation configuration for building secure OS images on AWS .

The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance types, a subnet for your VPC, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html
CloudformationResource:: AWS::ImageBuilder::ImagePipeline
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

cfn_image_pipeline_props_mixin = imagebuilder_mixins.CfnImagePipelinePropsMixin(imagebuilder_mixins.CfnImagePipelineMixinProps(
    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_mixins.CfnImagePipelinePropsMixin.ImageScanningConfigurationProperty(
        ecr_configuration=imagebuilder_mixins.CfnImagePipelinePropsMixin.EcrConfigurationProperty(
            container_tags=["containerTags"],
            repository_name="repositoryName"
        ),
        image_scanning_enabled=False
    ),
    image_tests_configuration=imagebuilder_mixins.CfnImagePipelinePropsMixin.ImageTestsConfigurationProperty(
        image_tests_enabled=False,
        timeout_minutes=123
    ),
    infrastructure_configuration_arn="infrastructureConfigurationArn",
    logging_configuration=imagebuilder_mixins.CfnImagePipelinePropsMixin.PipelineLoggingConfigurationProperty(
        image_log_group_name="imageLogGroupName",
        pipeline_log_group_name="pipelineLogGroupName"
    ),
    name="name",
    schedule=imagebuilder_mixins.CfnImagePipelinePropsMixin.ScheduleProperty(
        auto_disable_policy=imagebuilder_mixins.CfnImagePipelinePropsMixin.AutoDisablePolicyProperty(
            failure_count=123
        ),
        pipeline_execution_start_condition="pipelineExecutionStartCondition",
        schedule_expression="scheduleExpression"
    ),
    status="status",
    tags={
        "tags_key": "tags"
    },
    workflows=[imagebuilder_mixins.CfnImagePipelinePropsMixin.WorkflowConfigurationProperty(
        on_failure="onFailure",
        parallel_group="parallelGroup",
        parameters=[imagebuilder_mixins.CfnImagePipelinePropsMixin.WorkflowParameterProperty(
            name="name",
            value=["value"]
        )],
        workflow_arn="workflowArn"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ImageBuilder::ImagePipeline.

Parameters:

props (Union[CfnImagePipelineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['containerRecipeArn', 'description', 'distributionConfigurationArn', 'enhancedImageMetadataEnabled', 'executionRole', 'imageRecipeArn', 'imageScanningConfiguration', 'imageTestsConfiguration', 'infrastructureConfigurationArn', 'loggingConfiguration', 'name', 'schedule', 'status', 'tags', 'workflows']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AutoDisablePolicyProperty

class CfnImagePipelinePropsMixin.AutoDisablePolicyProperty(*, failure_count=None)

Bases: object

Defines the rules by which an image pipeline is automatically disabled when it fails.

Parameters:: failure_count (Union[int, float, None]) – The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-autodisablepolicy.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

auto_disable_policy_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.AutoDisablePolicyProperty(
    failure_count=123
)

Attributes

failure_count

The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-autodisablepolicy.html#cfn-imagebuilder-imagepipeline-autodisablepolicy-failurecount

EcrConfigurationProperty

class CfnImagePipelinePropsMixin.EcrConfigurationProperty(*, container_tags=None, repository_name=None)

Bases: object

Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.

Parameters:

container_tags (Optional[Sequence[str]]) – Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images.
repository_name (Optional[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 for vulnerability scans of your output container images.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

ecr_configuration_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.EcrConfigurationProperty(
    container_tags=["containerTags"],
    repository_name="repositoryName"
)

Attributes

container_tags

Tags for Image Builder to apply to the output container image that Amazon Inspector scans.

Tags can help you identify and manage your scanned images.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html#cfn-imagebuilder-imagepipeline-ecrconfiguration-containertags

repository_name

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html#cfn-imagebuilder-imagepipeline-ecrconfiguration-repositoryname

ImageScanningConfigurationProperty

class CfnImagePipelinePropsMixin.ImageScanningConfigurationProperty(*, ecr_configuration=None, image_scanning_enabled=None)

Bases: object

Contains settings for Image Builder image resource and container image scans.

Parameters:

ecr_configuration (Union[IResolvable, EcrConfigurationProperty, Dict[str, Any], None]) – Contains Amazon ECR settings for vulnerability scans.
image_scanning_enabled (Union[bool, IResolvable, None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

image_scanning_configuration_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.ImageScanningConfigurationProperty(
    ecr_configuration=imagebuilder_mixins.CfnImagePipelinePropsMixin.EcrConfigurationProperty(
        container_tags=["containerTags"],
        repository_name="repositoryName"
    ),
    image_scanning_enabled=False
)

Attributes

ecr_configuration

Contains Amazon ECR settings for vulnerability scans.

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

image_scanning_enabled

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.

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

ImageTestsConfigurationProperty

class CfnImagePipelinePropsMixin.ImageTestsConfigurationProperty(*, image_tests_enabled=None, timeout_minutes=None)

Bases: object

When you create an image or container recipe with Image Builder , you can add the build or test components that your image pipeline uses to create the final image.

You must have at least one build component to create a recipe, but test components are not required. Your pipeline runs tests after it builds the image, to ensure that the target image is functional and can be used reliably for launching Amazon EC2 instances.

Parameters:

image_tests_enabled (Union[bool, IResolvable, None]) – Defines if tests should be executed when building this image. For example, true or false .
timeout_minutes (Union[int, float, None]) – The maximum time in minutes that tests are permitted to run. .. epigraph:: The timeout property is not currently active. This value is ignored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagetestsconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

image_tests_configuration_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.ImageTestsConfigurationProperty(
    image_tests_enabled=False,
    timeout_minutes=123
)

Attributes

image_tests_enabled

Defines if tests should be executed when building this image.

For example, true or false .

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

timeout_minutes

The maximum time in minutes that tests are permitted to run.

The timeout property is not currently active. This value is ignored.

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

PipelineLoggingConfigurationProperty

class CfnImagePipelinePropsMixin.PipelineLoggingConfigurationProperty(*, image_log_group_name=None, pipeline_log_group_name=None)

Bases: object

The logging configuration that’s defined for pipeline execution.

Parameters:

image_log_group_name (Optional[str]) – The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name .
pipeline_log_group_name (Optional[str]) – The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

pipeline_logging_configuration_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.PipelineLoggingConfigurationProperty(
    image_log_group_name="imageLogGroupName",
    pipeline_log_group_name="pipelineLogGroupName"
)

Attributes

image_log_group_name

The log group name that Image Builder uses for image creation.

If not specified, the log group name defaults to /aws/imagebuilder/image-name .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html#cfn-imagebuilder-imagepipeline-pipelineloggingconfiguration-imageloggroupname

pipeline_log_group_name

The log group name that Image Builder uses for the log output during creation of a new pipeline.

If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html#cfn-imagebuilder-imagepipeline-pipelineloggingconfiguration-pipelineloggroupname

ScheduleProperty

class CfnImagePipelinePropsMixin.ScheduleProperty(*, auto_disable_policy=None, pipeline_execution_start_condition=None, schedule_expression=None)

Bases: object

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

Parameters:

auto_disable_policy (Union[IResolvable, AutoDisablePolicyProperty, Dict[str, Any], None]) – The policy that configures when Image Builder should automatically disable a pipeline that is failing.
pipeline_execution_start_condition (Optional[str]) – The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition 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, 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 Image Builder API Reference .
schedule_expression (Optional[str]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

schedule_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.ScheduleProperty(
    auto_disable_policy=imagebuilder_mixins.CfnImagePipelinePropsMixin.AutoDisablePolicyProperty(
        failure_count=123
    ),
    pipeline_execution_start_condition="pipelineExecutionStartCondition",
    schedule_expression="scheduleExpression"
)

Attributes

auto_disable_policy

The policy that configures when Image Builder should automatically disable a pipeline that is failing.

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

pipeline_execution_start_condition

The condition configures when the pipeline should trigger a new image build.

When the pipelineExecutionStartCondition 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, 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 Image Builder API Reference .

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

schedule_expression

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 .

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

WorkflowConfigurationProperty

class CfnImagePipelinePropsMixin.WorkflowConfigurationProperty(*, on_failure=None, parallel_group=None, parameters=None, workflow_arn=None)

Bases: object

Contains control settings and configurable inputs for a workflow resource.

Parameters:

on_failure (Optional[str]) – The action to take if the workflow fails.
parallel_group (Optional[str]) – Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
parameters (Union[IResolvable, Sequence[Union[IResolvable, WorkflowParameterProperty, Dict[str, Any]]], None]) – Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
workflow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the workflow resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

workflow_configuration_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.WorkflowConfigurationProperty(
    on_failure="onFailure",
    parallel_group="parallelGroup",
    parameters=[imagebuilder_mixins.CfnImagePipelinePropsMixin.WorkflowParameterProperty(
        name="name",
        value=["value"]
    )],
    workflow_arn="workflowArn"
)

Attributes

on_failure

The action to take if the workflow fails.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-onfailure

parallel_group

Test workflows are defined within named runtime groups called parallel groups.

The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-parallelgroup

parameters

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-parameters

workflow_arn

The Amazon Resource Name (ARN) of the workflow resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-workflowarn

WorkflowParameterProperty

class CfnImagePipelinePropsMixin.WorkflowParameterProperty(*, name=None, value=None)

Bases: object

Contains a key/value pair that sets the named workflow parameter.

Parameters:

name (Optional[str]) – The name of the workflow parameter to set.
value (Optional[Sequence[str]]) – Sets the value for the named workflow parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowparameter.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

workflow_parameter_property = imagebuilder_mixins.CfnImagePipelinePropsMixin.WorkflowParameterProperty(
    name="name",
    value=["value"]
)

Attributes

name

The name of the workflow parameter to set.

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

value

Sets the value for the named workflow parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowparameter.html#cfn-imagebuilder-imagepipeline-workflowparameter-value