CfnImageProps

class aws_cdk.aws_imagebuilder.CfnImageProps(*, container_recipe_arn=None, deletion_settings=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, execution_role=None, image_pipeline_execution_settings=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, infrastructure_configuration_arn=None, logging_configuration=None, tags=None, workflows=None)

Bases: object

Properties for defining a CfnImage.

Parameters:

  • container_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

  • deletion_settings (Union[IResolvable, DeletionSettingsProperty, Dict[str, Any], None]) – Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

  • distribution_configuration_arn (Union[str, IDistributionConfigurationRef, None]) – The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your 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_pipeline_execution_settings (Union[IResolvable, ImagePipelineExecutionSettingsProperty, Dict[str, Any], None]) – The image pipeline execution settings of the image.

  • image_recipe_arn (Union[str, IImageRecipeRef, None]) – The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

  • 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 image tests configuration of the image.

  • infrastructure_configuration_arn (Union[str, IInfrastructureConfigurationRef, None]) – The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

  • logging_configuration (Union[IResolvable, ImageLoggingConfigurationProperty, Dict[str, Any], None]) – The logging configuration that’s defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.

  • tags (Optional[Mapping[str, str]]) – The tags of the image.

  • workflows (Union[IResolvable, Sequence[Union[IResolvable, WorkflowConfigurationProperty, Dict[str, Any]]], None]) – Contains an array of workflow configuration objects.

See:

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

Attributes

container_recipe_arn

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

See:

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

deletion_settings

Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

See:

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

distribution_configuration_arn

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

See:

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

image_pipeline_execution_settings

The image pipeline execution settings of the image.

See:

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

image_recipe_arn

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

See:

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

image_scanning_configuration

Contains settings for vulnerability scans.

See:

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

image_tests_configuration

The image tests configuration of the image.

See:

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

infrastructure_configuration_arn

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

See:

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

logging_configuration

The logging configuration that’s defined for the image.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-loggingconfiguration

tags

The tags of the image.

See:

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

workflows

Contains an array of workflow configuration objects.

See:

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