AwsManagedComponentAttributes

class aws_cdk.aws_imagebuilder_alpha.AwsManagedComponentAttributes(*, component_name=None, component_version=None, platform=None)

Bases: object

(experimental) Properties for an EC2 Image Builder AWS-managed component.

Parameters:

component_name (Optional[str]) – (experimental) The name of the AWS-managed component. The name of the AWS-managed component. This is a required attribute when using the this.fromAwsManagedComponentAttributes() method. This parameter should not be provided when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot(). Default: - none if using the pre-defined managed component methods, otherwise a platform is required when using this.fromAwsManagedComponentAttributes()
component_version (Optional[str]) – (experimental) The version of the AWS-managed component. Default: - the latest version of the component, x.x.x
platform (Optional[Platform]) – (experimental) The platform of the AWS-managed component. This is a required attribute when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot(). This parameter should not be provided when using the this.fromAwsManagedComponentAttributes() method. Default: - none if using this.fromAwsManagedComponentAttributes(), otherwise a platform is required when using the pre-defined managed component methods

Stability:

experimental

ExampleMetadata:

infused

Example:

# Install AWS CLI v2
aws_cli_component = imagebuilder.AwsManagedComponent.aws_cli_v2(self, "AwsCli",
    platform=imagebuilder.Platform.LINUX
)

# Update the operating system
update_component = imagebuilder.AwsManagedComponent.update_oS(self, "UpdateOS",
    platform=imagebuilder.Platform.LINUX
)

# Reference any AWS-managed component by name
custom_aws_component = imagebuilder.AwsManagedComponent.from_aws_managed_component_name(self, "CloudWatchAgent", "amazon-cloudwatch-agent-linux")

Attributes

component_name

(experimental) The name of the AWS-managed component.

The name of the AWS-managed component. This is a required attribute when using the this.fromAwsManagedComponentAttributes() method. This parameter should not be provided when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot().

Default:

none if using the pre-defined managed component methods, otherwise a platform is required when using

this.fromAwsManagedComponentAttributes()

Stability:: experimental

component_version

(experimental) The version of the AWS-managed component.

Default:

the latest version of the component, x.x.x

Stability:

experimental

platform

(experimental) The platform of the AWS-managed component.

This is a required attribute when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot(). This parameter should not be provided when using the this.fromAwsManagedComponentAttributes() method.

Default:

none if using this.fromAwsManagedComponentAttributes(), otherwise a platform is

required when using the pre-defined managed component methods

Stability:: experimental