CfnComponentProps

class aws_cdk.aws_imagebuilder.CfnComponentProps(*, name, platform, version, change_description=None, data=None, description=None, kms_key_id=None, supported_os_versions=None, tags=None, uri=None)

Bases: object

Properties for defining a CfnComponent.

Parameters:

name (str) – The name of the component.
platform (str) – The operating system platform of the component.
version (str) – The component version. For example, 1.0.0 .
change_description (Optional[str]) – The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
data (Optional[str]) – Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
description (Optional[str]) – Describes the contents of the component.
kms_key_id (Optional[str]) – The ID of the KMS key that is used to encrypt this component.
supported_os_versions (Optional[Sequence[str]]) – The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
tags (Optional[Mapping[str, str]]) – The tags that apply to the component.
uri (Optional[str]) – The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota. Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.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 import aws_imagebuilder as imagebuilder

cfn_component_props = imagebuilder.CfnComponentProps(
    name="name",
    platform="platform",
    version="version",

    # the properties below are optional
    change_description="changeDescription",
    data="data",
    description="description",
    kms_key_id="kmsKeyId",
    supported_os_versions=["supportedOsVersions"],
    tags={
        "tags_key": "tags"
    },
    uri="uri"
)

Attributes

change_description

The change description of the component.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-changedescription

data

Component data contains inline YAML document content for the component.

Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-data

description

Describes the contents of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-description

kms_key_id

The ID of the KMS key that is used to encrypt this component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-kmskeyid

name

The name of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-name

platform

The operating system platform of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-platform

supported_os_versions

The operating system (OS) version supported by the component.

If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-supportedosversions

tags

The tags that apply to the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-tags

uri

The uri of a YAML component document file.

This must be an S3 URL ( s3://bucket/key ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-uri

version

The component version.

For example, 1.0.0 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-version