@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
278 lines (277 loc) • 8.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Application is a functional grouping of Services and Workloads that helps achieve a desired end-to-end business functionality. Services and Workloads are owned by the Application.
*
* ## Example Usage
*
* ### Apphub Application Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.apphub.Application("example", {
* location: "us-east1",
* applicationId: "example-application",
* scope: {
* type: "REGIONAL",
* },
* });
* ```
* ### Apphub Application Global Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.apphub.Application("example", {
* location: "global",
* applicationId: "example-application",
* scope: {
* type: "GLOBAL",
* },
* });
* ```
* ### Apphub Application Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example2 = new gcp.apphub.Application("example2", {
* location: "us-east1",
* applicationId: "example-application",
* displayName: "Application Full",
* scope: {
* type: "REGIONAL",
* },
* description: "Application for testing",
* attributes: {
* environment: {
* type: "STAGING",
* },
* criticality: {
* type: "MISSION_CRITICAL",
* },
* businessOwners: [{
* displayName: "Alice",
* email: "alice@google.com",
* }],
* developerOwners: [{
* displayName: "Bob",
* email: "bob@google.com",
* }],
* operatorOwners: [{
* displayName: "Charlie",
* email: "charlie@google.com",
* }],
* },
* });
* ```
*
* ## Import
*
* Application can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/applications/{{application_id}}`
*
* * `{{project}}/{{location}}/{{application_id}}`
*
* * `{{location}}/{{application_id}}`
*
* When using the `pulumi import` command, Application can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apphub/application:Application default projects/{{project}}/locations/{{location}}/applications/{{application_id}}
* ```
*
* ```sh
* $ pulumi import gcp:apphub/application:Application default {{project}}/{{location}}/{{application_id}}
* ```
*
* ```sh
* $ pulumi import gcp:apphub/application:Application default {{location}}/{{application_id}}
* ```
*/
export declare class Application extends pulumi.CustomResource {
/**
* Get an existing Application 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?: ApplicationState, opts?: pulumi.CustomResourceOptions): Application;
/**
* Returns true if the given object is an instance of Application. 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 Application;
/**
* Required. The Application identifier.
*/
readonly applicationId: pulumi.Output<string>;
/**
* Consumer provided attributes.
* Structure is documented below.
*/
readonly attributes: pulumi.Output<outputs.apphub.ApplicationAttributes | undefined>;
/**
* Output only. Create time.
*/
readonly createTime: pulumi.Output<string>;
/**
* Optional. User-defined description of an Application.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Optional. User-defined name for the Application.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Part of `parent`. See documentation of `projectsId`.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The resource name of an Application. Format:
* "projects/{host-project-id}/locations/{location}/applications/{application-id}"
*/
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>;
/**
* Scope of an application.
* Structure is documented below.
*/
readonly scope: pulumi.Output<outputs.apphub.ApplicationScope>;
/**
* Output only. Application state.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* ACTIVE
* DELETING
*/
readonly state: pulumi.Output<string>;
/**
* Output only. A universally unique identifier (in UUID4 format) for the `Application`.
*/
readonly uid: pulumi.Output<string>;
/**
* Output only. Update time.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Application 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: ApplicationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Application resources.
*/
export interface ApplicationState {
/**
* Required. The Application identifier.
*/
applicationId?: pulumi.Input<string>;
/**
* Consumer provided attributes.
* Structure is documented below.
*/
attributes?: pulumi.Input<inputs.apphub.ApplicationAttributes>;
/**
* Output only. Create time.
*/
createTime?: pulumi.Input<string>;
/**
* Optional. User-defined description of an Application.
*/
description?: pulumi.Input<string>;
/**
* Optional. User-defined name for the Application.
*/
displayName?: pulumi.Input<string>;
/**
* Part of `parent`. See documentation of `projectsId`.
*/
location?: pulumi.Input<string>;
/**
* Identifier. The resource name of an Application. Format:
* "projects/{host-project-id}/locations/{location}/applications/{application-id}"
*/
name?: 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>;
/**
* Scope of an application.
* Structure is documented below.
*/
scope?: pulumi.Input<inputs.apphub.ApplicationScope>;
/**
* Output only. Application state.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* ACTIVE
* DELETING
*/
state?: pulumi.Input<string>;
/**
* Output only. A universally unique identifier (in UUID4 format) for the `Application`.
*/
uid?: pulumi.Input<string>;
/**
* Output only. Update time.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Application resource.
*/
export interface ApplicationArgs {
/**
* Required. The Application identifier.
*/
applicationId: pulumi.Input<string>;
/**
* Consumer provided attributes.
* Structure is documented below.
*/
attributes?: pulumi.Input<inputs.apphub.ApplicationAttributes>;
/**
* Optional. User-defined description of an Application.
*/
description?: pulumi.Input<string>;
/**
* Optional. User-defined name for the Application.
*/
displayName?: pulumi.Input<string>;
/**
* Part of `parent`. See documentation of `projectsId`.
*/
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>;
/**
* Scope of an application.
* Structure is documented below.
*/
scope: pulumi.Input<inputs.apphub.ApplicationScope>;
}