Amazonka.ImageBuilder.CreateContainerRecipe

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

Creating a Request

data CreateContainerRecipe

See: newCreateContainerRecipe smart constructor.

Constructors

CreateContainerRecipe'

Fields

• description :: Maybe Text

  The description of the container recipe.

• dockerfileTemplateData :: Maybe Text

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

• dockerfileTemplateUri :: Maybe Text

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

• imageOsVersionOverride :: Maybe Text

  Specifies the operating system version for the base image.

• instanceConfiguration :: Maybe InstanceConfiguration

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

• kmsKeyId :: Maybe Text

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

• platformOverride :: Maybe Platform

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

• tags :: Maybe (HashMap Text Text)

  Tags that are attached to the container recipe.

• workingDirectory :: Maybe Text

  The working directory for use during build and test workflows.

• containerType :: ContainerType

  The type of container to create.

• name :: Text

  The name of the container recipe.

• semanticVersion :: Text

  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.

• components :: NonEmpty ComponentConfiguration

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

• parentImage :: Text

  The base image for the container recipe.

• targetRepository :: TargetContainerRepository

  The destination repository for the container image.

• clientToken :: Text

  The client token used to make this request idempotent.

Instances

ToJSON CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

toJSON :: CreateContainerRecipe -> Value

toEncoding :: CreateContainerRecipe -> Encoding

toJSONList :: [CreateContainerRecipe] -> Value

toEncodingList :: [CreateContainerRecipe] -> Encoding

ToHeaders CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

toHeaders :: CreateContainerRecipe -> [Header]

ToPath CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

toPath :: CreateContainerRecipe -> ByteString

ToQuery CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

toQuery :: CreateContainerRecipe -> QueryString

AWSRequest CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type AWSResponse CreateContainerRecipe

Methods

request :: (Service -> Service) -> CreateContainerRecipe -> Request CreateContainerRecipe

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateContainerRecipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateContainerRecipe)))

Generic CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type Rep CreateContainerRecipe :: Type -> Type

Methods

from :: CreateContainerRecipe -> Rep CreateContainerRecipe x

to :: Rep CreateContainerRecipe x -> CreateContainerRecipe

Read CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

readsPrec :: Int -> ReadS CreateContainerRecipe

readList :: ReadS [CreateContainerRecipe]

readPrec :: ReadPrec CreateContainerRecipe

readListPrec :: ReadPrec [CreateContainerRecipe]

Show CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

showsPrec :: Int -> CreateContainerRecipe -> ShowS

show :: CreateContainerRecipe -> String

showList :: [CreateContainerRecipe] -> ShowS

NFData CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

rnf :: CreateContainerRecipe -> ()

Eq CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

(==) :: CreateContainerRecipe -> CreateContainerRecipe -> Bool

(/=) :: CreateContainerRecipe -> CreateContainerRecipe -> Bool

Hashable CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

hashWithSalt :: Int -> CreateContainerRecipe -> Int

hash :: CreateContainerRecipe -> Int

type AWSResponse CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type AWSResponse CreateContainerRecipe = CreateContainerRecipeResponse

