[ aws . imagebuilder ]
create-container-recipe¶
Description¶
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-container-recipe
--container-type <value>
--name <value>
[--description <value>]
--semantic-version <value>
--components <value>
--dockerfile-template-data <value>
[--dockerfile-template-uri <value>]
[--platform-override <value>]
[--image-os-version-override <value>]
--parent-image <value>
[--tags <value>]
[--working-directory <value>]
--target-repository <value>
[--kms-key-id <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--container-type (string)
The type of container to create.
Possible values:
DOCKER
--name (string)
The name of the container recipe.
--description (string)
The description of the container recipe.
--semantic-version (string)
The semantic version of the container recipe (<major>.<minor>.<patch>).
--components (list)
Components for build and test that are included in the container recipe.
(structure)
Configuration details of the component.
componentArn -> (string)
The Amazon Resource Name (ARN) of the component.
Shorthand Syntax:
componentArn=string ...
JSON Syntax:
[
{
"componentArn": "string"
}
...
]
--dockerfile-template-data (string)
The Dockerfile template used to build your image as an inline data blob.
--dockerfile-template-uri (string)
The S3 URI for the Dockerfile that will be used to build your container image.
--platform-override (string)
Specifies the operating system platform when you use a custom source image.
Possible values:
Windows
Linux
--image-os-version-override (string)
Specifies the operating system version for the source image.
--parent-image (string)
The source image for the container recipe.
--tags (map)
Tags that are attached to the container recipe.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--working-directory (string)
The working directory for use during build and test workflows.
--target-repository (structure)
The destination repository for the container image.
service -> (string)
Specifies the service in which this image was registered.
repositoryName -> (string)
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
Shorthand Syntax:
service=string,repositoryName=string
JSON Syntax:
{
"service": "ECR",
"repositoryName": "string"
}
--kms-key-id (string)
Identifies which KMS key is used to encrypt the container image.
--client-token (string)
The client token used to make this request idempotent.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
requestId -> (string)
The request ID that uniquely identifies this request.
clientToken -> (string)
The client token used to make this request idempotent.
containerRecipeArn -> (string)
Returns the Amazon Resource Name (ARN) of the container recipe that the request created.