AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

getImagePipeline

Provides details about an Image Builder Image Pipeline.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.ImageBuilder.GetImagePipeline.Invoke(new()
    {
        Arn = "arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := imagebuilder.LookupImagePipeline(ctx, &imagebuilder.LookupImagePipelineArgs{
			Arn: "arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.ImagebuilderFunctions;
import com.pulumi.aws.imagebuilder.inputs.GetImagePipelineArgs;
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) {
        final var example = ImagebuilderFunctions.getImagePipeline(GetImagePipelineArgs.builder()
            .arn("arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.imagebuilder.get_image_pipeline(arn="arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example")

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

const example = pulumi.output(aws.imagebuilder.getImagePipeline({
    arn: "arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example",
}));

variables:
  example:
    Fn::Invoke:
      Function: aws:imagebuilder:getImagePipeline
      Arguments:
        arn: arn:aws:imagebuilder:us-west-2:aws:image-pipeline/example

Using getImagePipeline

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImagePipeline(args: GetImagePipelineArgs, opts?: InvokeOptions): Promise<GetImagePipelineResult>
function getImagePipelineOutput(args: GetImagePipelineOutputArgs, opts?: InvokeOptions): Output<GetImagePipelineResult>

def get_image_pipeline(arn: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetImagePipelineResult
def get_image_pipeline_output(arn: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetImagePipelineResult]

func LookupImagePipeline(ctx *Context, args *LookupImagePipelineArgs, opts ...InvokeOption) (*LookupImagePipelineResult, error)
func LookupImagePipelineOutput(ctx *Context, args *LookupImagePipelineOutputArgs, opts ...InvokeOption) LookupImagePipelineResultOutput

> Note: This function is named LookupImagePipeline in the Go SDK.

public static class GetImagePipeline 
{
    public static Task<GetImagePipelineResult> InvokeAsync(GetImagePipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetImagePipelineResult> Invoke(GetImagePipelineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImagePipelineResult> getImagePipeline(GetImagePipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: aws:imagebuilder/getImagePipeline:getImagePipeline
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Arn string: ARN of the image pipeline.
Tags Dictionary<string, string>: Key-value map of resource tags for the image pipeline.

Arn string: ARN of the image pipeline.
Tags map[string]string: Key-value map of resource tags for the image pipeline.

arn String: ARN of the image pipeline.
tags Map<String,String>: Key-value map of resource tags for the image pipeline.

arn string: ARN of the image pipeline.
tags {[key: string]: string}: Key-value map of resource tags for the image pipeline.

arn str: ARN of the image pipeline.
tags Mapping[str, str]: Key-value map of resource tags for the image pipeline.

arn String: ARN of the image pipeline.
tags Map<String>: Key-value map of resource tags for the image pipeline.

getImagePipeline Result

The following output properties are available:

Arn string
ContainerRecipeArn string: 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: ARN of the Image Builder Distribution Configuration.
EnhancedImageMetadataEnabled bool: Whether additional information about the image being created is collected.
Id string: The provider-assigned unique ID for this managed resource.
ImageRecipeArn string: ARN of the image recipe.
ImageTestsConfigurations List<GetImagePipelineImageTestsConfiguration>: List of an object with image tests configuration.
InfrastructureConfigurationArn string: ARN of the Image Builder Infrastructure Configuration.
Name string: Name of the image pipeline.
Platform string: Platform of the image pipeline.
Schedules List<GetImagePipelineSchedule>: List of an object with schedule settings.
Status string: Status of the image pipeline.
Tags Dictionary<string, string>: Key-value map of resource tags for the image pipeline.

Arn string
ContainerRecipeArn string: 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: ARN of the Image Builder Distribution Configuration.
EnhancedImageMetadataEnabled bool: Whether additional information about the image being created is collected.
Id string: The provider-assigned unique ID for this managed resource.
ImageRecipeArn string: ARN of the image recipe.
ImageTestsConfigurations []GetImagePipelineImageTestsConfiguration: List of an object with image tests configuration.
InfrastructureConfigurationArn string: ARN of the Image Builder Infrastructure Configuration.
Name string: Name of the image pipeline.
Platform string: Platform of the image pipeline.
Schedules []GetImagePipelineSchedule: List of an object with schedule settings.
Status string: Status of the image pipeline.
Tags map[string]string: Key-value map of resource tags for the image pipeline.

arn String
containerRecipeArn String: 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: ARN of the Image Builder Distribution Configuration.
enhancedImageMetadataEnabled Boolean: Whether additional information about the image being created is collected.
id String: The provider-assigned unique ID for this managed resource.
imageRecipeArn String: ARN of the image recipe.
imageTestsConfigurations List<GetImagePipelineImageTestsConfiguration>: List of an object with image tests configuration.
infrastructureConfigurationArn String: ARN of the Image Builder Infrastructure Configuration.
name String: Name of the image pipeline.
platform String: Platform of the image pipeline.
schedules List<GetImagePipelineSchedule>: List of an object with schedule settings.
status String: Status of the image pipeline.
tags Map<String,String>: Key-value map of resource tags for the image pipeline.

arn string
containerRecipeArn string: 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: ARN of the Image Builder Distribution Configuration.
enhancedImageMetadataEnabled boolean: Whether additional information about the image being created is collected.
id string: The provider-assigned unique ID for this managed resource.
imageRecipeArn string: ARN of the image recipe.
imageTestsConfigurations GetImagePipelineImageTestsConfiguration[]: List of an object with image tests configuration.
infrastructureConfigurationArn string: ARN of the Image Builder Infrastructure Configuration.
name string: Name of the image pipeline.
platform string: Platform of the image pipeline.
schedules GetImagePipelineSchedule[]: List of an object with schedule settings.
status string: Status of the image pipeline.
tags {[key: string]: string}: Key-value map of resource tags for the image pipeline.

arn str
container_recipe_arn str: 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: ARN of the Image Builder Distribution Configuration.
enhanced_image_metadata_enabled bool: Whether additional information about the image being created is collected.
id str: The provider-assigned unique ID for this managed resource.
image_recipe_arn str: ARN of the image recipe.
image_tests_configurations Sequence[GetImagePipelineImageTestsConfiguration]: List of an object with image tests configuration.
infrastructure_configuration_arn str: ARN of the Image Builder Infrastructure Configuration.
name str: Name of the image pipeline.
platform str: Platform of the image pipeline.
schedules Sequence[GetImagePipelineSchedule]: List of an object with schedule settings.
status str: Status of the image pipeline.
tags Mapping[str, str]: Key-value map of resource tags for the image pipeline.

arn String
containerRecipeArn String: 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: ARN of the Image Builder Distribution Configuration.
enhancedImageMetadataEnabled Boolean: Whether additional information about the image being created is collected.
id String: The provider-assigned unique ID for this managed resource.
imageRecipeArn String: ARN of the image recipe.
imageTestsConfigurations List<Property Map>: List of an object with image tests configuration.
infrastructureConfigurationArn String: ARN of the Image Builder Infrastructure Configuration.
name String: Name of the image pipeline.
platform String: Platform of the image pipeline.
schedules List<Property Map>: List of an object with schedule settings.
status String: Status of the image pipeline.
tags Map<String>: Key-value map of resource tags for the image pipeline.

Supporting Types

GetImagePipelineImageTestsConfiguration

ImageTestsEnabled bool: Whether image tests are enabled.
TimeoutMinutes int: Number of minutes before image tests time out.

ImageTestsEnabled bool: Whether image tests are enabled.
TimeoutMinutes int: Number of minutes before image tests time out.

imageTestsEnabled Boolean: Whether image tests are enabled.
timeoutMinutes Integer: Number of minutes before image tests time out.

imageTestsEnabled boolean: Whether image tests are enabled.
timeoutMinutes number: Number of minutes before image tests time out.

image_tests_enabled bool: Whether image tests are enabled.
timeout_minutes int: Number of minutes before image tests time out.

imageTestsEnabled Boolean: Whether image tests are enabled.
timeoutMinutes Number: Number of minutes before image tests time out.

GetImagePipelineSchedule

PipelineExecutionStartCondition string: Condition when the pipeline should trigger a new image build.
ScheduleExpression string: Cron expression of how often the pipeline start condition is evaluated.

PipelineExecutionStartCondition string: Condition when the pipeline should trigger a new image build.
ScheduleExpression string: Cron expression of how often the pipeline start condition is evaluated.

pipelineExecutionStartCondition String: Condition when the pipeline should trigger a new image build.
scheduleExpression String: Cron expression of how often the pipeline start condition is evaluated.

pipelineExecutionStartCondition string: Condition when the pipeline should trigger a new image build.
scheduleExpression string: Cron expression of how often the pipeline start condition is evaluated.

pipeline_execution_start_condition str: Condition when the pipeline should trigger a new image build.
schedule_expression str: Cron expression of how often the pipeline start condition is evaluated.

pipelineExecutionStartCondition String: Condition when the pipeline should trigger a new image build.
scheduleExpression String: Cron expression of how often the pipeline start condition is evaluated.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.