imagebuilder/aws.sdk.kotlin.services.imagebuilder.model/Component

Component

class Component

A detailed view of a component.

Types

object Companion

Properties

val arn: String?

The Amazon Resource Name (ARN) of the component.

changeDescription

val changeDescription: String?

Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

val data: String?

Component data contains the YAML document content for the component.

val dateCreated: String?

The date that Image Builder created the component.

val description: String?

The description of the component.

val encrypted: Boolean?

The encryption status of the component.

val kmsKeyId: String?

The KMS key identifier used to encrypt the component.

val name: String?

The name of the component.

val obfuscate: Boolean

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

val owner: String?

The owner of the component.

val parameters: List<ComponentParameterDetail>?

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

val platform: Platform?

The operating system platform of the component.

val productCodes: List<ProductCodeListItem>?

Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

val publisher: String?

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

val state: ComponentState?

Describes the current status of the component.

supportedOsVersions

val supportedOsVersions: List<String>?

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.

val tags: Map<String, String>?

The tags that apply to the component.

val type: ComponentType?

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

val version: String?

The version of the component.

Functions

inline fun copy(block: Component.Builder.() -> Unit = {}): Component

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String