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

Class: Aws::Imagebuilder::Types::CreateImageRecipeRequest

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

Overview

Note:

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

{
  name: "ResourceName", # required
  description: "NonEmptyString",
  semantic_version: "VersionNumber", # required
  components: [ # required
    {
      component_arn: "ComponentVersionArnOrBuildVersionArn", # required
    },
  ],
  parent_image: "NonEmptyString", # required
  block_device_mappings: [
    {
      device_name: "NonEmptyString",
      ebs: {
        encrypted: false,
        delete_on_termination: false,
        iops: 1,
        kms_key_id: "NonEmptyString",
        snapshot_id: "NonEmptyString",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1
      },
      virtual_name: "NonEmptyString",
      no_device: "EmptyString",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  working_directory: "NonEmptyString",
  client_token: "ClientToken", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

The block device mappings of the image recipe.

Returns:

#client_token ⇒ String

The idempotency token used to make this request idempotent.

Returns:

  • (String) —

    The idempotency token used to make this request idempotent.

#components ⇒ Array<Types::ComponentConfiguration>

The components of the image recipe.

Returns:

#description ⇒ String

The description of the image recipe.

Returns:

  • (String) —

    The description of the image recipe.

#name ⇒ String

The name of the image recipe.

Returns:

  • (String) —

    The name of the image recipe.

#parent_image ⇒ String

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Returns:

  • (String) —

    The parent image of the image recipe.

#semantic_version ⇒ String

The semantic version of the image recipe.

Returns:

  • (String) —

    The semantic version of the image recipe.

#tags ⇒ Hash<String,String>

The tags of the image recipe.

Returns:

  • (Hash<String,String>) —

    The tags of the image recipe.

#working_directory ⇒ String

The working directory to be used during build and test workflows.

Returns:

  • (String) —

    The working directory to be used during build and test workflows.