libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ImageBuilder.CreateImageRecipe

Description

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Synopsis

Creating a Request

data CreateImageRecipe Source #

See: newCreateImageRecipe smart constructor.

Constructors

CreateImageRecipe' 

Fields

  • additionalInstanceConfiguration :: Maybe AdditionalInstanceConfiguration

    Specify additional settings and launch scripts for your build instances.

  • workingDirectory :: Maybe Text

    The working directory used during build and test workflows.

  • blockDeviceMappings :: Maybe [InstanceBlockDeviceMapping]

    The block device mappings of the image recipe.

  • description :: Maybe Text

    The description of the image recipe.

  • tags :: Maybe (HashMap Text Text)

    The tags of the image recipe.

  • name :: Text

    The name of the image recipe.

  • semanticVersion :: Text

    The semantic version of the image recipe. 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 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.

  • components :: NonEmpty ComponentConfiguration

    The components of the image recipe.

  • parentImage :: Text

    The base image of the image recipe. The value of the string can be the ARN of the base 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.

  • clientToken :: Text

    The idempotency token used to make this request idempotent.

Instances

Instances details
Eq CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Read CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Show CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Generic CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Associated Types

type Rep CreateImageRecipe :: Type -> Type #

NFData CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Methods

rnf :: CreateImageRecipe -> () #

Hashable CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

ToJSON CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

AWSRequest CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Associated Types

type AWSResponse CreateImageRecipe #

ToHeaders CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

ToPath CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

ToQuery CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

type Rep CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

type AWSResponse CreateImageRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

newCreateImageRecipe Source #

Create a value of CreateImageRecipe with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalInstanceConfiguration:CreateImageRecipe', createImageRecipe_additionalInstanceConfiguration - Specify additional settings and launch scripts for your build instances.

$sel:workingDirectory:CreateImageRecipe', createImageRecipe_workingDirectory - The working directory used during build and test workflows.

$sel:blockDeviceMappings:CreateImageRecipe', createImageRecipe_blockDeviceMappings - The block device mappings of the image recipe.

$sel:description:CreateImageRecipe', createImageRecipe_description - The description of the image recipe.

$sel:tags:CreateImageRecipe', createImageRecipe_tags - The tags of the image recipe.

$sel:name:CreateImageRecipe', createImageRecipe_name - The name of the image recipe.

$sel:semanticVersion:CreateImageRecipe', createImageRecipe_semanticVersion - The semantic version of the image recipe. 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 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.

$sel:components:CreateImageRecipe', createImageRecipe_components - The components of the image recipe.

$sel:parentImage:CreateImageRecipe', createImageRecipe_parentImage - The base image of the image recipe. The value of the string can be the ARN of the base 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.

$sel:clientToken:CreateImageRecipe', createImageRecipe_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

createImageRecipe_additionalInstanceConfiguration :: Lens' CreateImageRecipe (Maybe AdditionalInstanceConfiguration) Source #

Specify additional settings and launch scripts for your build instances.

createImageRecipe_workingDirectory :: Lens' CreateImageRecipe (Maybe Text) Source #

The working directory used during build and test workflows.

createImageRecipe_description :: Lens' CreateImageRecipe (Maybe Text) Source #

The description of the image recipe.

createImageRecipe_name :: Lens' CreateImageRecipe Text Source #

The name of the image recipe.

createImageRecipe_semanticVersion :: Lens' CreateImageRecipe Text Source #

The semantic version of the image recipe. 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 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.

createImageRecipe_parentImage :: Lens' CreateImageRecipe Text Source #

The base image of the image recipe. The value of the string can be the ARN of the base 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.

createImageRecipe_clientToken :: Lens' CreateImageRecipe Text Source #

The idempotency token used to make this request idempotent.

Destructuring the Response

data CreateImageRecipeResponse Source #

See: newCreateImageRecipeResponse smart constructor.

Constructors

CreateImageRecipeResponse' 

Fields

Instances

Instances details
Eq CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Read CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Show CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Generic CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

Associated Types

type Rep CreateImageRecipeResponse :: Type -> Type #

NFData CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

type Rep CreateImageRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateImageRecipe

type Rep CreateImageRecipeResponse = D1 ('MetaData "CreateImageRecipeResponse" "Amazonka.ImageBuilder.CreateImageRecipe" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateImageRecipeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "imageRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateImageRecipeResponse Source #

Create a value of CreateImageRecipeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:CreateImageRecipeResponse', createImageRecipeResponse_requestId - The request ID that uniquely identifies this request.

$sel:clientToken:CreateImageRecipe', createImageRecipeResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:imageRecipeArn:CreateImageRecipeResponse', createImageRecipeResponse_imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that was created by this request.

$sel:httpStatus:CreateImageRecipeResponse', createImageRecipeResponse_httpStatus - The response's http status code.

Response Lenses

createImageRecipeResponse_requestId :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImageRecipeResponse_clientToken :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImageRecipeResponse_imageRecipeArn :: Lens' CreateImageRecipeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that was created by this request.