CfnComponentPropsMixin

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

Bases: Mixin

Creates a new component that can be used to build, validate, test, and assess your image.

The component is based on a YAML document that you specify using exactly one of the following methods:

Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html
CloudformationResource:: AWS::ImageBuilder::Component
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_component_props_mixin = imagebuilder_mixins.CfnComponentPropsMixin(imagebuilder_mixins.CfnComponentMixinProps(
    change_description="changeDescription",
    data="data",
    description="description",
    kms_key_id="kmsKeyId",
    name="name",
    platform="platform",
    supported_os_versions=["supportedOsVersions"],
    tags={
        "tags_key": "tags"
    },
    uri="uri",
    version="version"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnComponentMixinProps, 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 = ['changeDescription', 'data', 'description', 'kmsKeyId', 'name', 'platform', 'supportedOsVersions', 'tags', 'uri', 'version']

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

LatestVersionProperty

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

Bases: object

The latest version references of the component.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the component.
major (Optional[str]) – The latest version ARN of the created component, with the same major version.
minor (Optional[str]) – The latest version ARN of the created component, with the same minor version.
patch (Optional[str]) – The latest version ARN of the created component, with the same patch version.

See:

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

Attributes

arn

The Amazon Resource Name (ARN) of the component.

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

major

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

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

minor

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

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

patch

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

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