Class CfnComponent

Creates a new component that can be used to build, validate, test, and assess your image.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnComponent

Implements

IInspectable

IComponentRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnComponent : CfnResource, IInspectable, IComponentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnComponent Inherits CfnResource Implements IInspectable, IComponentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ImageBuilder;

             var cfnComponent = new CfnComponent(this, "MyCfnComponent", new CfnComponentProps {
                 Name = "name",
                 Platform = "platform",
                 Version = "version",

                 // the properties below are optional
                 ChangeDescription = "changeDescription",
                 Data = "data",
                 Description = "description",
                 KmsKeyId = "kmsKeyId",
                 SupportedOsVersions = new [] { "supportedOsVersions" },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Uri = "uri"
             });

Synopsis

Constructors

CfnComponent(Construct, string, ICfnComponentProps)

Create a new AWS::ImageBuilder::Component.

Properties

AttrArn	Returns the Amazon Resource Name (ARN) of the component.
AttrEncrypted	Returns the encryption status of the component.
AttrLatestVersion	The latest version references of the component.
AttrLatestVersionArn	The latest version Amazon Resource Name (ARN) of the Image Builder resource.
AttrLatestVersionMajor	The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
AttrLatestVersionMinor	The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
AttrLatestVersionPatch	The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
AttrName	Returns the name of the component.
AttrType	Image Builder determines the component type based on the phases that are defined in the component document.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a new component that can be used to build, validate, test, and assess your image.
CfnPropertyNames	Creates a new component that can be used to build, validate, test, and assess your image.
ChangeDescription	The change description of the component.
ComponentRef	A reference to a Component resource.
Data	Component data contains inline YAML document content for the component.
Description	Describes the contents of the component.
KmsKeyId	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.
Name	The name of the component.
Platform	The operating system platform of the component.
SupportedOsVersions	The operating system (OS) version supported by the component.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags that apply to the component.
Uri	The uri of a YAML component document file.
Version	The semantic version of the component.

Methods

ArnForComponent(IComponentRef)	Creates a new component that can be used to build, validate, test, and assess your image.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnComponent(object)	Checks whether the given object is a CfnComponent.
RenderProperties(IDictionary<string, object>)	Creates a new component that can be used to build, validate, test, and assess your image.

Constructors

CfnComponent(Construct, string, ICfnComponentProps)

Create a new AWS::ImageBuilder::Component.

public CfnComponent(Construct scope, string id, ICfnComponentProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnComponentProps

Resource properties.

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

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+)?)?$ .

CloudformationAttribute: Arn

AttrEncrypted

Returns the encryption status of the component.

public virtual IResolvable AttrEncrypted { get; }

Property Value

IResolvable

Remarks

For example true or false .

CloudformationAttribute: Encrypted

AttrLatestVersion

The latest version references of the component.

public virtual IResolvable AttrLatestVersion { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: LatestVersion

AttrLatestVersionArn

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

public virtual string AttrLatestVersionArn { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Arn

AttrLatestVersionMajor

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

public virtual string AttrLatestVersionMajor { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Major

AttrLatestVersionMinor

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

public virtual string AttrLatestVersionMinor { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Minor

AttrLatestVersionPatch

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

public virtual string AttrLatestVersionPatch { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Patch

AttrName

Returns the name of the component.

public virtual string AttrName { get; }

Property Value

string

Remarks

CloudformationAttribute: Name

AttrType

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

public virtual string AttrType { get; }

Property Value

string

Remarks

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

CloudformationAttribute: Type

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new component that can be used to build, validate, test, and assess your image.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a new component that can be used to build, validate, test, and assess your image.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

ChangeDescription

The change description of the component.

public virtual string? ChangeDescription { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

ComponentRef

A reference to a Component resource.

public virtual IComponentReference ComponentRef { get; }

Property Value

IComponentReference

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Data

Component data contains inline YAML document content for the component.

public virtual string? Data { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Description

Describes the contents of the component.

public virtual string? Description { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

KmsKeyId

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.

public virtual string? KmsKeyId { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Name

The name of the component.

public virtual string Name { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Platform

The operating system platform of the component.

public virtual string Platform { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

SupportedOsVersions

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

public virtual string[]? SupportedOsVersions { get; set; }

Property Value

string[]

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

TagsRaw

The tags that apply to the component.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Uri

The uri of a YAML component document file.

public virtual string? Uri { get; set; }

Property Value

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Version

The semantic version of the component.

public virtual string Version { get; set; }

Property Value

string

Remarks

This version follows the semantic version syntax.

Methods

ArnForComponent(IComponentRef)

Creates a new component that can be used to build, validate, test, and assess your image.

public static string ArnForComponent(IComponentRef resource)

Parameters

resource IComponentRef

Returns

string

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ImageBuilder;

             var cfnComponent = new CfnComponent(this, "MyCfnComponent", new CfnComponentProps {
                 Name = "name",
                 Platform = "platform",
                 Version = "version",

                 // the properties below are optional
                 ChangeDescription = "changeDescription",
                 Data = "data",
                 Description = "description",
                 KmsKeyId = "kmsKeyId",
                 SupportedOsVersions = new [] { "supportedOsVersions" },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Uri = "uri"
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

IsCfnComponent(object)

Checks whether the given object is a CfnComponent.

public static bool IsCfnComponent(object x)

Parameters

x object

Returns

bool

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new component that can be used to build, validate, test, and assess your image.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The component is based on a YAML document that you specify using exactly one of the following methods:

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

CloudformationResource: AWS::ImageBuilder::Component

ExampleMetadata: fixture=_generated

Implements

IInspectable

IComponentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable