class CfnComponent (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ImageBuilder.CfnComponent`
Java	`software.amazon.awscdk.services.imagebuilder.CfnComponent`
Python	`aws_cdk.aws_imagebuilder.CfnComponent`
TypeScript	`@aws-cdk/aws-imagebuilder` » `CfnComponent`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ImageBuilder::Component.

Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder from '@aws-cdk/aws-imagebuilder';
const cfnComponent = new imagebuilder.CfnComponent(this, 'MyCfnComponent', {
  name: 'name',
  platform: 'platform',
  version: 'version',

  // the properties below are optional
  changeDescription: 'changeDescription',
  data: 'data',
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  supportedOsVersions: ['supportedOsVersions'],
  tags: {
    tagsKey: 'tags',
  },
  uri: 'uri',
});

Initializer

new CfnComponent(scope: Construct, id: string, props: CfnComponentProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnComponentProps — - resource properties.

Create a new AWS::ImageBuilder::Component.

Construct Props

Name	Type	Description
name	`string`	The name of the component.
platform	`string`	The operating system platform of the component.
version	`string`	The component version.
changeDescription?	`string`	The change description of the component.
data?	`string`	Component `data` contains inline YAML document content for the component.
description?	`string`	Describes the contents of the component.
kmsKeyId?	`string`	The ID of the KMS key that is used to encrypt this component.
supportedOsVersions?	`string[]`	The operating system (OS) version supported by the component.
tags?	`{ [string]: string }`	The tags that apply to the component.
uri?	`string`	The `uri` of a YAML component document file.

name

Type: string

The name of the component.

platform

Type: string

The operating system platform of the component.

version

Type: string

The component version.

For example, 1.0.0 .

changeDescription?

Type: string (optional)

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?

Type: string (optional)

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?

Type: string (optional)

Describes the contents of the component.

kmsKeyId?

Type: string (optional)

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

supportedOsVersions?

Type: string[] (optional)

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?

Type: { [string]: string } (optional)

The tags that apply to the component.

uri?

Type: string (optional)

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.

Properties

Name	Type	Description
attrArn	`string`	Returns the Amazon Resource Name (ARN) of the component.
attrEncrypted	`IResolvable`	Returns the encryption status of the component.
attrName	`string`	Returns the name of the component.
attrType	`string`	Image Builder determines the component type based on the phases that are defined in the component document.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the component.
node	`ConstructNode`	The construct tree node associated with this construct.
platform	`string`	The operating system platform of the component.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The tags that apply to the component.
version	`string`	The component version.
changeDescription?	`string`	The change description of the component.
data?	`string`	Component `data` contains inline YAML document content for the component.
description?	`string`	Describes the contents of the component.
kmsKeyId?	`string`	The ID of the KMS key that is used to encrypt this component.
supportedOsVersions?	`string[]`	The operating system (OS) version supported by the component.
uri?	`string`	The `uri` of a YAML component document file.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

Returns the Amazon Resource Name (ARN) of the component.

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

attrEncrypted

Type: IResolvable

Returns the encryption status of the component.

For example true or false .

attrName

Type: string

Returns the name of the component.

attrType

Type: string

Image Builder determines the component type based on the phases that are defined in the component document.

If there is only one phase, and its name is "test", then the type is TEST . For all other components, the type is BUILD .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the component.

node

Type: ConstructNode

The construct tree node associated with this construct.

platform

Type: string

The operating system platform of the component.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

version

Type: string

The component version.

For example, 1.0.0 .

changeDescription?

Type: string (optional)

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?

Type: string (optional)

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?

Type: string (optional)

Describes the contents of the component.

kmsKeyId?

Type: string (optional)

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

supportedOsVersions?

Type: string[] (optional)

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.

uri?

Type: string (optional)

The uri of a YAML component document file.

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }