AWS Native v0.64.0, Jun 2 23

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.64.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.imagebuilder.ContainerRecipe

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.64.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-aws-native

Create ContainerRecipe Resource

new ContainerRecipe(name: string, args?: ContainerRecipeArgs, opts?: CustomResourceOptions);

@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[Any] = None,
                    target_repository: Optional[ContainerRecipeTargetContainerRepositoryArgs] = None,
                    version: Optional[str] = None,
                    working_directory: Optional[str] = None)
@overload
def ContainerRecipe(resource_name: str,
                    args: Optional[ContainerRecipeArgs] = None,
                    opts: Optional[ResourceOptions] = 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.

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

The ContainerRecipe resource accepts the following input properties:

Components List<Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeComponentConfigurationArgs>: Components for build and test that are included in the container recipe.
ContainerType Pulumi.AwsNative.ImageBuilder.ContainerRecipeContainerType: Specifies the type of container, such as Docker.
Description string: The description of the container recipe.
DockerfileTemplateData string: 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.
DockerfileTemplateUri string: The S3 URI for the Dockerfile that will be used to build your container image.
ImageOsVersionOverride string: Specifies the operating system version for the source image.
InstanceConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeInstanceConfigurationArgs: A group of options that can be used to configure an instance for building and testing container images.
KmsKeyId string: 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.AwsNative.ImageBuilder.ContainerRecipePlatformOverride: Specifies the operating system platform when you use a custom source image.
Tags object: Tags that are attached to the container recipe.
TargetRepository Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeTargetContainerRepositoryArgs: 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 []ContainerRecipeComponentConfigurationArgs: Components for build and test that are included in the container recipe.
ContainerType ContainerRecipeContainerType: Specifies the type of container, such as Docker.
Description string: The description of the container recipe.
DockerfileTemplateData string: 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.
DockerfileTemplateUri string: The S3 URI for the Dockerfile that will be used to build your container image.
ImageOsVersionOverride string: Specifies the operating system version for the source image.
InstanceConfiguration ContainerRecipeInstanceConfigurationArgs: A group of options that can be used to configure an instance for building and testing container images.
KmsKeyId string: 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 ContainerRecipePlatformOverride: Specifies the operating system platform when you use a custom source image.
Tags interface{}: Tags that are attached to the container recipe.
TargetRepository ContainerRecipeTargetContainerRepositoryArgs: 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<ContainerRecipeComponentConfigurationArgs>: Components for build and test that are included in the container recipe.
containerType ContainerRecipeContainerType: Specifies the type of container, such as Docker.
description String: The description of the container recipe.
dockerfileTemplateData String: 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.
dockerfileTemplateUri String: The S3 URI for the Dockerfile that will be used to build your container image.
imageOsVersionOverride String: Specifies the operating system version for the source image.
instanceConfiguration ContainerRecipeInstanceConfigurationArgs: A group of options that can be used to configure an instance for building and testing container images.
kmsKeyId String: 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 ContainerRecipePlatformOverride: Specifies the operating system platform when you use a custom source image.
tags Object: Tags that are attached to the container recipe.
targetRepository ContainerRecipeTargetContainerRepositoryArgs: 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 ContainerRecipeComponentConfigurationArgs[]: Components for build and test that are included in the container recipe.
containerType ContainerRecipeContainerType: Specifies the type of container, such as Docker.
description string: The description of the container recipe.
dockerfileTemplateData string: 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.
dockerfileTemplateUri string: The S3 URI for the Dockerfile that will be used to build your container image.
imageOsVersionOverride string: Specifies the operating system version for the source image.
instanceConfiguration ContainerRecipeInstanceConfigurationArgs: A group of options that can be used to configure an instance for building and testing container images.
kmsKeyId string: 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 ContainerRecipePlatformOverride: Specifies the operating system platform when you use a custom source image.
tags any: Tags that are attached to the container recipe.
targetRepository ContainerRecipeTargetContainerRepositoryArgs: 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[ContainerRecipeComponentConfigurationArgs]: Components for build and test that are included in the container recipe.
container_type ContainerRecipeContainerType: Specifies the type of container, such as Docker.
description str: The description of the container recipe.
dockerfile_template_data str: 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_uri str: The S3 URI for the Dockerfile that will be used to build your container image.
image_os_version_override str: Specifies the operating system version for the source image.
instance_configuration ContainerRecipeInstanceConfigurationArgs: A group of options that can be used to configure an instance for building and testing container images.
kms_key_id str: 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 ContainerRecipePlatformOverride: Specifies the operating system platform when you use a custom source image.
tags Any: Tags that are attached to the container recipe.
target_repository ContainerRecipeTargetContainerRepositoryArgs: 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.
dockerfileTemplateData String: 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.
dockerfileTemplateUri String: The S3 URI for the Dockerfile that will be used to build your container image.
imageOsVersionOverride String: 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.
kmsKeyId String: 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.
tags Any: 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:

Arn string: The Amazon Resource Name (ARN) of the container recipe.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The Amazon Resource Name (ARN) of the container recipe.
Id string: The provider-assigned unique ID for this managed resource.

arn String: The Amazon Resource Name (ARN) of the container recipe.
id String: The provider-assigned unique ID for this managed resource.

arn string: The Amazon Resource Name (ARN) of the container recipe.
id string: The provider-assigned unique ID for this managed resource.

arn str: The Amazon Resource Name (ARN) of the container recipe.
id str: The provider-assigned unique ID for this managed resource.

arn String: The Amazon Resource Name (ARN) of the container recipe.
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

ContainerRecipeComponentConfiguration

ComponentArn string: The Amazon Resource Name (ARN) of the component.
Parameters List<Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeComponentParameter>: 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 []ContainerRecipeComponentParameter: 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<ContainerRecipeComponentParameter>: 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 ContainerRecipeComponentParameter[]: 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[ContainerRecipeComponentParameter]: 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

Name string: The name of the component parameter to set.
Value List<string>: Sets the value for the named component parameter.

Name string: The name of the component parameter to set.
Value []string: Sets the value for the named component parameter.

name String: The name of the component parameter to set.
value List<String>: Sets the value for the named component parameter.

name string: The name of the component parameter to set.
value string[]: Sets the value for the named component parameter.

name str: The name of the component parameter to set.
value Sequence[str]: Sets the value for the named component parameter.

name String: The name of the component parameter to set.
value List<String>: Sets the value for the named component parameter.

ContainerRecipeContainerType

Docker: DOCKER

ContainerRecipeContainerTypeDocker: DOCKER

Docker: DOCKER

Docker: DOCKER

DOCKER: DOCKER

"DOCKER": DOCKER

ContainerRecipeEbsInstanceBlockDeviceSpecification

DeleteOnTermination bool: Use to configure delete on termination of the associated device.
Encrypted bool: Use to configure device encryption.
Iops int: Use to configure device IOPS.
KmsKeyId string: 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.AwsNative.ImageBuilder.ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType: Use to override the device's volume type.

DeleteOnTermination bool: Use to configure delete on termination of the associated device.
Encrypted bool: Use to configure device encryption.
Iops int: Use to configure device IOPS.
KmsKeyId string: 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 ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType: Use to override the device's volume type.

deleteOnTermination Boolean: Use to configure delete on termination of the associated device.
encrypted Boolean: Use to configure device encryption.
iops Integer: Use to configure device IOPS.
kmsKeyId String: 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 ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType: Use to override the device's volume type.

deleteOnTermination boolean: Use to configure delete on termination of the associated device.
encrypted boolean: Use to configure device encryption.
iops number: Use to configure device IOPS.
kmsKeyId string: 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 ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType: Use to override the device's volume type.

delete_on_termination bool: 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_id str: 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 ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType: Use to override the device's volume type.

deleteOnTermination Boolean: Use to configure delete on termination of the associated device.
encrypted Boolean: Use to configure device encryption.
iops Number: Use to configure device IOPS.
kmsKeyId String: 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

Standard: standard
Io1: io1
Io2: io2
Gp2: gp2
Gp3: gp3
Sc1: sc1
St1: st1

ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeStandard: standard
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeIo1: io1
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeIo2: io2
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeGp2: gp2
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeGp3: gp3
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeSc1: sc1
ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeSt1: 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

DeviceName string: The device to which these mappings apply.
Ebs Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeEbsInstanceBlockDeviceSpecification: 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 ContainerRecipeEbsInstanceBlockDeviceSpecification: 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 ContainerRecipeEbsInstanceBlockDeviceSpecification: 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 ContainerRecipeEbsInstanceBlockDeviceSpecification: 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 ContainerRecipeEbsInstanceBlockDeviceSpecification: 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

BlockDeviceMappings List<Pulumi.AwsNative.ImageBuilder.Inputs.ContainerRecipeInstanceBlockDeviceMapping>: 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.

BlockDeviceMappings []ContainerRecipeInstanceBlockDeviceMapping: 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.

blockDeviceMappings List<ContainerRecipeInstanceBlockDeviceMapping>: 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.

blockDeviceMappings ContainerRecipeInstanceBlockDeviceMapping[]: 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_mappings Sequence[ContainerRecipeInstanceBlockDeviceMapping]: 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.

blockDeviceMappings List<Property Map>: 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

Windows: Windows
Linux: Linux

ContainerRecipePlatformOverrideWindows: Windows
ContainerRecipePlatformOverrideLinux: Linux

Windows: Windows
Linux: Linux

Windows: Windows
Linux: Linux

WINDOWS: Windows
LINUX: Linux

"Windows": Windows
"Linux": Linux

ContainerRecipeTargetContainerRepository

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.AwsNative.ImageBuilder.ContainerRecipeTargetContainerRepositoryService: 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 ContainerRecipeTargetContainerRepositoryService: 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 ContainerRecipeTargetContainerRepositoryService: 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 ContainerRecipeTargetContainerRepositoryService: 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 ContainerRecipeTargetContainerRepositoryService: 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

Ecr: ECR

ContainerRecipeTargetContainerRepositoryServiceEcr: ECR

Ecr: ECR

Ecr: ECR

ECR: ECR

"ECR": ECR

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.64.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.imagebuilder.ContainerRecipe

On this page

On this page

Create ContainerRecipe Resource

ContainerRecipe Resource Properties

Inputs

Outputs

Supporting Types

ContainerRecipeComponentConfiguration

ContainerRecipeComponentParameter

ContainerRecipeContainerType

ContainerRecipeEbsInstanceBlockDeviceSpecification

ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType

ContainerRecipeInstanceBlockDeviceMapping

ContainerRecipeInstanceConfiguration

ContainerRecipePlatformOverride

ContainerRecipeTargetContainerRepository

ContainerRecipeTargetContainerRepositoryService

Package Details

On this page

On this page