Class CfnComponent

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnComponent
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnComponent : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnComponent
    Inherits CfnResource
    Implements IInspectable, 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(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
    CfnComponent(Construct, String, ICfnComponentProps)

    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 data contains inline YAML document content for the 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

    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 component version.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.
    RenderProperties(IDictionary<String, Object>)

    Constructors

    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

    CfnComponent(Construct, String, ICfnComponentProps)

    public CfnComponent(Construct scope, string id, ICfnComponentProps props)
    Parameters
    scope Constructs.Construct

    Scope in which this resource is defined.

    id System.String

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

    props ICfnComponentProps

    Resource properties.

    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

    IResolvable

    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

    Data

    Component data contains inline YAML document content for the component.

    public virtual string Data { get; set; }
    Property Value

    System.String

    Description

    Describes the contents of the component.

    public virtual string Description { get; set; }
    Property Value

    System.String

    KmsKeyId

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

    public virtual string KmsKeyId { get; set; }
    Property Value

    System.String

    Name

    The name of the component.

    public virtual string Name { get; set; }
    Property Value

    System.String

    Platform

    The operating system platform of the component.

    public virtual string Platform { get; set; }
    Property Value

    System.String

    SupportedOsVersions

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

    public virtual string[] SupportedOsVersions { get; set; }
    Property Value

    System.String[]

    Tags

    Tag Manager which manages the tags for this resource.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    TagsRaw

    The tags that apply to the component.

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

    System.Collections.Generic.IDictionary<System.String, System.String>

    Uri

    The uri of a YAML component document file.

    public virtual string Uri { get; set; }
    Property Value

    System.String

    Version

    The component version.

    public virtual string Version { get; set; }
    Property Value

    System.String

    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>

    Overrides

    Implements