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

Description

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Synopsis

Creating a Request

data CreateContainerRecipe Source #

See: newCreateContainerRecipe smart constructor.

Constructors

CreateContainerRecipe' 

Fields

Instances

Instances details
Eq CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Read CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Show CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Generic CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type Rep CreateContainerRecipe :: Type -> Type #

NFData CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

rnf :: CreateContainerRecipe -> () #

Hashable CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

ToJSON CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

AWSRequest CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type AWSResponse CreateContainerRecipe #

ToHeaders CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

ToPath CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

ToQuery CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipe = D1 ('MetaData "CreateContainerRecipe" "Amazonka.ImageBuilder.CreateContainerRecipe" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateContainerRecipe'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "dockerfileTemplateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageOsVersionOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "workingDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dockerfileTemplateUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Platform))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: (((S1 ('MetaSel ('Just "instanceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceConfiguration)) :*: S1 ('MetaSel ('Just "containerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContainerType)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ComponentConfiguration)) :*: S1 ('MetaSel ('Just "parentImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "targetRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetContainerRepository) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateContainerRecipe Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

newCreateContainerRecipe Source #

Create a value of CreateContainerRecipe 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:dockerfileTemplateData:CreateContainerRecipe', createContainerRecipe_dockerfileTemplateData - The Dockerfile template used to build your image as an inline data blob.

$sel:imageOsVersionOverride:CreateContainerRecipe', createContainerRecipe_imageOsVersionOverride - Specifies the operating system version for the base image.

$sel:workingDirectory:CreateContainerRecipe', createContainerRecipe_workingDirectory - The working directory for use during build and test workflows.

$sel:dockerfileTemplateUri:CreateContainerRecipe', createContainerRecipe_dockerfileTemplateUri - The Amazon S3 URI for the Dockerfile that will be used to build your container image.

$sel:kmsKeyId:CreateContainerRecipe', createContainerRecipe_kmsKeyId - Identifies which KMS key is used to encrypt the container image.

$sel:platformOverride:CreateContainerRecipe', createContainerRecipe_platformOverride - Specifies the operating system platform when you use a custom base image.

$sel:description:CreateContainerRecipe', createContainerRecipe_description - The description of the container recipe.

$sel:tags:CreateContainerRecipe', createContainerRecipe_tags - Tags that are attached to the container recipe.

$sel:instanceConfiguration:CreateContainerRecipe', createContainerRecipe_instanceConfiguration - A group of options that can be used to configure an instance for building and testing container images.

$sel:containerType:CreateContainerRecipe', createContainerRecipe_containerType - The type of container to create.

$sel:name:CreateContainerRecipe', createContainerRecipe_name - The name of the container recipe.

$sel:semanticVersion:CreateContainerRecipe', createContainerRecipe_semanticVersion - The semantic version of the container 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:CreateContainerRecipe', createContainerRecipe_components - Components for build and test that are included in the container recipe.

$sel:parentImage:CreateContainerRecipe', createContainerRecipe_parentImage - The base image for the container recipe.

$sel:targetRepository:CreateContainerRecipe', createContainerRecipe_targetRepository - The destination repository for the container image.

$sel:clientToken:CreateContainerRecipe', createContainerRecipe_clientToken - The client token used to make this request idempotent.

Request Lenses

createContainerRecipe_dockerfileTemplateData :: Lens' CreateContainerRecipe (Maybe Text) Source #

The Dockerfile template used to build your image as an inline data blob.

createContainerRecipe_imageOsVersionOverride :: Lens' CreateContainerRecipe (Maybe Text) Source #

Specifies the operating system version for the base image.

createContainerRecipe_workingDirectory :: Lens' CreateContainerRecipe (Maybe Text) Source #

The working directory for use during build and test workflows.

createContainerRecipe_dockerfileTemplateUri :: Lens' CreateContainerRecipe (Maybe Text) Source #

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

createContainerRecipe_kmsKeyId :: Lens' CreateContainerRecipe (Maybe Text) Source #

Identifies which KMS key is used to encrypt the container image.

createContainerRecipe_platformOverride :: Lens' CreateContainerRecipe (Maybe Platform) Source #

Specifies the operating system platform when you use a custom base image.

createContainerRecipe_description :: Lens' CreateContainerRecipe (Maybe Text) Source #

The description of the container recipe.

createContainerRecipe_tags :: Lens' CreateContainerRecipe (Maybe (HashMap Text Text)) Source #

Tags that are attached to the container recipe.

createContainerRecipe_instanceConfiguration :: Lens' CreateContainerRecipe (Maybe InstanceConfiguration) Source #

A group of options that can be used to configure an instance for building and testing container images.

createContainerRecipe_semanticVersion :: Lens' CreateContainerRecipe Text Source #

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

createContainerRecipe_components :: Lens' CreateContainerRecipe (NonEmpty ComponentConfiguration) Source #

Components for build and test that are included in the container recipe.

createContainerRecipe_parentImage :: Lens' CreateContainerRecipe Text Source #

The base image for the container recipe.

createContainerRecipe_clientToken :: Lens' CreateContainerRecipe Text Source #

The client token used to make this request idempotent.

Destructuring the Response

data CreateContainerRecipeResponse Source #

See: newCreateContainerRecipeResponse smart constructor.

Constructors

CreateContainerRecipeResponse' 

Fields

Instances

Instances details
Eq CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Read CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Show CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Generic CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type Rep CreateContainerRecipeResponse :: Type -> Type #

NFData CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipeResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipeResponse = D1 ('MetaData "CreateContainerRecipeResponse" "Amazonka.ImageBuilder.CreateContainerRecipe" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateContainerRecipeResponse'" '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 "containerRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateContainerRecipeResponse Source #

Create a value of CreateContainerRecipeResponse 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:CreateContainerRecipeResponse', createContainerRecipeResponse_requestId - The request ID that uniquely identifies this request.

$sel:clientToken:CreateContainerRecipe', createContainerRecipeResponse_clientToken - The client token used to make this request idempotent.

$sel:containerRecipeArn:CreateContainerRecipeResponse', createContainerRecipeResponse_containerRecipeArn - Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

$sel:httpStatus:CreateContainerRecipeResponse', createContainerRecipeResponse_httpStatus - The response's http status code.

Response Lenses

createContainerRecipeResponse_requestId :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createContainerRecipeResponse_clientToken :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

The client token used to make this request idempotent.

createContainerRecipeResponse_containerRecipeArn :: Lens' CreateContainerRecipeResponse (Maybe Text) Source #

Returns the Amazon Resource Name (ARN) of the container recipe that the request created.