@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
151 lines (150 loc) • 4.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Provides details about an Image Builder Image.
*
* ## Example Usage
*
* ### Latest
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.imagebuilder.getImage({
* arn: "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x",
* });
* ```
*/
export declare function getImage(args: GetImageArgs, opts?: pulumi.InvokeOptions): Promise<GetImageResult>;
/**
* A collection of arguments for invoking getImage.
*/
export interface GetImageArgs {
/**
* ARN of the image. The suffix can either be specified with wildcards (`x.x.x`) to fetch the latest build version or a full build version (e.g., `2020.11.26/1`) to fetch an exact version.
*/
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.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getImage.
*/
export interface GetImageResult {
readonly arn: string;
/**
* Build version ARN of the image. This will always have the `#.#.#/#` suffix.
*/
readonly buildVersionArn: string;
/**
* ARN of the container recipe.
*/
readonly containerRecipeArn: string;
/**
* Date the image was created.
*/
readonly dateCreated: string;
/**
* ARN of the Image Builder Distribution Configuration.
*/
readonly distributionConfigurationArn: string;
/**
* Whether additional information about the image being created is collected.
*/
readonly enhancedImageMetadataEnabled: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* ARN of the image recipe.
*/
readonly imageRecipeArn: string;
/**
* List of an object with image scanning configuration fields.
*/
readonly imageScanningConfigurations: outputs.imagebuilder.GetImageImageScanningConfiguration[];
/**
* List of an object with image tests configuration.
*/
readonly imageTestsConfigurations: outputs.imagebuilder.GetImageImageTestsConfiguration[];
/**
* ARN of the Image Builder Infrastructure Configuration.
*/
readonly infrastructureConfigurationArn: string;
/**
* Name of the AMI.
*/
readonly name: string;
/**
* Operating System version of the image.
*/
readonly osVersion: string;
/**
* List of objects with resources created by the image.
*/
readonly outputResources: outputs.imagebuilder.GetImageOutputResource[];
/**
* Platform of the image.
*/
readonly platform: string;
/**
* Region of the container image.
*/
readonly region: string;
/**
* Key-value map of resource tags for the image.
*/
readonly tags: {
[key: string]: string;
};
/**
* Version of the image.
*/
readonly version: string;
}
/**
* Provides details about an Image Builder Image.
*
* ## Example Usage
*
* ### Latest
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.imagebuilder.getImage({
* arn: "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/x.x.x",
* });
* ```
*/
export declare function getImageOutput(args: GetImageOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetImageResult>;
/**
* A collection of arguments for invoking getImage.
*/
export interface GetImageOutputArgs {
/**
* ARN of the image. The suffix can either be specified with wildcards (`x.x.x`) to fetch the latest build version or a full build version (e.g., `2020.11.26/1`) to fetch an exact version.
*/
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.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}