type Rep CreateContainerRecipe

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipe = D1 ('MetaData "CreateContainerRecipe" "Amazonka.ImageBuilder.CreateContainerRecipe" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateContainerRecipe'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dockerfileTemplateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dockerfileTemplateUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageOsVersionOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "instanceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceConfiguration)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "platformOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Platform)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: (((S1 ('MetaSel ('Just "workingDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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))))))

newCreateContainerRecipe

Arguments

:: ContainerType

CreateContainerRecipe

-> Text

CreateContainerRecipe

-> Text

$sel:semanticVersion:CreateContainerRecipe'

-> NonEmpty ComponentConfiguration

CreateContainerRecipe

-> Text

CreateContainerRecipe

-> TargetContainerRepository

CreateContainerRecipe

-> Text

CreateContainerRecipe

-> CreateContainerRecipe

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:

CreateContainerRecipe, createContainerRecipe_description - The description of the container recipe.

CreateContainerRecipe, createContainerRecipe_dockerfileTemplateData - The Dockerfile template used to build your image as an inline data blob.

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

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

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

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.

CreateContainerRecipe, createContainerRecipe_tags - Tags that are attached to the container recipe.

CreateContainerRecipe, createContainerRecipe_workingDirectory - The working directory for use during build and test workflows.

CreateContainerRecipe, createContainerRecipe_containerType - The type of container to create.

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.

CreateContainerRecipe, createContainerRecipe_components - Components for build and test that are included in the container recipe.

CreateContainerRecipe, createContainerRecipe_parentImage - The base image for the container recipe.

CreateContainerRecipe, createContainerRecipe_targetRepository - The destination repository for the container image.

CreateContainerRecipe, createContainerRecipe_clientToken - The client token used to make this request idempotent.

Request Lenses

createContainerRecipe_description :: Lens' CreateContainerRecipe (Maybe Text)

The description of the container recipe.

createContainerRecipe_dockerfileTemplateData :: Lens' CreateContainerRecipe (Maybe Text)

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

createContainerRecipe_dockerfileTemplateUri :: Lens' CreateContainerRecipe (Maybe Text)

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

createContainerRecipe_imageOsVersionOverride :: Lens' CreateContainerRecipe (Maybe Text)

Specifies the operating system version for the base image.

createContainerRecipe_instanceConfiguration :: Lens' CreateContainerRecipe (Maybe InstanceConfiguration)

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

createContainerRecipe_kmsKeyId :: Lens' CreateContainerRecipe (Maybe Text)

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

createContainerRecipe_platformOverride :: Lens' CreateContainerRecipe (Maybe Platform)

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

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

Tags that are attached to the container recipe.

createContainerRecipe_workingDirectory :: Lens' CreateContainerRecipe (Maybe Text)

The working directory for use during build and test workflows.

createContainerRecipe_containerType :: Lens' CreateContainerRecipe ContainerType

The type of container to create.

createContainerRecipe_name :: Lens' CreateContainerRecipe Text

The name of the container recipe.

createContainerRecipe_semanticVersion :: Lens' CreateContainerRecipe Text

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)

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

createContainerRecipe_parentImage :: Lens' CreateContainerRecipe Text

The base image for the container recipe.

createContainerRecipe_targetRepository :: Lens' CreateContainerRecipe TargetContainerRepository

The destination repository for the container image.

createContainerRecipe_clientToken :: Lens' CreateContainerRecipe Text

The client token used to make this request idempotent.

Destructuring the Response

data CreateContainerRecipeResponse

See: newCreateContainerRecipeResponse smart constructor.

Constructors

CreateContainerRecipeResponse'

Fields

• clientToken :: Maybe Text

  The client token used to make this request idempotent.

• containerRecipeArn :: Maybe Text

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

• requestId :: Maybe Text

  The request ID that uniquely identifies this request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Associated Types

type Rep CreateContainerRecipeResponse :: Type -> Type

Methods

from :: CreateContainerRecipeResponse -> Rep CreateContainerRecipeResponse x

to :: Rep CreateContainerRecipeResponse x -> CreateContainerRecipeResponse

Read CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

readsPrec :: Int -> ReadS CreateContainerRecipeResponse

readList :: ReadS [CreateContainerRecipeResponse]

readPrec :: ReadPrec CreateContainerRecipeResponse

readListPrec :: ReadPrec [CreateContainerRecipeResponse]

Show CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

showsPrec :: Int -> CreateContainerRecipeResponse -> ShowS

show :: CreateContainerRecipeResponse -> String

showList :: [CreateContainerRecipeResponse] -> ShowS

NFData CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

rnf :: CreateContainerRecipeResponse -> ()

Eq CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

Methods

(==) :: CreateContainerRecipeResponse -> CreateContainerRecipeResponse -> Bool

(/=) :: CreateContainerRecipeResponse -> CreateContainerRecipeResponse -> Bool

type Rep CreateContainerRecipeResponse

Defined in Amazonka.ImageBuilder.CreateContainerRecipe

type Rep CreateContainerRecipeResponse = D1 ('MetaData "CreateContainerRecipeResponse" "Amazonka.ImageBuilder.CreateContainerRecipe" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateContainerRecipeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateContainerRecipeResponse

Arguments

:: Int

$sel:httpStatus:CreateContainerRecipeResponse'

-> CreateContainerRecipeResponse

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:

CreateContainerRecipe, createContainerRecipeResponse_clientToken - The client token used to make this request idempotent.

CreateContainerRecipeResponse, createContainerRecipeResponse_containerRecipeArn - Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

$sel:requestId:CreateContainerRecipeResponse', createContainerRecipeResponse_requestId - The request ID that uniquely identifies this request.

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

Response Lenses

createContainerRecipeResponse_clientToken :: Lens' CreateContainerRecipeResponse (Maybe Text)

The client token used to make this request idempotent.

createContainerRecipeResponse_containerRecipeArn :: Lens' CreateContainerRecipeResponse (Maybe Text)

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

createContainerRecipeResponse_requestId :: Lens' CreateContainerRecipeResponse (Maybe Text)

The request ID that uniquely identifies this request.

createContainerRecipeResponse_httpStatus :: Lens' CreateContainerRecipeResponse Int

The response's http status code.