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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Note:

When making an API call, you may pass CreateComponentRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_descriptionString

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)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The idempotency token of the component.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dataString

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)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the component.

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#platformString

The platform of the component.

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_versionString

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, with an upper limit of 230-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.

Returns:

  • (String)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#supported_os_versionsArray<String>

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.

Returns:

  • (Array<String>)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags of the component.

Returns:

  • (Hash<String,String>)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#uriString

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon 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)


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 952

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end