Class CfnComponent
A CloudFormation AWS::ImageBuilder::Component
.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnComponent : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnComponent
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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:
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 |
CfnComponent(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnComponent(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the component. |
AttrEncrypted | Returns the encryption status of the component. |
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 | |
ChangeDescription | The change description of the component. |
Data | Component |
Description | Describes the contents of the component. |
KmsKeyId | The ID of the KMS key that is 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 | The tags that apply to the component. |
Uri | The |
Version | The component version. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnComponentProps
- resource properties.
CfnComponent(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnComponent(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnComponent(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnComponent(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the component.
public virtual string AttrArn { get; }
Property Value
System.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
Remarks
For example true
or false
.
CloudformationAttribute: Encrypted
AttrName
Returns the name of the component.
public virtual string AttrName { get; }
Property Value
System.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
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ChangeDescription
The change description of the component.
public virtual string ChangeDescription { get; set; }
Property Value
System.String
Remarks
Describes what change has been made in this version, or what makes this version different from other versions of this component.
Data
Component data
contains inline YAML document content for the component.
public virtual string Data { get; set; }
Property Value
System.String
Remarks
Alternatively, you can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
Description
Describes the contents of the component.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
KmsKeyId
The ID of the KMS key that is used to encrypt this component.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
Name
The name of the component.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Platform
The operating system platform of the component.
public virtual string Platform { get; set; }
Property Value
System.String
Remarks
SupportedOsVersions
The operating system (OS) version supported by the component.
public virtual string[] SupportedOsVersions { get; set; }
Property Value
System.String[]
Remarks
If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
Tags
The tags that apply to the component.
public virtual TagManager Tags { get; }
Property Value
Remarks
Uri
The uri
of a YAML component document file.
public virtual string Uri { get; set; }
Property Value
System.String
Remarks
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.
Version
The component version.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>