@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
169 lines • 6.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* SipTrunk is the resource that represents a SIP trunk to connect to the Google Telephony Platform SIP trunking service.
*
* To get more information about SipTrunk, see:
*
* * [API documentation](https://cloud.google.com/dialogflow/es/docs/reference/rest/v2/projects.locations.sipTrunks)
*
* ## Example Usage
*
* ### Dialogflow Sip Trunk Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basicTrunk = new gcp.diagflow.SipTrunk("basic_trunk", {
* displayName: "basic-trunk",
* location: "europe-west3",
* expectedHostnames: ["basic-trunk.example.com"],
* });
* ```
*
* ## Import
*
* SipTrunk can be imported using any of these accepted formats:
*
* * `{{name}}`
*
* When using the `pulumi import` command, SipTrunk can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:diagflow/sipTrunk:SipTrunk default {{name}}
* ```
*/
export declare class SipTrunk extends pulumi.CustomResource {
/**
* Get an existing SipTrunk 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?: SipTrunkState, opts?: pulumi.CustomResourceOptions): SipTrunk;
/**
* Returns true if the given object is an instance of SipTrunk. 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 SipTrunk;
/**
* Output only. The connections of the SIP trunk.
* Structure is documented below.
*/
readonly connections: pulumi.Output<outputs.diagflow.SipTrunkConnection[]>;
/**
* 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>;
/**
* Optional. Human-readable alias for this trunk.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Required. The expected hostnames in the peer certificate from the partner that is used for TLS authentication.
*/
readonly expectedHostnames: pulumi.Output<string[]>;
/**
* The location of the SIP trunk.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The unique identifier of the SIP trunk.
*/
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>;
/**
* Create a SipTrunk 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: SipTrunkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SipTrunk resources.
*/
export interface SipTrunkState {
/**
* Output only. The connections of the SIP trunk.
* Structure is documented below.
*/
connections?: pulumi.Input<pulumi.Input<inputs.diagflow.SipTrunkConnection>[] | 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>;
/**
* Optional. Human-readable alias for this trunk.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Required. The expected hostnames in the peer certificate from the partner that is used for TLS authentication.
*/
expectedHostnames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The location of the SIP trunk.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The unique identifier of the SIP trunk.
*/
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>;
}
/**
* The set of arguments for constructing a SipTrunk resource.
*/
export interface SipTrunkArgs {
/**
* 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>;
/**
* Optional. Human-readable alias for this trunk.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Required. The expected hostnames in the peer certificate from the partner that is used for TLS authentication.
*/
expectedHostnames: pulumi.Input<pulumi.Input<string>[]>;
/**
* The location of the SIP trunk.
*/
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=sipTrunk.d.ts.map