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.
- ContainerType 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.
- DockerfileTemplate 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.
- DockerfileTemplate stringUri 
- The S3 URI for the Dockerfile that will be used to build your container image.
- ImageOs stringVersion Override 
- Specifies the operating system version for the source image.
- InstanceConfiguration 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.
- KmsKey stringId 
- Identifies which KMS key is used to encrypt the container image.
- Name string
- The name of the container recipe.
- ParentImage string
- The source image for the container recipe.
- PlatformOverride 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.
- TargetRepository 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 (..).
- WorkingDirectory string
- The working directory to be used during build and test workflows.
- Components
[]ContainerRecipe Component Configuration Args 
- Components for build and test that are included in the container recipe.
- ContainerType ContainerRecipe Container Type 
- Specifies the type of container, such as Docker.
- Description string
- The description of the container recipe.
- DockerfileTemplate 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.
- DockerfileTemplate stringUri 
- The S3 URI for the Dockerfile that will be used to build your container image.
- ImageOs stringVersion Override 
- Specifies the operating system version for the source image.
- InstanceConfiguration ContainerRecipe Instance Configuration Args 
- A group of options that can be used to configure an instance for building and testing container images.
- KmsKey stringId 
- Identifies which KMS key is used to encrypt the container image.
- Name string
- The name of the container recipe.
- ParentImage string
- The source image for the container recipe.
- PlatformOverride 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.
- TargetRepository ContainerRecipe Target Container Repository Args 
- The destination repository for the container image.
- Version string
- The semantic version of the container recipe (..).
- WorkingDirectory string
- The working directory to be used during build and test workflows.
- components
List<ContainerRecipe Component Configuration> 
- Components for build and test that are included in the container recipe.
- containerType ContainerRecipe Container Type 
- Specifies the type of container, such as Docker.
- description String
- The description of the container recipe.
- dockerfileTemplate 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.
- dockerfileTemplate StringUri 
- The S3 URI for the Dockerfile that will be used to build your container image.
- imageOs StringVersion Override 
- Specifies the operating system version for the source image.
- instanceConfiguration ContainerRecipe Instance Configuration 
- A group of options that can be used to configure an instance for building and testing container images.
- kmsKey StringId 
- Identifies which KMS key is used to encrypt the container image.
- name String
- The name of the container recipe.
- parentImage String
- The source image for the container recipe.
- platformOverride 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.
- targetRepository ContainerRecipe Target Container Repository 
- The destination repository for the container image.
- version String
- The semantic version of the container recipe (..).
- workingDirectory String
- The working directory to be used during build and test workflows.
- components
ContainerRecipe Component Configuration[] 
- Components for build and test that are included in the container recipe.
- containerType ContainerRecipe Container Type 
- Specifies the type of container, such as Docker.
- description string
- The description of the container recipe.
- dockerfileTemplate 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.
- dockerfileTemplate stringUri 
- The S3 URI for the Dockerfile that will be used to build your container image.
- imageOs stringVersion Override 
- Specifies the operating system version for the source image.
- instanceConfiguration ContainerRecipe Instance Configuration 
- A group of options that can be used to configure an instance for building and testing container images.
- kmsKey stringId 
- Identifies which KMS key is used to encrypt the container image.
- name string
- The name of the container recipe.
- parentImage string
- The source image for the container recipe.
- platformOverride 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.
- targetRepository ContainerRecipe Target Container Repository 
- The destination repository for the container image.
- version string
- The semantic version of the container recipe (..).
- workingDirectory string
- The working directory to be used during build and test workflows.
- components
Sequence[ContainerRecipe 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.
- containerType "DOCKER"
- Specifies the type of container, such as Docker.
- description String
- The description of the container recipe.
- dockerfileTemplate 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.
- dockerfileTemplate StringUri 
- The S3 URI for the Dockerfile that will be used to build your container image.
- imageOs StringVersion Override 
- Specifies the operating system version for the source image.
- instanceConfiguration Property Map
- A group of options that can be used to configure an instance for building and testing container images.
- kmsKey StringId 
- Identifies which KMS key is used to encrypt the container image.
- name String
- The name of the container recipe.
- parentImage String
- The source image for the container recipe.
- platformOverride "Windows" | "Linux"
- Specifies the operating system platform when you use a custom source image.
- Map<String>
- Tags that are attached to the container recipe.
- targetRepository Property Map
- The destination repository for the container image.
- version String
- The semantic version of the container recipe (..).
- workingDirectory 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        
- ComponentArn 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.
- ComponentArn string
- The Amazon Resource Name (ARN) of the component.
- Parameters
[]ContainerRecipe Component Parameter 
- A group of parameter settings that are used to configure the component for a specific recipe.
- componentArn String
- The Amazon Resource Name (ARN) of the component.
- parameters
List<ContainerRecipe Component Parameter> 
- A group of parameter settings that are used to configure the component for a specific recipe.
- componentArn string
- The Amazon Resource Name (ARN) of the component.
- parameters
ContainerRecipe 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[ContainerRecipe Component Parameter] 
- A group of parameter settings that are used to configure the component for a specific recipe.
- componentArn 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
- ContainerRecipe Container Type Docker 
- DOCKER
- Docker
- DOCKER
- Docker
- DOCKER
- DOCKER
- DOCKER
- "DOCKER"
- DOCKER
ContainerRecipeEbsInstanceBlockDeviceSpecification, ContainerRecipeEbsInstanceBlockDeviceSpecificationArgs              
- DeleteOn 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.
- KmsKey stringId 
- Use to configure the KMS key to use when encrypting the device.
- SnapshotId string
- The snapshot that defines the device contents.
- Throughput int
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- VolumeSize int
- Use to override the device's volume size.
- VolumeType Pulumi.Aws Native. Image Builder. Container Recipe Ebs Instance Block Device Specification Volume Type 
- Use to override the device's volume type.
- DeleteOn 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.
- KmsKey stringId 
- Use to configure the KMS key to use when encrypting the device.
- SnapshotId string
- The snapshot that defines the device contents.
- Throughput int
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- VolumeSize int
- Use to override the device's volume size.
- VolumeType ContainerRecipe Ebs Instance Block Device Specification Volume Type 
- Use to override the device's volume type.
- deleteOn 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.
- kmsKey StringId 
- Use to configure the KMS key to use when encrypting the device.
- snapshotId String
- The snapshot that defines the device contents.
- throughput Integer
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volumeSize Integer
- Use to override the device's volume size.
- volumeType ContainerRecipe Ebs Instance Block Device Specification Volume Type 
- Use to override the device's volume type.
- deleteOn 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.
- kmsKey stringId 
- Use to configure the KMS key to use when encrypting the device.
- snapshotId string
- The snapshot that defines the device contents.
- throughput number
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volumeSize number
- Use to override the device's volume size.
- volumeType 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.
- deleteOn 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.
- kmsKey StringId 
- Use to configure the KMS key to use when encrypting the device.
- snapshotId String
- The snapshot that defines the device contents.
- throughput Number
- For GP3 volumes only - The throughput in MiB/s that the volume supports.
- volumeSize Number
- Use to override the device's volume size.
- volumeType "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
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Standard 
- standard
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Io1 
- io1
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Io2 
- io2
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Gp2 
- gp2
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Gp3 
- gp3
- ContainerRecipe Ebs Instance Block Device Specification Volume Type Sc1 
- sc1
- ContainerRecipe 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            
- DeviceName 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.
- NoDevice string
- Use to remove a mapping from the parent image.
- VirtualName string
- Use to manage instance ephemeral devices.
- DeviceName string
- The device to which these mappings apply.
- Ebs
ContainerRecipe Ebs Instance Block Device Specification 
- Use to manage Amazon EBS-specific configuration for this mapping.
- NoDevice string
- Use to remove a mapping from the parent image.
- VirtualName string
- Use to manage instance ephemeral devices.
- deviceName String
- The device to which these mappings apply.
- ebs
ContainerRecipe Ebs Instance Block Device Specification 
- Use to manage Amazon EBS-specific configuration for this mapping.
- noDevice String
- Use to remove a mapping from the parent image.
- virtualName String
- Use to manage instance ephemeral devices.
- deviceName string
- The device to which these mappings apply.
- ebs
ContainerRecipe Ebs Instance Block Device Specification 
- Use to manage Amazon EBS-specific configuration for this mapping.
- noDevice string
- Use to remove a mapping from the parent image.
- virtualName string
- Use to manage instance ephemeral devices.
- device_name str
- The device to which these mappings apply.
- ebs
ContainerRecipe 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.
- deviceName String
- The device to which these mappings apply.
- ebs Property Map
- Use to manage Amazon EBS-specific configuration for this mapping.
- noDevice String
- Use to remove a mapping from the parent image.
- virtualName String
- Use to manage instance ephemeral devices.
ContainerRecipeInstanceConfiguration, ContainerRecipeInstanceConfigurationArgs        
- BlockDevice 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.
- BlockDevice []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.
- blockDevice 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.
- blockDevice 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.
- blockDevice 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
- ContainerRecipe Platform Override Windows 
- Windows
- ContainerRecipe Platform Override Linux 
- Linux
- Windows
- Windows
- Linux
- Linux
- Windows
- Windows
- Linux
- Linux
- WINDOWS
- Windows
- LINUX
- Linux
- "Windows"
- Windows
- "Linux"
- Linux
ContainerRecipeTargetContainerRepository, ContainerRecipeTargetContainerRepositoryArgs          
- RepositoryName 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.
- RepositoryName string
- The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
- Service
ContainerRecipe Target Container Repository Service 
- 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.
- service
ContainerRecipe Target Container Repository Service 
- 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.
- service
ContainerRecipe 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
ContainerRecipe Target Container Repository Service 
- 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.
- service "ECR"
- Specifies the service in which this image was registered.
ContainerRecipeTargetContainerRepositoryService, ContainerRecipeTargetContainerRepositoryServiceArgs            
- Ecr
- ECR
- ContainerRecipe 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.