class Aws::Imagebuilder::Types::CreateImageRecipeRequest

@note When making an API call, you may pass CreateImageRecipeRequest

data as a hash:

    {
      name: "ResourceName", # required
      description: "NonEmptyString",
      semantic_version: "VersionNumber", # required
      components: [ # required
        {
          component_arn: "ComponentVersionArnOrBuildVersionArn", # required
          parameters: [
            {
              name: "ComponentParameterName", # required
              value: ["ComponentParameterValue"], # 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, gp3, sc1, st1
          },
          virtual_name: "NonEmptyString",
          no_device: "EmptyString",
        },
      ],
      tags: {
        "TagKey" => "TagValue",
      },
      working_directory: "NonEmptyString",
      additional_instance_configuration: {
        systems_manager_agent: {
          uninstall_after_build: false,
        },
        user_data_override: "UserDataOverride",
      },
      client_token: "ClientToken", # required
    }

@!attribute [rw] name

The name of the image recipe.
@return [String]

@!attribute [rw] description

The description of the image recipe.
@return [String]

@!attribute [rw] semantic_version

The semantic version of the image recipe. This version follows the
semantic version syntax.

<note markdown="1"> The semantic version has four nodes:
&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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
2^30-1, or 1073741823 for each node. Image Builder automatically
assigns the build number, and that is not open for updates.

 **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.

 </note>
@return [String]

@!attribute [rw] components

The components of the image recipe.
@return [Array<Types::ComponentConfiguration>]

@!attribute [rw] parent_image

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/x.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.
@return [String]

@!attribute [rw] block_device_mappings

The block device mappings of the image recipe.
@return [Array<Types::InstanceBlockDeviceMapping>]

@!attribute [rw] tags

The tags of the image recipe.
@return [Hash<String,String>]

@!attribute [rw] working_directory

The working directory used during build and test workflows.
@return [String]

@!attribute [rw] additional_instance_configuration

Specify additional settings and launch scripts for your build
instances.
@return [Types::AdditionalInstanceConfiguration]

@!attribute [rw] client_token

The idempotency token used to make this request idempotent.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeRequest AWS API Documentation

Constants

SENSITIVE