CfnContainerRecipePropsMixin

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

Bases: Mixin

Creates a new container recipe.

Container recipes define how images are configured, tested, and assessed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html
CloudformationResource:: AWS::ImageBuilder::ContainerRecipe
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_container_recipe_props_mixin = imagebuilder_mixins.CfnContainerRecipePropsMixin(imagebuilder_mixins.CfnContainerRecipeMixinProps(
    components=[imagebuilder_mixins.CfnContainerRecipePropsMixin.ComponentConfigurationProperty(
        component_arn="componentArn",
        parameters=[imagebuilder_mixins.CfnContainerRecipePropsMixin.ComponentParameterProperty(
            name="name",
            value=["value"]
        )]
    )],
    container_type="containerType",
    description="description",
    dockerfile_template_data="dockerfileTemplateData",
    dockerfile_template_uri="dockerfileTemplateUri",
    image_os_version_override="imageOsVersionOverride",
    instance_configuration=imagebuilder_mixins.CfnContainerRecipePropsMixin.InstanceConfigurationProperty(
        block_device_mappings=[imagebuilder_mixins.CfnContainerRecipePropsMixin.InstanceBlockDeviceMappingProperty(
            device_name="deviceName",
            ebs=imagebuilder_mixins.CfnContainerRecipePropsMixin.EbsInstanceBlockDeviceSpecificationProperty(
                delete_on_termination=False,
                encrypted=False,
                iops=123,
                kms_key_id="kmsKeyId",
                snapshot_id="snapshotId",
                throughput=123,
                volume_size=123,
                volume_type="volumeType"
            ),
            no_device="noDevice",
            virtual_name="virtualName"
        )],
        image="image"
    ),
    kms_key_id="kmsKeyId",
    name="name",
    parent_image="parentImage",
    platform_override="platformOverride",
    tags={
        "tags_key": "tags"
    },
    target_repository=imagebuilder_mixins.CfnContainerRecipePropsMixin.TargetContainerRepositoryProperty(
        repository_name="repositoryName",
        service="service"
    ),
    version="version",
    working_directory="workingDirectory"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnContainerRecipeMixinProps, 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 = ['components', 'containerType', 'description', 'dockerfileTemplateData', 'dockerfileTemplateUri', 'imageOsVersionOverride', 'instanceConfiguration', 'kmsKeyId', 'name', 'parentImage', 'platformOverride', 'tags', 'targetRepository', 'version', 'workingDirectory']

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

ComponentConfigurationProperty

class CfnContainerRecipePropsMixin.ComponentConfigurationProperty(*, component_arn=None, parameters=None)

Bases: object

Configuration details of the component.

Parameters:

component_arn (Optional[str]) – The Amazon Resource Name (ARN) of the component.
parameters (Union[IResolvable, Sequence[Union[IResolvable, ComponentParameterProperty, Dict[str, Any]]], None]) – A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

See:

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

component_configuration_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.ComponentConfigurationProperty(
    component_arn="componentArn",
    parameters=[imagebuilder_mixins.CfnContainerRecipePropsMixin.ComponentParameterProperty(
        name="name",
        value=["value"]
    )]
)

Attributes

component_arn

The Amazon Resource Name (ARN) of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html#cfn-imagebuilder-containerrecipe-componentconfiguration-componentarn

parameters

A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html#cfn-imagebuilder-containerrecipe-componentconfiguration-parameters

ComponentParameterProperty

class CfnContainerRecipePropsMixin.ComponentParameterProperty(*, name=None, value=None)

Bases: object

Contains a key/value pair that sets the named component parameter.

Parameters:

name (Optional[str]) – The name of the component parameter to set.
value (Optional[Sequence[str]]) – Sets the value for the named component parameter.

See:

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

component_parameter_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.ComponentParameterProperty(
    name="name",
    value=["value"]
)

Attributes

name

The name of the component parameter to set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html#cfn-imagebuilder-containerrecipe-componentparameter-name

value

Sets the value for the named component parameter.

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

EbsInstanceBlockDeviceSpecificationProperty

class CfnContainerRecipePropsMixin.EbsInstanceBlockDeviceSpecificationProperty(*, delete_on_termination=None, encrypted=None, iops=None, kms_key_id=None, snapshot_id=None, throughput=None, volume_size=None, volume_type=None)

Bases: object

Amazon EBS-specific block device mapping specifications.

Parameters:

delete_on_termination (Union[bool, IResolvable, None]) – Use to configure delete on termination of the associated device.
encrypted (Union[bool, IResolvable, None]) – Use to configure device encryption.
iops (Union[int, float, None]) – Use to configure device IOPS.
kms_key_id (Optional[str]) – The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
snapshot_id (Optional[str]) – The snapshot that defines the device contents.
throughput (Union[int, float, None]) – For GP3 volumes only – The throughput in MiB/s that the volume supports.
volume_size (Union[int, float, None]) – Use to override the device’s volume size.
volume_type (Optional[str]) – Use to override the device’s volume type.

See:

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

ebs_instance_block_device_specification_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.EbsInstanceBlockDeviceSpecificationProperty(
    delete_on_termination=False,
    encrypted=False,
    iops=123,
    kms_key_id="kmsKeyId",
    snapshot_id="snapshotId",
    throughput=123,
    volume_size=123,
    volume_type="volumeType"
)

Attributes

delete_on_termination

Use to configure delete on termination of the associated device.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-deleteontermination

encrypted

Use to configure device encryption.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-encrypted

iops

Use to configure device IOPS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-iops

kms_key_id

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device.

This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-kmskeyid

snapshot_id

The snapshot that defines the device contents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-snapshotid

throughput

For GP3 volumes only – The throughput in MiB/s that the volume supports.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-throughput

volume_size

Use to override the device’s volume size.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-volumesize

volume_type

Use to override the device’s volume type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-volumetype

InstanceBlockDeviceMappingProperty

class CfnContainerRecipePropsMixin.InstanceBlockDeviceMappingProperty(*, device_name=None, ebs=None, no_device=None, virtual_name=None)

Bases: object

Defines block device mappings for the instance used to configure your image.

Parameters:

device_name (Optional[str]) – The device to which these mappings apply.
ebs (Union[IResolvable, EbsInstanceBlockDeviceSpecificationProperty, Dict[str, Any], None]) – Use to manage Amazon EBS-specific configuration for this mapping.
no_device (Optional[str]) – Use to remove a mapping from the base image.
virtual_name (Optional[str]) – Use to manage instance ephemeral devices.

See:

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

instance_block_device_mapping_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.InstanceBlockDeviceMappingProperty(
    device_name="deviceName",
    ebs=imagebuilder_mixins.CfnContainerRecipePropsMixin.EbsInstanceBlockDeviceSpecificationProperty(
        delete_on_termination=False,
        encrypted=False,
        iops=123,
        kms_key_id="kmsKeyId",
        snapshot_id="snapshotId",
        throughput=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    no_device="noDevice",
    virtual_name="virtualName"
)

Attributes

device_name

The device to which these mappings apply.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-devicename

ebs

Use to manage Amazon EBS-specific configuration for this mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-ebs

no_device

Use to remove a mapping from the base image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-nodevice

virtual_name

Use to manage instance ephemeral devices.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-virtualname

InstanceConfigurationProperty

class CfnContainerRecipePropsMixin.InstanceConfigurationProperty(*, block_device_mappings=None, image=None)

Bases: object

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

Parameters:

block_device_mappings (Union[IResolvable, Sequence[Union[IResolvable, InstanceBlockDeviceMappingProperty, Dict[str, Any]]], None]) – Defines the block devices to attach for building an instance from this Image Builder AMI.
image (Optional[str]) – The base image for a container build and test instance. This can contain an AMI ID or it can specify an AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN. If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

See:

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

instance_configuration_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.InstanceConfigurationProperty(
    block_device_mappings=[imagebuilder_mixins.CfnContainerRecipePropsMixin.InstanceBlockDeviceMappingProperty(
        device_name="deviceName",
        ebs=imagebuilder_mixins.CfnContainerRecipePropsMixin.EbsInstanceBlockDeviceSpecificationProperty(
            delete_on_termination=False,
            encrypted=False,
            iops=123,
            kms_key_id="kmsKeyId",
            snapshot_id="snapshotId",
            throughput=123,
            volume_size=123,
            volume_type="volumeType"
        ),
        no_device="noDevice",
        virtual_name="virtualName"
    )],
    image="image"
)

Attributes

block_device_mappings

Defines the block devices to attach for building an instance from this Image Builder AMI.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceconfiguration.html#cfn-imagebuilder-containerrecipe-instanceconfiguration-blockdevicemappings

image

The base image for a container build and test instance.

This can contain an AMI ID or it can specify an AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN.

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

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

LatestVersionProperty

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

Bases: object

The latest version references of the container recipe.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the container recipe. .. 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 container recipe, with the same major version.
minor (Optional[str]) – The latest version ARN of the created container recipe, with the same minor version.
patch (Optional[str]) – The latest version ARN of the created container recipe, with the same patch version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-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.CfnContainerRecipePropsMixin.LatestVersionProperty(
    arn="arn",
    major="major",
    minor="minor",
    patch="patch"
)

Attributes

arn

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

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-containerrecipe-latestversion.html#cfn-imagebuilder-containerrecipe-latestversion-arn

major

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

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

minor

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

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

patch

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

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

TargetContainerRepositoryProperty

class CfnContainerRecipePropsMixin.TargetContainerRepositoryProperty(*, repository_name=None, service=None)

Bases: object

The container repository where the output container image is stored.

Parameters:

repository_name (Optional[str]) – The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, <repository location url>/repository_name .
service (Optional[str]) – Specifies the service in which this image was registered.

See:

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

target_container_repository_property = imagebuilder_mixins.CfnContainerRecipePropsMixin.TargetContainerRepositoryProperty(
    repository_name="repositoryName",
    service="service"
)

Attributes

repository_name

The name of the container repository where the output container image is stored.

This name is prefixed by the repository location. For example, <repository location url>/repository_name .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html#cfn-imagebuilder-containerrecipe-targetcontainerrepository-repositoryname

service

Specifies the service in which this image was registered.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html#cfn-imagebuilder-containerrecipe-targetcontainerrepository-service