AwsManagedComponent

class aws_cdk.aws_imagebuilder_alpha.AwsManagedComponent

Bases: object

(experimental) Helper class for working with AWS-managed components.

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")

Stability:: experimental

Static Methods

classmethod aws_cli_v2(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the AWS CLI v2 AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent

classmethod from_aws_managed_component_attributes(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports an AWS-managed component from its attributes.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent

classmethod from_aws_managed_component_name(scope, id, aws_managed_component_name)

(experimental) Imports an AWS-managed component from its name.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
aws_managed_component_name (str) –
- The name of the AWS-managed component.

Stability:

experimental

Return type:

IComponent

classmethod hello_world(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the hello world AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent

classmethod python3(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the Python 3 AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent

classmethod reboot(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the reboot AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent

classmethod stig_build(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the STIG hardening AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/ib-stig.html

Stability:

experimental

Return type:

IComponent

classmethod update_os(scope, id, *, component_name=None, component_version=None, platform=None)

(experimental) Imports the OS update AWS-managed component.

Parameters:

scope (Construct) – The construct scope.
id (str) – Identifier of the construct.
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

Return type:

IComponent