ComponentProps

class aws_cdk.aws_imagebuilder_alpha.ComponentProps(*, data, platform, change_description=None, component_name=None, component_version=None, description=None, kms_key=None, supported_os_versions=None, tags=None)

Bases: object

(experimental) Properties for creating a Component resource.

Parameters:

data (ComponentData) – (experimental) The component document content that defines the build, validation, or test steps to be executed during the image building process.
platform (Platform) – (experimental) The operating system platform of the component.
change_description (Optional[str]) – (experimental) The change description of the component. Describes what change has been made in this version of the component, or what makes this version different from other versions. Default: None
component_name (Optional[str]) – (experimental) The name of the component. Default: - a name is generated
component_version (Optional[str]) – (experimental) The version of the component. Default: 1.0.0
description (Optional[str]) – (experimental) The description of the component. Default: None
kms_key (Optional[IKey]) – (experimental) The KMS key used to encrypt this component. Default: - an Image Builder owned key will be used to encrypt the component.
supported_os_versions (Optional[Sequence[OSVersion]]) – (experimental) The operating system versions supported by the component. Default: None
tags (Optional[Mapping[str, str]]) – (experimental) The tags to apply to the component. Default: None

Stability:

experimental

ExampleMetadata:

infused

Example:

component = imagebuilder.Component(self, "MyComponent",
    platform=imagebuilder.Platform.LINUX,
    data=imagebuilder.ComponentData.from_json_object({
        "schema_version": imagebuilder.ComponentSchemaVersion.V1_0,
        "phases": [{
            "name": imagebuilder.ComponentPhaseName.BUILD,
            "steps": [{
                "name": "install-app",
                "action": imagebuilder.ComponentAction.EXECUTE_BASH,
                "inputs": {
                    "commands": ["echo "Installing my application..."", "yum update -y"]
                }
            }
            ]
        }
        ]
    })
)

Attributes

change_description

(experimental) The change description of the component.

Describes what change has been made in this version of the component, or what makes this version different from other versions.

Default:: None
Stability:: experimental

component_name

(experimental) The name of the component.

Default:

a name is generated

Stability:

experimental

component_version

(experimental) The version of the component.

Default:: 1.0.0
Stability:: experimental

data

(experimental) The component document content that defines the build, validation, or test steps to be executed during the image building process.

Stability:: experimental

description

(experimental) The description of the component.

Default:: None
Stability:: experimental

kms_key

(experimental) The KMS key used to encrypt this component.

Default:

an Image Builder owned key will be used to encrypt the component.

Stability:

experimental

platform

(experimental) The operating system platform of the component.

Stability:: experimental

supported_os_versions

(experimental) The operating system versions supported by the component.

Default:: None
Stability:: experimental

tags

(experimental) The tags to apply to the component.

Default:: None
Stability:: experimental