You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Imagebuilder::Types::CreateComponentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateComponentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ResourceName", # required
  semantic_version: "VersionNumber", # required
  description: "NonEmptyString",
  change_description: "NonEmptyString",
  platform: "Windows", # required, accepts Windows, Linux
  supported_os_versions: ["OsVersion"],
  data: "InlineComponentData",
  uri: "Uri",
  kms_key_id: "NonEmptyString",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#change_description ⇒ String

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

Returns:

  • (String) —

    The change description of the component.

#client_token ⇒ String

The idempotency token of the component.

Returns:

  • (String) —

    The idempotency token of the component.

#data ⇒ String

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

Returns:

  • (String) —

    The data of the component.

#description ⇒ String

The description of the component. Describes the contents of the component.

Returns:

  • (String) —

    The description of the component.

#kms_key_id ⇒ String

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

Returns:

  • (String) —

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

#name ⇒ String

The name of the component.

Returns:

  • (String) —

    The name of the component.

#platform ⇒ String

The platform of the component.

Possible values:

  • Windows
  • Linux

Returns:

  • (String) —

    The platform of the component.

#semantic_version ⇒ String

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

Returns:

  • (String) —

    The semantic version of the component.

#supported_os_versions ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#tags ⇒ Hash<String,String>

The tags of the component.

Returns:

  • (Hash<String,String>) —

    The tags of the component.

#uri ⇒ String

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

Returns:

  • (String) —

    The uri of the component.