CfnImage

class aws_cdk.aws_imagebuilder.CfnImage(scope, id, *, infrastructure_configuration_arn, container_recipe_arn=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, execution_role=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, tags=None, workflows=None)

Bases: CfnResource

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
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 = imagebuilder.CfnImage(self, "MyCfnImage",
    infrastructure_configuration_arn="infrastructureConfigurationArn",

    # the properties below are optional
    container_recipe_arn="containerRecipeArn",
    distribution_configuration_arn="distributionConfigurationArn",
    enhanced_image_metadata_enabled=False,
    execution_role="executionRole",
    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"
    },
    workflows=[imagebuilder.CfnImage.WorkflowConfigurationProperty(
        on_failure="onFailure",
        parallel_group="parallelGroup",
        parameters=[imagebuilder.CfnImage.WorkflowParameterProperty(
            name="name",
            value=["value"]
        )],
        workflow_arn="workflowArn"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
infrastructure_configuration_arn (str) – The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
container_recipe_arn (Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arn (Optional[str]) – 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_recipe_arn (Optional[str]) – 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.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ImageBuilder::Image'

attr_arn

Returns the Amazon Resource Name (ARN) of the image.

For example, arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1 .

CloudformationAttribute:: Arn

attr_image_id

Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.

Values are returned only for AMIs, and not for container images.

CloudformationAttribute:: ImageId

attr_image_uri

Returns the URI for a container image created in the context Region.

Values are returned only for container images, and not for AMIs.

CloudformationAttribute:: ImageUri

attr_name

Returns the name of the image.

CloudformationAttribute:: Name

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

enhanced_image_metadata_enabled: Collects additional information about the image being created, including the operating system (OS) version and package list.

execution_role: The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

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

image_scanning_configuration: Contains settings for vulnerability scans.

image_tests_configuration: The image tests configuration of the image.

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.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags of the image.

workflows: Contains an array of workflow configuration objects.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

EcrConfigurationProperty

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

ecr_configuration_property = imagebuilder.CfnImage.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

ImageScanningConfigurationProperty

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

image_scanning_configuration_property = imagebuilder.CfnImage.ImageScanningConfigurationProperty(
    ecr_configuration=imagebuilder.CfnImage.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 CfnImage.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 timeoutMinutes attribute 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 import aws_imagebuilder as imagebuilder

image_tests_configuration_property = imagebuilder.CfnImage.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 timeoutMinutes attribute 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

WorkflowConfigurationProperty

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

workflow_configuration_property = imagebuilder.CfnImage.WorkflowConfigurationProperty(
    on_failure="onFailure",
    parallel_group="parallelGroup",
    parameters=[imagebuilder.CfnImage.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 CfnImage.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 import aws_imagebuilder as imagebuilder

workflow_parameter_property = imagebuilder.CfnImage.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