We recommend new projects start with resources from the AWS provider.
aws-native.imagebuilder.ContainerRecipe
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::ImageBuilder::ContainerRecipe
Create ContainerRecipe Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ContainerRecipe(name: string, args?: ContainerRecipeArgs, opts?: CustomResourceOptions);
@overload
def ContainerRecipe(resource_name: str,
args: Optional[ContainerRecipeArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ContainerRecipe(resource_name: str,
opts: Optional[ResourceOptions] = None,
components: Optional[Sequence[ContainerRecipeComponentConfigurationArgs]] = None,
container_type: Optional[ContainerRecipeContainerType] = None,
description: Optional[str] = None,
dockerfile_template_data: Optional[str] = None,
dockerfile_template_uri: Optional[str] = None,
image_os_version_override: Optional[str] = None,
instance_configuration: Optional[ContainerRecipeInstanceConfigurationArgs] = None,
kms_key_id: Optional[str] = None,
name: Optional[str] = None,
parent_image: Optional[str] = None,
platform_override: Optional[ContainerRecipePlatformOverride] = None,
tags: Optional[Mapping[str, str]] = None,
target_repository: Optional[ContainerRecipeTargetContainerRepositoryArgs] = None,
version: Optional[str] = None,
working_directory: Optional[str] = None)
func NewContainerRecipe(ctx *Context, name string, args *ContainerRecipeArgs, opts ...ResourceOption) (*ContainerRecipe, error)
public ContainerRecipe(string name, ContainerRecipeArgs? args = null, CustomResourceOptions? opts = null)
public ContainerRecipe(String name, ContainerRecipeArgs args)
public ContainerRecipe(String name, ContainerRecipeArgs args, CustomResourceOptions options)
type: aws-native:imagebuilder:ContainerRecipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ContainerRecipeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ContainerRecipeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ContainerRecipeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ContainerRecipeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ContainerRecipeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ContainerRecipe Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ContainerRecipe resource accepts the following input properties:
- Components
List<Pulumi.
Aws Native. Image Builder. Inputs. Container Recipe Component Configuration> - Components for build and test that are included in the container recipe.
- Container
Type Pulumi.Aws Native. Image Builder. Container Recipe Container Type - Specifies the type of container, such as Docker.
- Description string
- The description of the container recipe.
- Dockerfile
Template stringData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- Dockerfile
Template stringUri - The S3 URI for the Dockerfile that will be used to build your container image.
- Image
Os stringVersion Override - Specifies the operating system version for the source image.
- Instance
Configuration Pulumi.Aws Native. Image Builder. Inputs. Container Recipe Instance Configuration - A group of options that can be used to configure an instance for building and testing container images.
- Kms
Key stringId - Identifies which KMS key is used to encrypt the container image.
- Name string
- The name of the container recipe.
- Parent
Image string - The source image for the container recipe.
- Platform
Override Pulumi.Aws Native. Image Builder. Container Recipe Platform Override - Specifies the operating system platform when you use a custom source image.
- Dictionary<string, string>
- Tags that are attached to the container recipe.
- Target
Repository Pulumi.Aws Native. Image Builder. Inputs. Container Recipe Target Container Repository - The destination repository for the container image.
- Version string
- The semantic version of the container recipe (..).
- Working
Directory string - The working directory to be used during build and test workflows.
- Components
[]Container
Recipe Component Configuration Args - Components for build and test that are included in the container recipe.
- Container
Type ContainerRecipe Container Type - Specifies the type of container, such as Docker.
- Description string
- The description of the container recipe.
- Dockerfile
Template stringData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- Dockerfile
Template stringUri - The S3 URI for the Dockerfile that will be used to build your container image.
- Image
Os stringVersion Override - Specifies the operating system version for the source image.
- Instance
Configuration ContainerRecipe Instance Configuration Args - A group of options that can be used to configure an instance for building and testing container images.
- Kms
Key stringId - Identifies which KMS key is used to encrypt the container image.
- Name string
- The name of the container recipe.
- Parent
Image string - The source image for the container recipe.
- Platform
Override ContainerRecipe Platform Override - Specifies the operating system platform when you use a custom source image.
- map[string]string
- Tags that are attached to the container recipe.
- Target
Repository ContainerRecipe Target Container Repository Args - The destination repository for the container image.
- Version string
- The semantic version of the container recipe (..).
- Working
Directory string - The working directory to be used during build and test workflows.
- components
List<Container
Recipe Component Configuration> - Components for build and test that are included in the container recipe.
- container
Type ContainerRecipe Container Type - Specifies the type of container, such as Docker.
- description String
- The description of the container recipe.
- dockerfile
Template StringData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- dockerfile
Template StringUri - The S3 URI for the Dockerfile that will be used to build your container image.
- image
Os StringVersion Override - Specifies the operating system version for the source image.
- instance
Configuration ContainerRecipe Instance Configuration - A group of options that can be used to configure an instance for building and testing container images.
- kms
Key StringId - Identifies which KMS key is used to encrypt the container image.
- name String
- The name of the container recipe.
- parent
Image String - The source image for the container recipe.
- platform
Override ContainerRecipe Platform Override - Specifies the operating system platform when you use a custom source image.
- Map<String,String>
- Tags that are attached to the container recipe.
- target
Repository ContainerRecipe Target Container Repository - The destination repository for the container image.
- version String
- The semantic version of the container recipe (..).
- working
Directory String - The working directory to be used during build and test workflows.
- components
Container
Recipe Component Configuration[] - Components for build and test that are included in the container recipe.
- container
Type ContainerRecipe Container Type - Specifies the type of container, such as Docker.
- description string
- The description of the container recipe.
- dockerfile
Template stringData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- dockerfile
Template stringUri - The S3 URI for the Dockerfile that will be used to build your container image.
- image
Os stringVersion Override - Specifies the operating system version for the source image.
- instance
Configuration ContainerRecipe Instance Configuration - A group of options that can be used to configure an instance for building and testing container images.
- kms
Key stringId - Identifies which KMS key is used to encrypt the container image.
- name string
- The name of the container recipe.
- parent
Image string - The source image for the container recipe.
- platform
Override ContainerRecipe Platform Override - Specifies the operating system platform when you use a custom source image.
- {[key: string]: string}
- Tags that are attached to the container recipe.
- target
Repository ContainerRecipe Target Container Repository - The destination repository for the container image.
- version string
- The semantic version of the container recipe (..).
- working
Directory string - The working directory to be used during build and test workflows.
- components
Sequence[Container
Recipe Component Configuration Args] - Components for build and test that are included in the container recipe.
- container_
type ContainerRecipe Container Type - Specifies the type of container, such as Docker.
- description str
- The description of the container recipe.
- dockerfile_
template_ strdata - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- dockerfile_
template_ struri - The S3 URI for the Dockerfile that will be used to build your container image.
- image_
os_ strversion_ override - Specifies the operating system version for the source image.
- instance_
configuration ContainerRecipe Instance Configuration Args - A group of options that can be used to configure an instance for building and testing container images.
- kms_
key_ strid - Identifies which KMS key is used to encrypt the container image.
- name str
- The name of the container recipe.
- parent_
image str - The source image for the container recipe.
- platform_
override ContainerRecipe Platform Override - Specifies the operating system platform when you use a custom source image.
- Mapping[str, str]
- Tags that are attached to the container recipe.
- target_
repository ContainerRecipe Target Container Repository Args - The destination repository for the container image.
- version str
- The semantic version of the container recipe (..).
- working_
directory str - The working directory to be used during build and test workflows.
- components List<Property Map>
- Components for build and test that are included in the container recipe.
- container
Type "DOCKER" - Specifies the type of container, such as Docker.
- description String
- The description of the container recipe.
- dockerfile
Template StringData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
- dockerfile
Template StringUri - The S3 URI for the Dockerfile that will be used to build your container image.
- image
Os StringVersion Override - Specifies the operating system version for the source image.
- instance
Configuration Property Map - A group of options that can be used to configure an instance for building and testing container images.
- kms
Key StringId - Identifies which KMS key is used to encrypt the container image.
- name String
- The name of the container recipe.
- parent
Image String - The source image for the container recipe.
- platform
Override "Windows" | "Linux" - Specifies the operating system platform when you use a custom source image.
- Map<String>
- Tags that are attached to the container recipe.
- target
Repository Property Map - The destination repository for the container image.
- version String
- The semantic version of the container recipe (..).
- working
Directory String - The working directory to be used during build and test workflows.
Outputs
All input properties are implicitly available as output properties. Additionally, the ContainerRecipe resource produces the following output properties:
Supporting Types
ContainerRecipeComponentConfiguration, ContainerRecipeComponentConfigurationArgs
- Component
Arn string - The Amazon Resource Name (ARN) of the component.
- Parameters
List<Pulumi.
Aws Native. Image Builder. Inputs. Container Recipe Component Parameter> - A group of parameter settings that are used to configure the component for a specific recipe.
- Component
Arn string - The Amazon Resource Name (ARN) of the component.
- Parameters
[]Container
Recipe Component Parameter - A group of parameter settings that are used to configure the component for a specific recipe.
- component
Arn String - The Amazon Resource Name (ARN) of the component.
- parameters
List<Container
Recipe Component Parameter> - A group of parameter settings that are used to configure the component for a specific recipe.
- component
Arn string - The Amazon Resource Name (ARN) of the component.
- parameters
Container
Recipe Component Parameter[] - A group of parameter settings that are used to configure the component for a specific recipe.
- component_
arn str - The Amazon Resource Name (ARN) of the component.
- parameters
Sequence[Container
Recipe Component Parameter] - A group of parameter settings that are used to configure the component for a specific recipe.
- component
Arn String - The Amazon Resource Name (ARN) of the component.
- parameters List<Property Map>
- A group of parameter settings that are used to configure the component for a specific recipe.
ContainerRecipeComponentParameter, ContainerRecipeComponentParameterArgs
ContainerRecipeContainerType, ContainerRecipeContainerTypeArgs
- Docker
- DOCKER
- Container
Recipe Container Type Docker - DOCKER
- Docker
- DOCKER
- Docker
- DOCKER
- DOCKER
- DOCKER
- "DOCKER"
- DOCKER
ContainerRecipeEbsInstanceBlockDeviceSpecification, ContainerRecipeEbsInstanceBlockDeviceSpecificationArgs
- Delete
On boolTermination - Use to configure delete on termination of the associated device.
- Encrypted bool
- Use to configure device encryption.
- Iops int
- Use to configure device IOPS.
- Kms
Key stringId - Use to configure the KMS key to use when encrypting the device.
- Snapshot
Id string - The snapshot that defines the device contents.
- Throughput int
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- Volume
Size int - Use to override the device's volume size.
- Volume
Type Pulumi.Aws Native. Image Builder. Container Recipe Ebs Instance Block Device Specification Volume Type - Use to override the device's volume type.
- Delete
On boolTermination - Use to configure delete on termination of the associated device.
- Encrypted bool
- Use to configure device encryption.
- Iops int
- Use to configure device IOPS.
- Kms
Key stringId - Use to configure the KMS key to use when encrypting the device.
- Snapshot
Id string - The snapshot that defines the device contents.
- Throughput int
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- Volume
Size int - Use to override the device's volume size.
- Volume
Type ContainerRecipe Ebs Instance Block Device Specification Volume Type - Use to override the device's volume type.
- delete
On BooleanTermination - Use to configure delete on termination of the associated device.
- encrypted Boolean
- Use to configure device encryption.
- iops Integer
- Use to configure device IOPS.
- kms
Key StringId - Use to configure the KMS key to use when encrypting the device.
- snapshot
Id String - The snapshot that defines the device contents.
- throughput Integer
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volume
Size Integer - Use to override the device's volume size.
- volume
Type ContainerRecipe Ebs Instance Block Device Specification Volume Type - Use to override the device's volume type.
- delete
On booleanTermination - Use to configure delete on termination of the associated device.
- encrypted boolean
- Use to configure device encryption.
- iops number
- Use to configure device IOPS.
- kms
Key stringId - Use to configure the KMS key to use when encrypting the device.
- snapshot
Id string - The snapshot that defines the device contents.
- throughput number
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volume
Size number - Use to override the device's volume size.
- volume
Type ContainerRecipe Ebs Instance Block Device Specification Volume Type - Use to override the device's volume type.
- delete_
on_ booltermination - Use to configure delete on termination of the associated device.
- encrypted bool
- Use to configure device encryption.
- iops int
- Use to configure device IOPS.
- kms_
key_ strid - Use to configure the KMS key to use when encrypting the device.
- snapshot_
id str - The snapshot that defines the device contents.
- throughput int
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volume_
size int - Use to override the device's volume size.
- volume_
type ContainerRecipe Ebs Instance Block Device Specification Volume Type - Use to override the device's volume type.
- delete
On BooleanTermination - Use to configure delete on termination of the associated device.
- encrypted Boolean
- Use to configure device encryption.
- iops Number
- Use to configure device IOPS.
- kms
Key StringId - Use to configure the KMS key to use when encrypting the device.
- snapshot
Id String - The snapshot that defines the device contents.
- throughput Number
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volume
Size Number - Use to override the device's volume size.
- volume
Type "standard" | "io1" | "io2" | "gp2" | "gp3" | "sc1" | "st1" - Use to override the device's volume type.
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType, ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeArgs
- Standard
- standard
- Io1
- io1
- Io2
- io2
- Gp2
- gp2
- Gp3
- gp3
- Sc1
- sc1
- St1
- st1
- Container
Recipe Ebs Instance Block Device Specification Volume Type Standard - standard
- Container
Recipe Ebs Instance Block Device Specification Volume Type Io1 - io1
- Container
Recipe Ebs Instance Block Device Specification Volume Type Io2 - io2
- Container
Recipe Ebs Instance Block Device Specification Volume Type Gp2 - gp2
- Container
Recipe Ebs Instance Block Device Specification Volume Type Gp3 - gp3
- Container
Recipe Ebs Instance Block Device Specification Volume Type Sc1 - sc1
- Container
Recipe Ebs Instance Block Device Specification Volume Type St1 - st1
- Standard
- standard
- Io1
- io1
- Io2
- io2
- Gp2
- gp2
- Gp3
- gp3
- Sc1
- sc1
- St1
- st1
- Standard
- standard
- Io1
- io1
- Io2
- io2
- Gp2
- gp2
- Gp3
- gp3
- Sc1
- sc1
- St1
- st1
- STANDARD
- standard
- IO1
- io1
- IO2
- io2
- GP2
- gp2
- GP3
- gp3
- SC1
- sc1
- ST1
- st1
- "standard"
- standard
- "io1"
- io1
- "io2"
- io2
- "gp2"
- gp2
- "gp3"
- gp3
- "sc1"
- sc1
- "st1"
- st1
ContainerRecipeInstanceBlockDeviceMapping, ContainerRecipeInstanceBlockDeviceMappingArgs
- Device
Name string - The device to which these mappings apply.
- Ebs
Pulumi.
Aws Native. Image Builder. Inputs. Container Recipe Ebs Instance Block Device Specification - Use to manage Amazon EBS-specific configuration for this mapping.
- No
Device string - Use to remove a mapping from the parent image.
- Virtual
Name string - Use to manage instance ephemeral devices.
- Device
Name string - The device to which these mappings apply.
- Ebs
Container
Recipe Ebs Instance Block Device Specification - Use to manage Amazon EBS-specific configuration for this mapping.
- No
Device string - Use to remove a mapping from the parent image.
- Virtual
Name string - Use to manage instance ephemeral devices.
- device
Name String - The device to which these mappings apply.
- ebs
Container
Recipe Ebs Instance Block Device Specification - Use to manage Amazon EBS-specific configuration for this mapping.
- no
Device String - Use to remove a mapping from the parent image.
- virtual
Name String - Use to manage instance ephemeral devices.
- device
Name string - The device to which these mappings apply.
- ebs
Container
Recipe Ebs Instance Block Device Specification - Use to manage Amazon EBS-specific configuration for this mapping.
- no
Device string - Use to remove a mapping from the parent image.
- virtual
Name string - Use to manage instance ephemeral devices.
- device_
name str - The device to which these mappings apply.
- ebs
Container
Recipe Ebs Instance Block Device Specification - Use to manage Amazon EBS-specific configuration for this mapping.
- no_
device str - Use to remove a mapping from the parent image.
- virtual_
name str - Use to manage instance ephemeral devices.
- device
Name String - The device to which these mappings apply.
- ebs Property Map
- Use to manage Amazon EBS-specific configuration for this mapping.
- no
Device String - Use to remove a mapping from the parent image.
- virtual
Name String - Use to manage instance ephemeral devices.
ContainerRecipeInstanceConfiguration, ContainerRecipeInstanceConfigurationArgs
- Block
Device List<Pulumi.Mappings Aws Native. Image Builder. Inputs. Container Recipe Instance Block Device Mapping> - Defines the block devices to attach for building an instance from this Image Builder AMI.
- Image string
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
- Block
Device []ContainerMappings Recipe Instance Block Device Mapping - Defines the block devices to attach for building an instance from this Image Builder AMI.
- Image string
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
- block
Device List<ContainerMappings Recipe Instance Block Device Mapping> - Defines the block devices to attach for building an instance from this Image Builder AMI.
- image String
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
- block
Device ContainerMappings Recipe Instance Block Device Mapping[] - Defines the block devices to attach for building an instance from this Image Builder AMI.
- image string
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
- block_
device_ Sequence[Containermappings Recipe Instance Block Device Mapping] - Defines the block devices to attach for building an instance from this Image Builder AMI.
- image str
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
- block
Device List<Property Map>Mappings - Defines the block devices to attach for building an instance from this Image Builder AMI.
- image String
- The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
ContainerRecipePlatformOverride, ContainerRecipePlatformOverrideArgs
- Windows
- Windows
- Linux
- Linux
- Container
Recipe Platform Override Windows - Windows
- Container
Recipe Platform Override Linux - Linux
- Windows
- Windows
- Linux
- Linux
- Windows
- Windows
- Linux
- Linux
- WINDOWS
- Windows
- LINUX
- Linux
- "Windows"
- Windows
- "Linux"
- Linux
ContainerRecipeTargetContainerRepository, ContainerRecipeTargetContainerRepositoryArgs
- Repository
Name string - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- Service
Pulumi.
Aws Native. Image Builder. Container Recipe Target Container Repository Service - Specifies the service in which this image was registered.
- Repository
Name string - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- Service
Container
Recipe Target Container Repository Service - Specifies the service in which this image was registered.
- repository
Name String - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- service
Container
Recipe Target Container Repository Service - Specifies the service in which this image was registered.
- repository
Name string - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- service
Container
Recipe Target Container Repository Service - Specifies the service in which this image was registered.
- repository_
name str - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- service
Container
Recipe Target Container Repository Service - Specifies the service in which this image was registered.
- repository
Name String - The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- service "ECR"
- Specifies the service in which this image was registered.
ContainerRecipeTargetContainerRepositoryService, ContainerRecipeTargetContainerRepositoryServiceArgs
- Ecr
- ECR
- Container
Recipe Target Container Repository Service Ecr - ECR
- Ecr
- ECR
- Ecr
- ECR
- ECR
- ECR
- "ECR"
- ECR
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.