CfnImagePropsMixin

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

Bases: Mixin

Creates a new image.

This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html
CloudformationResource:: AWS::ImageBuilder::Image
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_props_mixin = imagebuilder_mixins.CfnImagePropsMixin(imagebuilder_mixins.CfnImageMixinProps(
    container_recipe_arn="containerRecipeArn",
    deletion_settings=imagebuilder_mixins.CfnImagePropsMixin.DeletionSettingsProperty(
        execution_role="executionRole"
    ),
    distribution_configuration_arn="distributionConfigurationArn",
    enhanced_image_metadata_enabled=False,
    execution_role="executionRole",
    image_pipeline_execution_settings=imagebuilder_mixins.CfnImagePropsMixin.ImagePipelineExecutionSettingsProperty(
        deployment_id="deploymentId",
        on_update=False
    ),
    image_recipe_arn="imageRecipeArn",
    image_scanning_configuration=imagebuilder_mixins.CfnImagePropsMixin.ImageScanningConfigurationProperty(
        ecr_configuration=imagebuilder_mixins.CfnImagePropsMixin.EcrConfigurationProperty(
            container_tags=["containerTags"],
            repository_name="repositoryName"
        ),
        image_scanning_enabled=False
    ),
    image_tests_configuration=imagebuilder_mixins.CfnImagePropsMixin.ImageTestsConfigurationProperty(
        image_tests_enabled=False,
        timeout_minutes=123
    ),
    infrastructure_configuration_arn="infrastructureConfigurationArn",
    logging_configuration=imagebuilder_mixins.CfnImagePropsMixin.ImageLoggingConfigurationProperty(
        log_group_name="logGroupName"
    ),
    tags={
        "tags_key": "tags"
    },
    workflows=[imagebuilder_mixins.CfnImagePropsMixin.WorkflowConfigurationProperty(
        on_failure="onFailure",
        parallel_group="parallelGroup",
        parameters=[imagebuilder_mixins.CfnImagePropsMixin.WorkflowParameterProperty(
            name="name",
            value=["value"]
        )],
        workflow_arn="workflowArn"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnImageMixinProps, 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', 'deletionSettings', 'distributionConfigurationArn', 'enhancedImageMetadataEnabled', 'executionRole', 'imagePipelineExecutionSettings', 'imageRecipeArn', 'imageScanningConfiguration', 'imageTestsConfiguration', 'infrastructureConfigurationArn', 'loggingConfiguration', '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

DeletionSettingsProperty

class CfnImagePropsMixin.DeletionSettingsProperty(*, execution_role=None)

Bases: object

The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.

Parameters:: execution_role (Optional[str]) – The execution role to use for deleting the image, as well as underlying resources.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-deletionsettings.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

deletion_settings_property = imagebuilder_mixins.CfnImagePropsMixin.DeletionSettingsProperty(
    execution_role="executionRole"
)

Attributes

execution_role

The execution role to use for deleting the image, as well as underlying resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-deletionsettings.html#cfn-imagebuilder-image-deletionsettings-executionrole

EcrConfigurationProperty

class CfnImagePropsMixin.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-image-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.CfnImagePropsMixin.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-image-ecrconfiguration.html#cfn-imagebuilder-image-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-image-ecrconfiguration.html#cfn-imagebuilder-image-ecrconfiguration-repositoryname

ImageLoggingConfigurationProperty

class CfnImagePropsMixin.ImageLoggingConfigurationProperty(*, log_group_name=None)

Bases: object

The logging configuration that’s defined for the image.

Image Builder uses the defined settings to direct execution log output during image creation.

Parameters:: 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 .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imageloggingconfiguration.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_logging_configuration_property = imagebuilder_mixins.CfnImagePropsMixin.ImageLoggingConfigurationProperty(
    log_group_name="logGroupName"
)

Attributes

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-image-imageloggingconfiguration.html#cfn-imagebuilder-image-imageloggingconfiguration-loggroupname

ImagePipelineExecutionSettingsProperty

class CfnImagePropsMixin.ImagePipelineExecutionSettingsProperty(*, deployment_id=None, on_update=None)

Bases: object

The settings for starting an image pipeline execution.

Parameters:

deployment_id (Optional[str]) – The deployment ID of the pipeline, used to trigger new image pipeline executions.
on_update (Union[bool, IResolvable, None]) – Whether to trigger the image pipeline when the pipeline is updated. False by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.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_pipeline_execution_settings_property = imagebuilder_mixins.CfnImagePropsMixin.ImagePipelineExecutionSettingsProperty(
    deployment_id="deploymentId",
    on_update=False
)

Attributes

deployment_id

The deployment ID of the pipeline, used to trigger new image pipeline executions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-deploymentid

on_update

Whether to trigger the image pipeline when the pipeline is updated.

False by default.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-onupdate

ImageScanningConfigurationProperty

class CfnImagePropsMixin.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-image-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.CfnImagePropsMixin.ImageScanningConfigurationProperty(
    ecr_configuration=imagebuilder_mixins.CfnImagePropsMixin.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-image-imagescanningconfiguration.html#cfn-imagebuilder-image-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-image-imagescanningconfiguration.html#cfn-imagebuilder-image-imagescanningconfiguration-imagescanningenabled

ImageTestsConfigurationProperty

class CfnImagePropsMixin.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 are used to create the final image.

You must have at least one build component to create a recipe, but test components are not required. If you have added tests, they run after the image is created, 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]) – Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
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-image-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.CfnImagePropsMixin.ImageTestsConfigurationProperty(
    image_tests_enabled=False,
    timeout_minutes=123
)

Attributes

image_tests_enabled

Determines if tests should run after building the image.

Image Builder defaults to enable tests to run following the image build, before image distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html#cfn-imagebuilder-image-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-image-imagetestsconfiguration.html#cfn-imagebuilder-image-imagetestsconfiguration-timeoutminutes

LatestVersionProperty

class CfnImagePropsMixin.LatestVersionProperty(*, arn=None, major=None, minor=None, patch=None)

Bases: object

The latest version references of the image.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the image. .. epigraph:: Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows: - Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x. - Version ARNs have only the first three nodes: .. - Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
major (Optional[str]) – The latest version ARN of the created image, with the same major version.
minor (Optional[str]) – The latest version ARN of the created image, with the same minor version.
patch (Optional[str]) – The latest version ARN of the created image, with the same patch version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.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

latest_version_property = imagebuilder_mixins.CfnImagePropsMixin.LatestVersionProperty(
    arn="arn",
    major="major",
    minor="minor",
    patch="patch"
)

Attributes

arn

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows:

Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

Version ARNs have only the first three nodes: ..

Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-arn

major

The latest version ARN of the created image, with the same major version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-major

minor

The latest version ARN of the created image, with the same minor version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-minor

patch

The latest version ARN of the created image, with the same patch version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-patch

WorkflowConfigurationProperty

class CfnImagePropsMixin.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-image-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.CfnImagePropsMixin.WorkflowConfigurationProperty(
    on_failure="onFailure",
    parallel_group="parallelGroup",
    parameters=[imagebuilder_mixins.CfnImagePropsMixin.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-image-workflowconfiguration.html#cfn-imagebuilder-image-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-image-workflowconfiguration.html#cfn-imagebuilder-image-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-image-workflowconfiguration.html#cfn-imagebuilder-image-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-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-workflowarn

WorkflowParameterProperty

class CfnImagePropsMixin.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-image-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.CfnImagePropsMixin.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-image-workflowparameter.html#cfn-imagebuilder-image-workflowparameter-name

value

Sets the value for the named workflow parameter.

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