Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. imagebuilder
  5. ImagePipeline

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.imagebuilder.ImagePipeline

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

    Manages an Image Builder Image Pipeline.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.imagebuilder.ImagePipeline("example", {
    imageRecipeArn: exampleAwsImagebuilderImageRecipe.arn,
    infrastructureConfigurationArn: exampleAwsImagebuilderInfrastructureConfiguration.arn,
    name: "example",
    schedule: {
        scheduleExpression: "cron(0 0 * * ? *)",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.ImagePipeline("example",
    image_recipe_arn=example_aws_imagebuilder_image_recipe["arn"],
    infrastructure_configuration_arn=example_aws_imagebuilder_infrastructure_configuration["arn"],
    name="example",
    schedule=aws.imagebuilder.ImagePipelineScheduleArgs(
        schedule_expression="cron(0 0 * * ? *)",
    ))

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/imagebuilder"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := imagebuilder.NewImagePipeline(ctx, "example", &imagebuilder.ImagePipelineArgs{
			ImageRecipeArn:                 pulumi.Any(exampleAwsImagebuilderImageRecipe.Arn),
			InfrastructureConfigurationArn: pulumi.Any(exampleAwsImagebuilderInfrastructureConfiguration.Arn),
			Name:                           pulumi.String("example"),
			Schedule: &imagebuilder.ImagePipelineScheduleArgs{
				ScheduleExpression: pulumi.String("cron(0 0 * * ? *)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ImageBuilder.ImagePipeline("example", new()
    {
        ImageRecipeArn = exampleAwsImagebuilderImageRecipe.Arn,
        InfrastructureConfigurationArn = exampleAwsImagebuilderInfrastructureConfiguration.Arn,
        Name = "example",
        Schedule = new Aws.ImageBuilder.Inputs.ImagePipelineScheduleArgs
        {
            ScheduleExpression = "cron(0 0 * * ? *)",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.ImagePipeline;
import com.pulumi.aws.imagebuilder.ImagePipelineArgs;
import com.pulumi.aws.imagebuilder.inputs.ImagePipelineScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ImagePipeline("example", ImagePipelineArgs.builder()        
            .imageRecipeArn(exampleAwsImagebuilderImageRecipe.arn())
            .infrastructureConfigurationArn(exampleAwsImagebuilderInfrastructureConfiguration.arn())
            .name("example")
            .schedule(ImagePipelineScheduleArgs.builder()
                .scheduleExpression("cron(0 0 * * ? *)")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:imagebuilder:ImagePipeline
    properties:
      imageRecipeArn: ${exampleAwsImagebuilderImageRecipe.arn}
      infrastructureConfigurationArn: ${exampleAwsImagebuilderInfrastructureConfiguration.arn}
      name: example
      schedule:
        scheduleExpression: cron(0 0 * * ? *)

    Create ImagePipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ImagePipeline(name: string, args: ImagePipelineArgs, opts?: CustomResourceOptions);
    @overload
def ImagePipeline(resource_name: str,
                  args: ImagePipelineArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ImagePipeline(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  infrastructure_configuration_arn: Optional[str] = None,
                  container_recipe_arn: Optional[str] = None,
                  description: Optional[str] = None,
                  distribution_configuration_arn: Optional[str] = None,
                  enhanced_image_metadata_enabled: Optional[bool] = None,
                  image_recipe_arn: Optional[str] = None,
                  image_scanning_configuration: Optional[ImagePipelineImageScanningConfigurationArgs] = None,
                  image_tests_configuration: Optional[ImagePipelineImageTestsConfigurationArgs] = None,
                  name: Optional[str] = None,
                  schedule: Optional[ImagePipelineScheduleArgs] = None,
                  status: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewImagePipeline(ctx *Context, name string, args ImagePipelineArgs, opts ...ResourceOption) (*ImagePipeline, error)
    public ImagePipeline(string name, ImagePipelineArgs args, CustomResourceOptions? opts = null)
    public ImagePipeline(String name, ImagePipelineArgs args)
public ImagePipeline(String name, ImagePipelineArgs args, CustomResourceOptions options)

    type: aws:imagebuilder:ImagePipeline
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 ImagePipelineArgs
    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 ImagePipelineArgs
    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 ImagePipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImagePipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImagePipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var imagePipelineResource = new Aws.ImageBuilder.ImagePipeline("imagePipelineResource", new()
{
    InfrastructureConfigurationArn = "string",
    ContainerRecipeArn = "string",
    Description = "string",
    DistributionConfigurationArn = "string",
    EnhancedImageMetadataEnabled = false,
    ImageRecipeArn = "string",
    ImageScanningConfiguration = new Aws.ImageBuilder.Inputs.ImagePipelineImageScanningConfigurationArgs
    {
        EcrConfiguration = new Aws.ImageBuilder.Inputs.ImagePipelineImageScanningConfigurationEcrConfigurationArgs
        {
            ContainerTags = new[]
            {
                "string",
            },
            RepositoryName = "string",
        },
        ImageScanningEnabled = false,
    },
    ImageTestsConfiguration = new Aws.ImageBuilder.Inputs.ImagePipelineImageTestsConfigurationArgs
    {
        ImageTestsEnabled = false,
        TimeoutMinutes = 0,
    },
    Name = "string",
    Schedule = new Aws.ImageBuilder.Inputs.ImagePipelineScheduleArgs
    {
        ScheduleExpression = "string",
        PipelineExecutionStartCondition = "string",
        Timezone = "string",
    },
    Status = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := imagebuilder.NewImagePipeline(ctx, "imagePipelineResource", &imagebuilder.ImagePipelineArgs{
	InfrastructureConfigurationArn: pulumi.String("string"),
	ContainerRecipeArn:             pulumi.String("string"),
	Description:                    pulumi.String("string"),
	DistributionConfigurationArn:   pulumi.String("string"),
	EnhancedImageMetadataEnabled:   pulumi.Bool(false),
	ImageRecipeArn:                 pulumi.String("string"),
	ImageScanningConfiguration: &imagebuilder.ImagePipelineImageScanningConfigurationArgs{
		EcrConfiguration: &imagebuilder.ImagePipelineImageScanningConfigurationEcrConfigurationArgs{
			ContainerTags: pulumi.StringArray{
				pulumi.String("string"),
			},
			RepositoryName: pulumi.String("string"),
		},
		ImageScanningEnabled: pulumi.Bool(false),
	},
	ImageTestsConfiguration: &imagebuilder.ImagePipelineImageTestsConfigurationArgs{
		ImageTestsEnabled: pulumi.Bool(false),
		TimeoutMinutes:    pulumi.Int(0),
	},
	Name: pulumi.String("string"),
	Schedule: &imagebuilder.ImagePipelineScheduleArgs{
		ScheduleExpression:              pulumi.String("string"),
		PipelineExecutionStartCondition: pulumi.String("string"),
		Timezone:                        pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var imagePipelineResource = new ImagePipeline("imagePipelineResource", ImagePipelineArgs.builder()        
    .infrastructureConfigurationArn("string")
    .containerRecipeArn("string")
    .description("string")
    .distributionConfigurationArn("string")
    .enhancedImageMetadataEnabled(false)
    .imageRecipeArn("string")
    .imageScanningConfiguration(ImagePipelineImageScanningConfigurationArgs.builder()
        .ecrConfiguration(ImagePipelineImageScanningConfigurationEcrConfigurationArgs.builder()
            .containerTags("string")
            .repositoryName("string")
            .build())
        .imageScanningEnabled(false)
        .build())
    .imageTestsConfiguration(ImagePipelineImageTestsConfigurationArgs.builder()
        .imageTestsEnabled(false)
        .timeoutMinutes(0)
        .build())
    .name("string")
    .schedule(ImagePipelineScheduleArgs.builder()
        .scheduleExpression("string")
        .pipelineExecutionStartCondition("string")
        .timezone("string")
        .build())
    .status("string")
    .tags(Map.of("string", "string"))
    .build());

    image_pipeline_resource = aws.imagebuilder.ImagePipeline("imagePipelineResource",
    infrastructure_configuration_arn="string",
    container_recipe_arn="string",
    description="string",
    distribution_configuration_arn="string",
    enhanced_image_metadata_enabled=False,
    image_recipe_arn="string",
    image_scanning_configuration=aws.imagebuilder.ImagePipelineImageScanningConfigurationArgs(
        ecr_configuration=aws.imagebuilder.ImagePipelineImageScanningConfigurationEcrConfigurationArgs(
            container_tags=["string"],
            repository_name="string",
        ),
        image_scanning_enabled=False,
    ),
    image_tests_configuration=aws.imagebuilder.ImagePipelineImageTestsConfigurationArgs(
        image_tests_enabled=False,
        timeout_minutes=0,
    ),
    name="string",
    schedule=aws.imagebuilder.ImagePipelineScheduleArgs(
        schedule_expression="string",
        pipeline_execution_start_condition="string",
        timezone="string",
    ),
    status="string",
    tags={
        "string": "string",
    })

    const imagePipelineResource = new aws.imagebuilder.ImagePipeline("imagePipelineResource", {
    infrastructureConfigurationArn: "string",
    containerRecipeArn: "string",
    description: "string",
    distributionConfigurationArn: "string",
    enhancedImageMetadataEnabled: false,
    imageRecipeArn: "string",
    imageScanningConfiguration: {
        ecrConfiguration: {
            containerTags: ["string"],
            repositoryName: "string",
        },
        imageScanningEnabled: false,
    },
    imageTestsConfiguration: {
        imageTestsEnabled: false,
        timeoutMinutes: 0,
    },
    name: "string",
    schedule: {
        scheduleExpression: "string",
        pipelineExecutionStartCondition: "string",
        timezone: "string",
    },
    status: "string",
    tags: {
        string: "string",
    },
});

    type: aws:imagebuilder:ImagePipeline
properties:
    containerRecipeArn: string
    description: string
    distributionConfigurationArn: string
    enhancedImageMetadataEnabled: false
    imageRecipeArn: string
    imageScanningConfiguration:
        ecrConfiguration:
            containerTags:
                - string
            repositoryName: string
        imageScanningEnabled: false
    imageTestsConfiguration:
        imageTestsEnabled: false
        timeoutMinutes: 0
    infrastructureConfigurationArn: string
    name: string
    schedule:
        pipelineExecutionStartCondition: string
        scheduleExpression: string
        timezone: string
    status: string
    tags:
        string: string

    ImagePipeline 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 ImagePipeline resource accepts the following input properties:

    InfrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    Description string
    Description of the image pipeline.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    Name string

    Name of the image pipeline.

    The following arguments are optional:

    Schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    Status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    InfrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    Description string
    Description of the image pipeline.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImagePipelineImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImagePipelineImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    Name string

    Name of the image pipeline.

    The following arguments are optional:

    Schedule ImagePipelineScheduleArgs
    Configuration block with schedule settings. Detailed below.
    Status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    Tags map[string]string
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    infrastructureConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    description String
    Description of the image pipeline.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    name String

    Name of the image pipeline.

    The following arguments are optional:

    schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    status String
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Map<String,String>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    infrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    containerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    description string
    Description of the image pipeline.
    distributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    name string

    Name of the image pipeline.

    The following arguments are optional:

    schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags {[key: string]: string}
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    infrastructure_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    container_recipe_arn str
    Amazon Resource Name (ARN) of the container recipe.
    description str
    Description of the image pipeline.
    distribution_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhanced_image_metadata_enabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    image_recipe_arn str
    Amazon Resource Name (ARN) of the image recipe.
    image_scanning_configuration ImagePipelineImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    image_tests_configuration ImagePipelineImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    name str

    Name of the image pipeline.

    The following arguments are optional:

    schedule ImagePipelineScheduleArgs
    Configuration block with schedule settings. Detailed below.
    status str
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Mapping[str, str]
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    infrastructureConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    description String
    Description of the image pipeline.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration Property Map
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration Property Map
    Configuration block with image tests configuration. Detailed below.
    name String

    Name of the image pipeline.

    The following arguments are optional:

    schedule Property Map
    Configuration block with schedule settings. Detailed below.
    status String
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Map<String>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ImagePipeline resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the image pipeline.
    DateCreated string
    Date the image pipeline was created.
    DateLastRun string
    Date the image pipeline was last run.
    DateNextRun string
    Date the image pipeline will run next.
    DateUpdated string
    Date the image pipeline was updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Platform string
    Platform of the image pipeline.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the image pipeline.
    DateCreated string
    Date the image pipeline was created.
    DateLastRun string
    Date the image pipeline was last run.
    DateNextRun string
    Date the image pipeline will run next.
    DateUpdated string
    Date the image pipeline was updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Platform string
    Platform of the image pipeline.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the image pipeline.
    dateCreated String
    Date the image pipeline was created.
    dateLastRun String
    Date the image pipeline was last run.
    dateNextRun String
    Date the image pipeline will run next.
    dateUpdated String
    Date the image pipeline was updated.
    id String
    The provider-assigned unique ID for this managed resource.
    platform String
    Platform of the image pipeline.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the image pipeline.
    dateCreated string
    Date the image pipeline was created.
    dateLastRun string
    Date the image pipeline was last run.
    dateNextRun string
    Date the image pipeline will run next.
    dateUpdated string
    Date the image pipeline was updated.
    id string
    The provider-assigned unique ID for this managed resource.
    platform string
    Platform of the image pipeline.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the image pipeline.
    date_created str
    Date the image pipeline was created.
    date_last_run str
    Date the image pipeline was last run.
    date_next_run str
    Date the image pipeline will run next.
    date_updated str
    Date the image pipeline was updated.
    id str
    The provider-assigned unique ID for this managed resource.
    platform str
    Platform of the image pipeline.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the image pipeline.
    dateCreated String
    Date the image pipeline was created.
    dateLastRun String
    Date the image pipeline was last run.
    dateNextRun String
    Date the image pipeline will run next.
    dateUpdated String
    Date the image pipeline was updated.
    id String
    The provider-assigned unique ID for this managed resource.
    platform String
    Platform of the image pipeline.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ImagePipeline Resource

    Get an existing ImagePipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ImagePipelineState, opts?: CustomResourceOptions): ImagePipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        container_recipe_arn: Optional[str] = None,
        date_created: Optional[str] = None,
        date_last_run: Optional[str] = None,
        date_next_run: Optional[str] = None,
        date_updated: Optional[str] = None,
        description: Optional[str] = None,
        distribution_configuration_arn: Optional[str] = None,
        enhanced_image_metadata_enabled: Optional[bool] = None,
        image_recipe_arn: Optional[str] = None,
        image_scanning_configuration: Optional[ImagePipelineImageScanningConfigurationArgs] = None,
        image_tests_configuration: Optional[ImagePipelineImageTestsConfigurationArgs] = None,
        infrastructure_configuration_arn: Optional[str] = None,
        name: Optional[str] = None,
        platform: Optional[str] = None,
        schedule: Optional[ImagePipelineScheduleArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ImagePipeline
    func GetImagePipeline(ctx *Context, name string, id IDInput, state *ImagePipelineState, opts ...ResourceOption) (*ImagePipeline, error)
    public static ImagePipeline Get(string name, Input<string> id, ImagePipelineState? state, CustomResourceOptions? opts = null)
    public static ImagePipeline get(String name, Output<String> id, ImagePipelineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the image pipeline.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DateCreated string
    Date the image pipeline was created.
    DateLastRun string
    Date the image pipeline was last run.
    DateNextRun string
    Date the image pipeline will run next.
    DateUpdated string
    Date the image pipeline was updated.
    Description string
    Description of the image pipeline.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    InfrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    Name string

    Name of the image pipeline.

    The following arguments are optional:

    Platform string
    Platform of the image pipeline.
    Schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    Status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the image pipeline.
    ContainerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    DateCreated string
    Date the image pipeline was created.
    DateLastRun string
    Date the image pipeline was last run.
    DateNextRun string
    Date the image pipeline will run next.
    DateUpdated string
    Date the image pipeline was updated.
    Description string
    Description of the image pipeline.
    DistributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    EnhancedImageMetadataEnabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    ImageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    ImageScanningConfiguration ImagePipelineImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    ImageTestsConfiguration ImagePipelineImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    InfrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    Name string

    Name of the image pipeline.

    The following arguments are optional:

    Platform string
    Platform of the image pipeline.
    Schedule ImagePipelineScheduleArgs
    Configuration block with schedule settings. Detailed below.
    Status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    Tags map[string]string
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated String
    Date the image pipeline was created.
    dateLastRun String
    Date the image pipeline was last run.
    dateNextRun String
    Date the image pipeline will run next.
    dateUpdated String
    Date the image pipeline was updated.
    description String
    Description of the image pipeline.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    name String

    Name of the image pipeline.

    The following arguments are optional:

    platform String
    Platform of the image pipeline.
    schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    status String
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Map<String,String>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn string
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated string
    Date the image pipeline was created.
    dateLastRun string
    Date the image pipeline was last run.
    dateNextRun string
    Date the image pipeline will run next.
    dateUpdated string
    Date the image pipeline was updated.
    description string
    Description of the image pipeline.
    distributionConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn string
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn string
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    name string

    Name of the image pipeline.

    The following arguments are optional:

    platform string
    Platform of the image pipeline.
    schedule ImagePipelineSchedule
    Configuration block with schedule settings. Detailed below.
    status string
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags {[key: string]: string}
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the image pipeline.
    container_recipe_arn str
    Amazon Resource Name (ARN) of the container recipe.
    date_created str
    Date the image pipeline was created.
    date_last_run str
    Date the image pipeline was last run.
    date_next_run str
    Date the image pipeline will run next.
    date_updated str
    Date the image pipeline was updated.
    description str
    Description of the image pipeline.
    distribution_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhanced_image_metadata_enabled bool
    Whether additional information about the image being created is collected. Defaults to true.
    image_recipe_arn str
    Amazon Resource Name (ARN) of the image recipe.
    image_scanning_configuration ImagePipelineImageScanningConfigurationArgs
    Configuration block with image scanning configuration. Detailed below.
    image_tests_configuration ImagePipelineImageTestsConfigurationArgs
    Configuration block with image tests configuration. Detailed below.
    infrastructure_configuration_arn str
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    name str

    Name of the image pipeline.

    The following arguments are optional:

    platform str
    Platform of the image pipeline.
    schedule ImagePipelineScheduleArgs
    Configuration block with schedule settings. Detailed below.
    status str
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Mapping[str, str]
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn String
    Amazon Resource Name (ARN) of the container recipe.
    dateCreated String
    Date the image pipeline was created.
    dateLastRun String
    Date the image pipeline was last run.
    dateNextRun String
    Date the image pipeline will run next.
    dateUpdated String
    Date the image pipeline was updated.
    description String
    Description of the image pipeline.
    distributionConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Distribution Configuration.
    enhancedImageMetadataEnabled Boolean
    Whether additional information about the image being created is collected. Defaults to true.
    imageRecipeArn String
    Amazon Resource Name (ARN) of the image recipe.
    imageScanningConfiguration Property Map
    Configuration block with image scanning configuration. Detailed below.
    imageTestsConfiguration Property Map
    Configuration block with image tests configuration. Detailed below.
    infrastructureConfigurationArn String
    Amazon Resource Name (ARN) of the Image Builder Infrastructure Configuration.
    name String

    Name of the image pipeline.

    The following arguments are optional:

    platform String
    Platform of the image pipeline.
    schedule Property Map
    Configuration block with schedule settings. Detailed below.
    status String
    Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
    tags Map<String>
    Key-value map of resource tags for the image pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ImagePipelineImageScanningConfiguration, ImagePipelineImageScanningConfigurationArgs

    EcrConfiguration ImagePipelineImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration for image scanning. Detailed below.
    ImageScanningEnabled bool
    Whether image scans are enabled. Defaults to false.
    EcrConfiguration ImagePipelineImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration for image scanning. Detailed below.
    ImageScanningEnabled bool
    Whether image scans are enabled. Defaults to false.
    ecrConfiguration ImagePipelineImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration for image scanning. Detailed below.
    imageScanningEnabled Boolean
    Whether image scans are enabled. Defaults to false.
    ecrConfiguration ImagePipelineImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration for image scanning. Detailed below.
    imageScanningEnabled boolean
    Whether image scans are enabled. Defaults to false.
    ecr_configuration ImagePipelineImageScanningConfigurationEcrConfiguration
    Configuration block with ECR configuration for image scanning. Detailed below.
    image_scanning_enabled bool
    Whether image scans are enabled. Defaults to false.
    ecrConfiguration Property Map
    Configuration block with ECR configuration for image scanning. Detailed below.
    imageScanningEnabled Boolean
    Whether image scans are enabled. Defaults to false.

    ImagePipelineImageScanningConfigurationEcrConfiguration, ImagePipelineImageScanningConfigurationEcrConfigurationArgs

    ContainerTags List<string>
    RepositoryName string
    The name of the repository to scan
    ContainerTags []string
    RepositoryName string
    The name of the repository to scan
    containerTags List<String>
    repositoryName String
    The name of the repository to scan
    containerTags string[]
    repositoryName string
    The name of the repository to scan
    container_tags Sequence[str]
    repository_name str
    The name of the repository to scan
    containerTags List<String>
    repositoryName String
    The name of the repository to scan

    ImagePipelineImageTestsConfiguration, ImagePipelineImageTestsConfigurationArgs

    ImageTestsEnabled bool
    Whether image tests are enabled. Defaults to true.
    TimeoutMinutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    ImageTestsEnabled bool
    Whether image tests are enabled. Defaults to true.
    TimeoutMinutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled Boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes Integer
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes number
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    image_tests_enabled bool
    Whether image tests are enabled. Defaults to true.
    timeout_minutes int
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.
    imageTestsEnabled Boolean
    Whether image tests are enabled. Defaults to true.
    timeoutMinutes Number
    Number of minutes before image tests time out. Valid values are between 60 and 1440. Defaults to 720.

    ImagePipelineSchedule, ImagePipelineScheduleArgs

    ScheduleExpression string

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    PipelineExecutionStartCondition string
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    Timezone string
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
    ScheduleExpression string

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    PipelineExecutionStartCondition string
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    Timezone string
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
    scheduleExpression String

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    pipelineExecutionStartCondition String
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    timezone String
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
    scheduleExpression string

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    pipelineExecutionStartCondition string
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    timezone string
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
    schedule_expression str

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    pipeline_execution_start_condition str
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    timezone str
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
    scheduleExpression String

    Cron expression of how often the pipeline start condition is evaluated. For example, cron(0 0 * * ? *) is evaluated every day at midnight UTC. Configurations using the five field syntax that was previously accepted by the API, such as cron(0 0 * * *), must be updated to the six field syntax. For more information, see the Image Builder User Guide.

    The following arguments are optional:

    pipelineExecutionStartCondition String
    Condition when the pipeline should trigger a new image build. Valid values are EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE and EXPRESSION_MATCH_ONLY. Defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
    timezone String
    The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

    Import

    Using pulumi import, import aws_imagebuilder_image_pipeline resources using the Amazon Resource Name (ARN). For example:

    $ pulumi import aws:imagebuilder/imagePipeline:ImagePipeline example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws