[ aws . imagebuilder ]

get-container-recipe

Description

Retrieves a container recipe.

See also: AWS API Documentation

Synopsis

  get-container-recipe
--container-recipe-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--container-recipe-arn (string) [required]

The Amazon Resource Name (ARN) of the container recipe to retrieve.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/(?:[0-9]+|x)\.(?:[0-9]+|x)\.(?:[0-9]+|x)$

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

requestId -> (string)

The request ID that uniquely identifies this request.

Constraints:

• min: 1
• max: 1024

containerRecipe -> (structure)

The container recipe object that is returned.

arn -> (string)

The Amazon Resource Name (ARN) of the container recipe.

Note

Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows:

• Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
• Version ARNs have only the first three nodes: <major>.<minor>.<patch>
• Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

containerType -> (string)

Specifies the type of container, such as Docker.

Possible values:

• DOCKER

name -> (string)

The name of the container recipe.

Constraints:

• pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

description -> (string)

The description of the container recipe.

Constraints:

• min: 1
• max: 1024

platform -> (string)

The system platform for the container. Container recipes support only the Linux and Windows platforms.

Possible values:

• Windows
• Linux
• macOS

owner -> (string)

The owner of the container recipe.

Constraints:

• min: 1
• max: 1024

version -> (string)

The semantic version of the container recipe.

Note

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. The upper limit is 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.

Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Constraints:

• pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

components -> (list)

Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference .

Constraints:

• min: 1

(structure)

Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.

componentArn -> (string) [required]

The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a component version ARN whose version segments can use x wildcards, for example 1.x.x .

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$

parameters -> (list)

A group of parameter settings that Image Builder uses to configure the component for a specific recipe. You must supply a value for every component parameter that has no default value, and you can only supply parameters that the component defines.

Constraints:

• min: 1

(structure)

Contains a key/value pair that sets the named component parameter.

name -> (string) [required]

The name of the component parameter to set.

Constraints:

• min: 1
• max: 256
• pattern: [^\x00]+

value -> (list) [required]

Sets the value for the named component parameter.

(string)

Constraints:

• min: 0
• pattern: [^\x00]*

instanceConfiguration -> (structure)

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

image -> (string)

The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN.

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

Constraints:

• min: 1
• max: 1024

blockDeviceMappings -> (list)

Defines the block device mappings for the EC2 instance that Image Builder launches to build and test your container image.

(structure)

Defines block device mappings for the instance used to configure your image.

deviceName -> (string)

The device to which these mappings apply.

Constraints:

• min: 1
• max: 1024

ebs -> (structure)

The Amazon EBS-specific configuration for this mapping.

encrypted -> (boolean)

Specifies whether to encrypt the device.

deleteOnTermination -> (boolean)

Specifies whether to delete the associated device on termination.

iops -> (integer)

The IOPS value for the device. Required only when volumeType is io1 or io2.

Constraints:

• min: 100
• max: 64000

kmsKeyId -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide .

Constraints:

• min: 1
• max: 1024

snapshotId -> (string)

The snapshot that defines the device contents.

Constraints:

• min: 1
• max: 1024

volumeSize -> (integer)

Overrides the volume size for the device.

Constraints:

• min: 1
• max: 16000

volumeType -> (string)

Overrides the volume type for the device.

Possible values:

• standard
• io1
• io2
• gp2
• gp3
• sc1
• st1

throughput -> (integer)

For GP3 volumes only – The throughput in MiB/s that the volume supports.

Constraints:

• min: 125
• max: 1000

virtualName -> (string)

The virtual device name for instance ephemeral devices.

Constraints:

• min: 1
• max: 1024

noDevice -> (string)

Specifies a mapping to remove from the base image.

Constraints:

• min: 0
• max: 0

dockerfileTemplateData -> (string)

The Dockerfile template that Image Builder uses to build the container image. The template can include contextual variables that Image Builder replaces with build information at build time. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide .

kmsKeyId -> (string)

The KMS key that Image Builder uses to encrypt the recipe’s Dockerfile template data at rest. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide . If you don’t specify a key, Image Builder encrypts the template data with a KMS key that Image Builder owns. This key isn’t used to encrypt the output container image.

Constraints:

• min: 1
• max: 1024

encrypted -> (boolean)

Specifies whether the recipe’s Dockerfile template data is encrypted at rest. Image Builder encrypts all Dockerfile template data at rest, so this value is always true . This field is retained for backward compatibility, and doesn’t describe encryption of the output container image.

parentImage -> (string)

The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest .

Constraints:

• min: 1
• max: 1024

dateCreated -> (string)

The date when this container recipe was created.

tags -> (map)

Tags that are attached to the container recipe.

Constraints:

• min: 1
• max: 50

key -> (string)

Constraints:

• min: 1
• max: 128
• pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

value -> (string)

Constraints:

• max: 256

workingDirectory -> (string)

The working directory for use during build and test workflows.

Constraints:

• min: 1
• max: 1024

targetRepository -> (structure)

The destination repository for the container image.

service -> (string) [required]

Specifies the service in which this image was registered.

Possible values:

• ECR

repositoryName -> (string) [required]

The name of the container repository where the output container image is stored. Provide the repository name only (a namespace path such as team-a/my-repo is allowed, but not the registry hostname).

Constraints:

• min: 1
• max: 1024

latestVersionReferences -> (structure)

A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.

latestVersionArn -> (string)

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestMajorVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestMinorVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestPatchVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Constraints:

• pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$