Interface ICfnComponentProps
Properties for defining a CfnComponent
.
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnComponentProps
Syntax (vb)
Public Interface ICfnComponentProps
Remarks
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 cfnComponentProps = 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
Properties
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. |
Properties
ChangeDescription
The change description of the component.
virtual string ChangeDescription { get; }
Property Value
System.String
Remarks
Describes what change has been made in this version, or what makes this version different from other versions of the component.
Data
Component data
contains inline YAML document content for the component.
virtual string Data { get; }
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.
virtual string Description { get; }
Property Value
System.String
Remarks
KmsKeyId
The ID of the KMS key that is used to encrypt this component.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
Name
The name of the component.
string Name { get; }
Property Value
System.String
Remarks
Platform
The operating system platform of the component.
string Platform { get; }
Property Value
System.String
Remarks
SupportedOsVersions
The operating system (OS) version supported by the component.
virtual string[] SupportedOsVersions { get; }
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.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Uri
The uri
of a YAML component document file.
virtual string Uri { get; }
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.
string Version { get; }
Property Value
System.String