@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
294 lines • 11.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Description
*
* ## Example Usage
*
* ### Ces Deployment 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_deployment = new gcp.ces.Deployment("my-deployment", {
* location: "us",
* displayName: "my-deployment",
* app: my_app.name,
* appVersion: "projects/example-project/locations/us/apps/example-app/versions/example-version",
* channelProfile: {
* channelType: "API",
* disableBargeInControl: true,
* disableDtmf: true,
* personaProperty: {
* persona: "CHATTY",
* },
* profileId: "temp_profile_id",
* webWidgetConfig: {
* modality: "CHAT_AND_VOICE",
* theme: "DARK",
* webWidgetTitle: "temp_webwidget_title",
* },
* },
* });
* ```
* ### Ces Deployment Full
*
* ```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_deployment = new gcp.ces.Deployment("my-deployment", {
* location: "us",
* displayName: "my-deployment",
* app: my_app.name,
* appVersion: "projects/example-project/locations/us/apps/example-app/versions/example-version",
* channelProfile: {
* channelType: "API",
* disableBargeInControl: true,
* disableDtmf: true,
* personaProperty: {
* persona: "CHATTY",
* },
* profileId: "temp_profile_id",
* webWidgetConfig: {
* modality: "CHAT_AND_VOICE",
* theme: "DARK",
* webWidgetTitle: "temp_webwidget_title",
* securitySettings: {
* enablePublicAccess: true,
* enableOriginCheck: true,
* allowedOrigins: [
* "https://example.com",
* "https://test.com",
* ],
* enableRecaptcha: true,
* },
* },
* },
* });
* ```
*
* ## Import
*
* Deployment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/apps/{{app}}/deployments/{{name}}`
* * `{{project}}/{{location}}/{{app}}/{{name}}`
* * `{{location}}/{{app}}/{{name}}`
*
* When using the `pulumi import` command, Deployment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:ces/deployment:Deployment default projects/{{project}}/locations/{{location}}/apps/{{app}}/deployments/{{name}}
* $ pulumi import gcp:ces/deployment:Deployment default {{project}}/{{location}}/{{app}}/{{name}}
* $ pulumi import gcp:ces/deployment:Deployment default {{location}}/{{app}}/{{name}}
* ```
*/
export declare class Deployment extends pulumi.CustomResource {
/**
* Get an existing Deployment 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?: DeploymentState, opts?: pulumi.CustomResourceOptions): Deployment;
/**
* Returns true if the given object is an instance of Deployment. 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 Deployment;
/**
* 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 resource name of the app version to deploy.
* Format:
* projects/{project}/locations/{location}/apps/{app}/versions/{version}
*/
readonly appVersion: pulumi.Output<string>;
/**
* A ChannelProfile configures the agent's behavior for a specific communication
* channel, such as web UI or telephony.
* Structure is documented below.
*/
readonly channelProfile: pulumi.Output<outputs.ces.DeploymentChannelProfile>;
/**
* Timestamp when this deployment was created.
*/
readonly createTime: 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>;
/**
* Display name of the deployment.
*/
readonly displayName: pulumi.Output<string>;
/**
* 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>;
/**
* Identifier. The resource name of the deployment.
* Format:
* projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
*/
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>;
/**
* Timestamp when this deployment was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Deployment 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: DeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Deployment resources.
*/
export interface DeploymentState {
/**
* 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 resource name of the app version to deploy.
* Format:
* projects/{project}/locations/{location}/apps/{app}/versions/{version}
*/
appVersion?: pulumi.Input<string | undefined>;
/**
* A ChannelProfile configures the agent's behavior for a specific communication
* channel, such as web UI or telephony.
* Structure is documented below.
*/
channelProfile?: pulumi.Input<inputs.ces.DeploymentChannelProfile | undefined>;
/**
* Timestamp when this deployment was created.
*/
createTime?: 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>;
/**
* Display name of the deployment.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* 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>;
/**
* Identifier. The resource name of the deployment.
* Format:
* projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
*/
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>;
/**
* Timestamp when this deployment was last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Deployment resource.
*/
export interface DeploymentArgs {
/**
* 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 resource name of the app version to deploy.
* Format:
* projects/{project}/locations/{location}/apps/{app}/versions/{version}
*/
appVersion: pulumi.Input<string>;
/**
* A ChannelProfile configures the agent's behavior for a specific communication
* channel, such as web UI or telephony.
* Structure is documented below.
*/
channelProfile: pulumi.Input<inputs.ces.DeploymentChannelProfile>;
/**
* 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>;
/**
* Display name of the deployment.
*/
displayName: pulumi.Input<string>;
/**
* 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=deployment.d.ts.map