@pulumi/aws/imagebuilder/getImageRecipe.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Provides details about an Image Builder Image Recipe.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.imagebuilder.getImageRecipe({
 *     arn: "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
 * });
 * ```
 */
export declare function getImageRecipe(args: GetImageRecipeArgs, opts?: pulumi.InvokeOptions): Promise<GetImageRecipeResult>;
/**
 * A collection of arguments for invoking getImageRecipe.
 */
export interface GetImageRecipeArgs {
    /**
     * ARN of the image recipe.
     */
    arn: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Key-value map of resource tags for the image recipe.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getImageRecipe.
 */
export interface GetImageRecipeResult {
    /**
     * Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
     */
    readonly amiTags: {
        [key: string]: string;
    };
    readonly arn: string;
    /**
     * Set of objects with block device mappings for the image recipe.
     */
    readonly blockDeviceMappings: outputs.imagebuilder.GetImageRecipeBlockDeviceMapping[];
    /**
     * List of objects with components for the image recipe.
     */
    readonly components: outputs.imagebuilder.GetImageRecipeComponent[];
    /**
     * Date the image recipe was created.
     */
    readonly dateCreated: string;
    /**
     * Description of the image recipe.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Name of the image recipe.
     */
    readonly name: string;
    /**
     * Owner of the image recipe.
     */
    readonly owner: string;
    /**
     * Base image of the image recipe.
     */
    readonly parentImage: string;
    /**
     * Platform of the image recipe.
     */
    readonly platform: string;
    readonly region: string;
    /**
     * Key-value map of resource tags for the image recipe.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Base64 encoded contents of user data. Commands or a command script to run when build instance is launched.
     */
    readonly userDataBase64: string;
    /**
     * Version of the image recipe.
     */
    readonly version: string;
    /**
     * Working directory used during build and test workflows.
     */
    readonly workingDirectory: string;
}
/**
 * Provides details about an Image Builder Image Recipe.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.imagebuilder.getImageRecipe({
 *     arn: "arn:aws:imagebuilder:us-east-1:aws:image-recipe/example/1.0.0",
 * });
 * ```
 */
export declare function getImageRecipeOutput(args: GetImageRecipeOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetImageRecipeResult>;
/**
 * A collection of arguments for invoking getImageRecipe.
 */
export interface GetImageRecipeOutputArgs {
    /**
     * ARN of the image recipe.
     */
    arn: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Key-value map of resource tags for the image recipe.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}