@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
163 lines • 6.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Security settings for a location in Customer Engagement Suite.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about SecuritySettings, see:
*
* * [API documentation](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/rest/v1beta/SecuritySettings)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/customer-engagement-ai/docs)
*
* ## Example Usage
*
* ### Ces Security Settings Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const securitySettings = new gcp.ces.SecuritySettings("security_settings", {
* location: "us",
* endpointControlPolicy: {
* enforcementScope: "ALWAYS",
* allowedOrigins: [
* "https://example.com",
* "https://google.com",
* ],
* },
* });
* ```
*
* ## Import
*
* SecuritySettings can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/securitySettings`
* * `{{project}}/{{location}}`
* * `{{location}}`
*
* When using the `pulumi import` command, SecuritySettings can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:ces/securitySettings:SecuritySettings default projects/{{project}}/locations/{{location}}/securitySettings
* $ pulumi import gcp:ces/securitySettings:SecuritySettings default {{project}}/{{location}}
* $ pulumi import gcp:ces/securitySettings:SecuritySettings default {{location}}
* ```
*/
export declare class SecuritySettings extends pulumi.CustomResource {
/**
* Get an existing SecuritySettings 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?: SecuritySettingsState, opts?: pulumi.CustomResourceOptions): SecuritySettings;
/**
* Returns true if the given object is an instance of SecuritySettings. 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 SecuritySettings;
/**
* Output only. Timestamp when the security settings were created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Optional. Endpoint control related settings.
* Structure is documented below.
*/
readonly endpointControlPolicy: pulumi.Output<outputs.ces.SecuritySettingsEndpointControlPolicy | undefined>;
/**
* Output only. Etag of the resource.
*/
readonly etag: pulumi.Output<string>;
/**
* The location of the security settings.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The unique identifier of the security settings.
* Format: projects/{project}/locations/{location}/securitySettings
*/
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>;
/**
* Output only. Timestamp when the security settings were last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a SecuritySettings 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: SecuritySettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecuritySettings resources.
*/
export interface SecuritySettingsState {
/**
* Output only. Timestamp when the security settings were created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Optional. Endpoint control related settings.
* Structure is documented below.
*/
endpointControlPolicy?: pulumi.Input<inputs.ces.SecuritySettingsEndpointControlPolicy | undefined>;
/**
* Output only. Etag of the resource.
*/
etag?: pulumi.Input<string | undefined>;
/**
* The location of the security settings.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The unique identifier of the security settings.
* Format: projects/{project}/locations/{location}/securitySettings
*/
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>;
/**
* Output only. Timestamp when the security settings were last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SecuritySettings resource.
*/
export interface SecuritySettingsArgs {
/**
* Optional. Endpoint control related settings.
* Structure is documented below.
*/
endpointControlPolicy?: pulumi.Input<inputs.ces.SecuritySettingsEndpointControlPolicy | undefined>;
/**
* The location of the security settings.
*/
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=securitySettings.d.ts.map