Skip to content

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

Description

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:

  • Inline, using the data property in the request body.
  • A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

Image Builder determines the component type from the document. If the document contains a single phase named test, the component type is TEST. Otherwise, the component type is BUILD.

Usage

imagebuilder_create_component(name, semanticVersion, description,
  changeDescription, platform, supportedOsVersions, data, uri, kmsKeyId,
  tags, clientToken, dryRun)

Arguments

  • name

    [required] The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.

  • semanticVersion

    [required] The semantic version of the component. This version follows the semantic version syntax.

    The semantic version has four nodes: \<major>.\<minor>.\<patch>/\<build>. You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • description

    Describes the contents of the component.

  • changeDescription

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

  • platform

    [required] The operating system platform of the component.

  • supportedOsVersions

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

  • data

    Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

  • uri

    The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and you 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 for component size, which is 64 KB by default.

    Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

  • kmsKeyId

    The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.

  • tags

    The tags that apply to the component.

  • clientToken

    [required] A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

  • dryRun

    Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Value

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  componentBuildVersionArn = "string",
  latestVersionReferences = list(
    latestVersionArn = "string",
    latestMajorVersionArn = "string",
    latestMinorVersionArn = "string",
    latestPatchVersionArn = "string"
  )
)

Request syntax

svc$create_component(
  name = "string",
  semanticVersion = "string",
  description = "string",
  changeDescription = "string",
  platform = "Windows"|"Linux"|"macOS",
  supportedOsVersions = list(
    "string"
  ),
  data = "string",
  uri = "string",
  kmsKeyId = "string",
  tags = list(
    "string"
  ),
  clientToken = "string",
  dryRun = TRUE|FALSE
)