Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
Synopsis
- data CreateContainerRecipe = CreateContainerRecipe' {
- dockerfileTemplateData :: Maybe Text
- imageOsVersionOverride :: Maybe Text
- workingDirectory :: Maybe Text
- dockerfileTemplateUri :: Maybe Text
- kmsKeyId :: Maybe Text
- platformOverride :: Maybe Platform
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- instanceConfiguration :: Maybe InstanceConfiguration
- containerType :: ContainerType
- name :: Text
- semanticVersion :: Text
- components :: NonEmpty ComponentConfiguration
- parentImage :: Text
- targetRepository :: TargetContainerRepository
- clientToken :: Text
- newCreateContainerRecipe :: ContainerType -> Text -> Text -> NonEmpty ComponentConfiguration -> Text -> TargetContainerRepository -> Text -> CreateContainerRecipe
- createContainerRecipe_dockerfileTemplateData :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_imageOsVersionOverride :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_workingDirectory :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_dockerfileTemplateUri :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_kmsKeyId :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_platformOverride :: Lens' CreateContainerRecipe (Maybe Platform)
- createContainerRecipe_description :: Lens' CreateContainerRecipe (Maybe Text)
- createContainerRecipe_tags :: Lens' CreateContainerRecipe (Maybe (HashMap Text Text))
- createContainerRecipe_instanceConfiguration :: Lens' CreateContainerRecipe (Maybe InstanceConfiguration)
- createContainerRecipe_containerType :: Lens' CreateContainerRecipe ContainerType
- createContainerRecipe_name :: Lens' CreateContainerRecipe Text
- createContainerRecipe_semanticVersion :: Lens' CreateContainerRecipe Text
- createContainerRecipe_components :: Lens' CreateContainerRecipe (NonEmpty ComponentConfiguration)
- createContainerRecipe_parentImage :: Lens' CreateContainerRecipe Text
- createContainerRecipe_targetRepository :: Lens' CreateContainerRecipe TargetContainerRepository
- createContainerRecipe_clientToken :: Lens' CreateContainerRecipe Text
- data CreateContainerRecipeResponse = CreateContainerRecipeResponse' {}
- newCreateContainerRecipeResponse :: Int -> CreateContainerRecipeResponse
- createContainerRecipeResponse_requestId :: Lens' CreateContainerRecipeResponse (Maybe Text)
- createContainerRecipeResponse_clientToken :: Lens' CreateContainerRecipeResponse (Maybe Text)
- createContainerRecipeResponse_containerRecipeArn :: Lens' CreateContainerRecipeResponse (Maybe Text)
- createContainerRecipeResponse_httpStatus :: Lens' CreateContainerRecipeResponse Int
Creating a Request
data CreateContainerRecipe Source #
See: newCreateContainerRecipe
smart constructor.
CreateContainerRecipe' | |
|
Instances
newCreateContainerRecipe Source #
:: ContainerType | |
-> Text | |
-> Text | |
-> NonEmpty ComponentConfiguration | |
-> Text | |
-> TargetContainerRepository | |
-> Text | |
-> 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:
$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_containerType :: Lens' CreateContainerRecipe ContainerType Source #
The type of container to create.
createContainerRecipe_name :: Lens' CreateContainerRecipe Text Source #
The name of the container recipe.
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_targetRepository :: Lens' CreateContainerRecipe TargetContainerRepository Source #
The destination repository for the container image.
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.
CreateContainerRecipeResponse' | |
|
Instances
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.
createContainerRecipeResponse_httpStatus :: Lens' CreateContainerRecipeResponse Int Source #
The response's http status code.