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_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]) – 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.

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

  • 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_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

Return type

Optional[str]

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

Return type

Optional[str]

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.

Link

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

Return type

Union[bool, IResolvable, None]

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

Return type

Optional[str]

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

Return type

Union[IResolvable, ImageTestsConfigurationProperty, None]

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

Return type

str

tags

The tags of the image.

Link

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

Return type

Optional[Mapping[str, str]]