@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
165 lines (164 loc) • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource schema for AWS::ImageBuilder::ContainerRecipe
*/
export declare class ContainerRecipe extends pulumi.CustomResource {
/**
* Get an existing ContainerRecipe resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ContainerRecipe;
/**
* Returns true if the given object is an instance of ContainerRecipe. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ContainerRecipe;
/**
* The Amazon Resource Name (ARN) of the container recipe.
*/
readonly arn: pulumi.Output<string>;
/**
* Components for build and test that are included in the container recipe.
*/
readonly components: pulumi.Output<outputs.imagebuilder.ContainerRecipeComponentConfiguration[] | undefined>;
/**
* Specifies the type of container, such as Docker.
*/
readonly containerType: pulumi.Output<enums.imagebuilder.ContainerRecipeContainerType | undefined>;
/**
* The description of the container recipe.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly dockerfileTemplateData: pulumi.Output<string | undefined>;
/**
* The S3 URI for the Dockerfile that will be used to build your container image.
*/
readonly dockerfileTemplateUri: pulumi.Output<string | undefined>;
/**
* Specifies the operating system version for the source image.
*/
readonly imageOsVersionOverride: pulumi.Output<string | undefined>;
/**
* A group of options that can be used to configure an instance for building and testing container images.
*/
readonly instanceConfiguration: pulumi.Output<outputs.imagebuilder.ContainerRecipeInstanceConfiguration | undefined>;
/**
* Identifies which KMS key is used to encrypt the container image.
*/
readonly kmsKeyId: pulumi.Output<string | undefined>;
/**
* The name of the container recipe.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The source image for the container recipe.
*/
readonly parentImage: pulumi.Output<string | undefined>;
/**
* Specifies the operating system platform when you use a custom source image.
*/
readonly platformOverride: pulumi.Output<enums.imagebuilder.ContainerRecipePlatformOverride | undefined>;
/**
* Tags that are attached to the container recipe.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The destination repository for the container image.
*/
readonly targetRepository: pulumi.Output<outputs.imagebuilder.ContainerRecipeTargetContainerRepository | undefined>;
/**
* The semantic version of the container recipe (<major>.<minor>.<patch>).
*/
readonly version: pulumi.Output<string | undefined>;
/**
* The working directory to be used during build and test workflows.
*/
readonly workingDirectory: pulumi.Output<string | undefined>;
/**
* Create a ContainerRecipe resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ContainerRecipeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ContainerRecipe resource.
*/
export interface ContainerRecipeArgs {
/**
* Components for build and test that are included in the container recipe.
*/
components?: pulumi.Input<pulumi.Input<inputs.imagebuilder.ContainerRecipeComponentConfigurationArgs>[]>;
/**
* Specifies the type of container, such as Docker.
*/
containerType?: pulumi.Input<enums.imagebuilder.ContainerRecipeContainerType>;
/**
* The description of the container recipe.
*/
description?: pulumi.Input<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.
*/
dockerfileTemplateData?: pulumi.Input<string>;
/**
* The S3 URI for the Dockerfile that will be used to build your container image.
*/
dockerfileTemplateUri?: pulumi.Input<string>;
/**
* Specifies the operating system version for the source image.
*/
imageOsVersionOverride?: pulumi.Input<string>;
/**
* A group of options that can be used to configure an instance for building and testing container images.
*/
instanceConfiguration?: pulumi.Input<inputs.imagebuilder.ContainerRecipeInstanceConfigurationArgs>;
/**
* Identifies which KMS key is used to encrypt the container image.
*/
kmsKeyId?: pulumi.Input<string>;
/**
* The name of the container recipe.
*/
name?: pulumi.Input<string>;
/**
* The source image for the container recipe.
*/
parentImage?: pulumi.Input<string>;
/**
* Specifies the operating system platform when you use a custom source image.
*/
platformOverride?: pulumi.Input<enums.imagebuilder.ContainerRecipePlatformOverride>;
/**
* Tags that are attached to the container recipe.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The destination repository for the container image.
*/
targetRepository?: pulumi.Input<inputs.imagebuilder.ContainerRecipeTargetContainerRepositoryArgs>;
/**
* The semantic version of the container recipe (<major>.<minor>.<patch>).
*/
version?: pulumi.Input<string>;
/**
* The working directory to be used during build and test workflows.
*/
workingDirectory?: pulumi.Input<string>;
}