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 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 this 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]) – The description of the component. Describes the contents of the component.

  • kms_key_id (Optional[str]) – The ID of the KMS key that should be 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 of 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.

Link

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.
import aws_cdk.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 this component.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

description

The description of the component.

Describes the contents of the component.

Link

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

Return type

Optional[str]

kms_key_id

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

Link

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

Return type

Optional[str]

name

The name of the component.

Link

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

Return type

str

platform

The platform of the component.

Link

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

Return type

str

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.

Link

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

Return type

Optional[List[str]]

tags

The tags of the component.

Link

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

Return type

Optional[Mapping[str, str]]

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.

Link

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

Return type

Optional[str]

version

The component version.

For example, 1.0.0 .

Link

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

Return type

str