CfnImageProps

class aws_cdk.aws_imagebuilder.CfnImageProps(*, infrastructure_configuration_arn, container_recipe_arn=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, tags=None)

Bases: object

Properties for defining a CfnImage.

Parameters:
  • infrastructure_configuration_arn (str) – The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

  • container_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

  • distribution_configuration_arn (Optional[str]) – The Amazon Resource Name (ARN) of the distribution configuration.

  • enhanced_image_metadata_enabled (Union[bool, IResolvable, None]) – Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

  • image_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the image recipe.

  • image_scanning_configuration (Union[IResolvable, ImageScanningConfigurationProperty, Dict[str, Any], None]) – AWS::ImageBuilder::Image.ImageScanningConfiguration.

  • image_tests_configuration (Union[IResolvable, ImageTestsConfigurationProperty, Dict[str, Any], None]) – The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

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

Link:

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.
import aws_cdk.aws_imagebuilder as imagebuilder

cfn_image_props = imagebuilder.CfnImageProps(
    infrastructure_configuration_arn="infrastructureConfigurationArn",

    # the properties below are optional
    container_recipe_arn="containerRecipeArn",
    distribution_configuration_arn="distributionConfigurationArn",
    enhanced_image_metadata_enabled=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
    ),
    tags={
        "tags_key": "tags"
    }
)

Attributes

container_recipe_arn

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

Link:

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

distribution_configuration_arn

The Amazon Resource Name (ARN) of the distribution configuration.

Link:

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

enhanced_image_metadata_enabled

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

Link:

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

image_recipe_arn

The Amazon Resource Name (ARN) of the image recipe.

Link:

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

image_scanning_configuration

AWS::ImageBuilder::Image.ImageScanningConfiguration.

Link:

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

image_tests_configuration

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

Link:

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 associated with this image pipeline.

Link:

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

tags

The tags of the image.

Link:

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