@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
247 lines • 9.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Description
*
* ## Example Usage
*
* ### Ces App Version Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_app = new gcp.ces.App("my-app", {
* location: "us",
* displayName: "my-app",
* appId: "app-id",
* timeZoneSettings: {
* timeZone: "America/Los_Angeles",
* },
* });
* const my_app_version = new gcp.ces.AppVersion("my-app-version", {
* location: "us",
* displayName: "my-app-version",
* app: my_app.name,
* appVersionId: "app-version-id",
* description: "example-app-version",
* });
* ```
*
* ## Import
*
* AppVersion can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/apps/{{app}}/versions/{{name}}`
* * `{{project}}/{{location}}/{{app}}/{{name}}`
* * `{{location}}/{{app}}/{{name}}`
*
* When using the `pulumi import` command, AppVersion can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:ces/appVersion:AppVersion default projects/{{project}}/locations/{{location}}/apps/{{app}}/versions/{{name}}
* $ pulumi import gcp:ces/appVersion:AppVersion default {{project}}/{{location}}/{{app}}/{{name}}
* $ pulumi import gcp:ces/appVersion:AppVersion default {{location}}/{{app}}/{{name}}
* ```
*/
export declare class AppVersion extends pulumi.CustomResource {
/**
* Get an existing AppVersion 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppVersionState, opts?: pulumi.CustomResourceOptions): AppVersion;
/**
* Returns true if the given object is an instance of AppVersion. 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 AppVersion;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly app: pulumi.Output<string>;
/**
* The ID to use for the app version, which will become the final component
* of the app version's resource name. If not provided, a unique ID will be
* automatically assigned for the app version.
*/
readonly appVersionId: pulumi.Output<string>;
/**
* (Output)
* Timestamp when the toolset was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Email of the user who created the app version.
*/
readonly creator: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The description of the app version.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name of the app version.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* (Output)
* ETag used to ensure the object hasn't changed during a read-modify-write
* operation. If the etag is empty, the update will overwrite any concurrent
* changes.
*/
readonly etag: pulumi.Output<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* (Output)
* Identifier. The unique identifier of the toolset.
* Format:
* `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* A snapshot of the app.
* Structure is documented below.
*/
readonly snapshots: pulumi.Output<outputs.ces.AppVersionSnapshot[]>;
/**
* Create a AppVersion 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: AppVersionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AppVersion resources.
*/
export interface AppVersionState {
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
app?: pulumi.Input<string | undefined>;
/**
* The ID to use for the app version, which will become the final component
* of the app version's resource name. If not provided, a unique ID will be
* automatically assigned for the app version.
*/
appVersionId?: pulumi.Input<string | undefined>;
/**
* (Output)
* Timestamp when the toolset was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Email of the user who created the app version.
*/
creator?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The description of the app version.
*/
description?: pulumi.Input<string | undefined>;
/**
* The display name of the app version.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* (Output)
* ETag used to ensure the object hasn't changed during a read-modify-write
* operation. If the etag is empty, the update will overwrite any concurrent
* changes.
*/
etag?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* (Output)
* Identifier. The unique identifier of the toolset.
* Format:
* `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* A snapshot of the app.
* Structure is documented below.
*/
snapshots?: pulumi.Input<pulumi.Input<inputs.ces.AppVersionSnapshot>[] | undefined>;
}
/**
* The set of arguments for constructing a AppVersion resource.
*/
export interface AppVersionArgs {
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
app: pulumi.Input<string>;
/**
* The ID to use for the app version, which will become the final component
* of the app version's resource name. If not provided, a unique ID will be
* automatically assigned for the app version.
*/
appVersionId: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The description of the app version.
*/
description?: pulumi.Input<string | undefined>;
/**
* The display name of the app version.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=appVersion.d.ts.map