Component

import type { Component } from "https://aws-api.deno.dev/v0.4/services/imagebuilder.ts?docs=full";

A detailed view of a component.

interface Component {

arn?: string | null;

changeDescription?: string | null;

data?: string | null;

dateCreated?: string | null;

description?: string | null;

encrypted?: boolean | null;

kmsKeyId?: string | null;

name?: string | null;

obfuscate?: boolean | null;

owner?: string | null;

parameters?: ComponentParameterDetail[] | null;

platform?: Platform | null;

publisher?: string | null;

state?: ComponentState | null;

supportedOsVersions?: string[] | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

type?: ComponentType | null;

version?: string | null;

}

§Properties

arn?: string | null

[src]

The Amazon Resource Name (ARN) of the component.

changeDescription?: string | null

[src]

The change description of the component.

data?: string | null

[src]

Component data contains the YAML document content for the component.

dateCreated?: string | null

[src]

The date that Image Builder created the component.

description?: string | null

[src]

The description of the component.

encrypted?: boolean | null

[src]

The encryption status of the component.

kmsKeyId?: string | null

[src]

The KMS key identifier used to encrypt the component.

name?: string | null

[src]

The name of the component.

obfuscate?: boolean | null

[src]

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

owner?: string | null

[src]

The owner of the component.

parameters?: ComponentParameterDetail[] | null

[src]

Contains parameter details for each of the parameters that the component document defined for the component.

platform?: Platform | null

[src]

The operating system platform of the component.

publisher?: string | null

[src]

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

state?: ComponentState | null

[src]

Describes the current status of the component. This is used for components that are no longer active.

supportedOsVersions?: string[] | null

[src]

The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

The tags that apply to the component.

type?: ComponentType | null

[src]

The component type specifies whether Image Builder uses the component to build the image or only to test it.

version?: string | null

[src]

The version of the component.