import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Deployment of Security Gateway. * * ## Example Usage * * ### Beyondcorp Security Gateway Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.beyondcorp.SecurityGateway("example", { * securityGatewayId: "default", * displayName: "My Security Gateway resource", * hubs: [{ * region: "us-central1", * }], * }); * ``` * ### Beyondcorp Security Gateway Logging * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example_logging = new gcp.beyondcorp.SecurityGateway("example-logging", { * securityGatewayId: "default-logging", * displayName: "My Security Gateway resource with logging enabled", * hubs: [{ * region: "us-central1", * }], * logging: {}, * }); * ``` * ### Beyondcorp Security Gateway Spa * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example_spa = new gcp.beyondcorp.SecurityGateway("example-spa", { * securityGatewayId: "default-spa", * displayName: "My SPA Security Gateway resource", * proxyProtocolConfig: { * allowedClientHeaders: [ * "header1", * "header2", * ], * contextualHeaders: { * userInfo: { * outputType: "PROTOBUF", * }, * groupInfo: { * outputType: "JSON", * }, * deviceInfo: { * outputType: "NONE", * }, * outputType: "NONE", * }, * metadataHeaders: { * "metadata-header1": "value1", * "metadata-header2": "value2", * }, * gatewayIdentity: "RESOURCE_NAME", * clientIp: true, * }, * serviceDiscovery: { * apiGateway: { * resourceOverride: { * path: "/api/v1/routes", * }, * }, * }, * }); * ``` * * ## Import * * SecurityGateway can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/securityGateways/{{security_gateway_id}}` * * `{{project}}/{{location}}/{{security_gateway_id}}` * * `{{location}}/{{security_gateway_id}}` * * When using the `pulumi import` command, SecurityGateway can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:beyondcorp/securityGateway:SecurityGateway default projects/{{project}}/locations/{{location}}/securityGateways/{{security_gateway_id}} * $ pulumi import gcp:beyondcorp/securityGateway:SecurityGateway default {{project}}/{{location}}/{{security_gateway_id}} * $ pulumi import gcp:beyondcorp/securityGateway:SecurityGateway default {{location}}/{{security_gateway_id}} * ``` */ export declare class SecurityGateway extends pulumi.CustomResource { /** * Get an existing SecurityGateway 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, state?: SecurityGatewayState, opts?: pulumi.CustomResourceOptions): SecurityGateway; /** * Returns true if the given object is an instance of SecurityGateway. 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 SecurityGateway; /** * Output only. Timestamp when the resource was created. */ readonly createTime: pulumi.Output; /** * Service account used for operations that involve resources in consumer projects. */ readonly delegatingServiceAccount: pulumi.Output; /** * 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; /** * Optional. An arbitrary user-provided name for the SecurityGateway. * Cannot exceed 64 characters. */ readonly displayName: pulumi.Output; /** * Output only. IP addresses that will be used for establishing * connection to the endpoints. */ readonly externalIps: pulumi.Output; /** * Optional. Map of Hubs that represents regional data path deployment with GCP region * as a key. * Structure is documented below. */ readonly hubs: pulumi.Output; /** * (Optional, Deprecated) * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. Must be omitted or set to `global`. * * > **Warning:** `location` is deprecated and will be removed in a future major release. * * @deprecated `location` is deprecated and will be removed in a future major release. */ readonly location: pulumi.Output; /** * Settings related to Cloud Logging. */ readonly logging: pulumi.Output; /** * Identifier. Name of the resource. */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Shared proxy configuration for all apps. * Structure is documented below. */ readonly proxyProtocolConfig: pulumi.Output; /** * Optional. User-settable SecurityGateway resource ID. * * Must start with a letter. * * Must contain between 4-63 characters from `/a-z-/`. * * Must end with a number or letter. */ readonly securityGatewayId: pulumi.Output; /** * Settings related to the Service Discovery. * Structure is documented below. */ readonly serviceDiscovery: pulumi.Output; /** * Output only. The operational state of the SecurityGateway. * Possible values: * STATE_UNSPECIFIED * CREATING * UPDATING * DELETING * RUNNING * DOWN * ERROR */ readonly state: pulumi.Output; /** * Output only. Timestamp when the resource was last modified. */ readonly updateTime: pulumi.Output; /** * Create a SecurityGateway 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: SecurityGatewayArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SecurityGateway resources. */ export interface SecurityGatewayState { /** * Output only. Timestamp when the resource was created. */ createTime?: pulumi.Input; /** * Service account used for operations that involve resources in consumer projects. */ delegatingServiceAccount?: pulumi.Input; /** * 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; /** * Optional. An arbitrary user-provided name for the SecurityGateway. * Cannot exceed 64 characters. */ displayName?: pulumi.Input; /** * Output only. IP addresses that will be used for establishing * connection to the endpoints. */ externalIps?: pulumi.Input[] | undefined>; /** * Optional. Map of Hubs that represents regional data path deployment with GCP region * as a key. * Structure is documented below. */ hubs?: pulumi.Input[] | undefined>; /** * (Optional, Deprecated) * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. Must be omitted or set to `global`. * * > **Warning:** `location` is deprecated and will be removed in a future major release. * * @deprecated `location` is deprecated and will be removed in a future major release. */ location?: pulumi.Input; /** * Settings related to Cloud Logging. */ logging?: pulumi.Input; /** * Identifier. Name of the resource. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Shared proxy configuration for all apps. * Structure is documented below. */ proxyProtocolConfig?: pulumi.Input; /** * Optional. User-settable SecurityGateway resource ID. * * Must start with a letter. * * Must contain between 4-63 characters from `/a-z-/`. * * Must end with a number or letter. */ securityGatewayId?: pulumi.Input; /** * Settings related to the Service Discovery. * Structure is documented below. */ serviceDiscovery?: pulumi.Input; /** * Output only. The operational state of the SecurityGateway. * Possible values: * STATE_UNSPECIFIED * CREATING * UPDATING * DELETING * RUNNING * DOWN * ERROR */ state?: pulumi.Input; /** * Output only. Timestamp when the resource was last modified. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a SecurityGateway resource. */ export interface SecurityGatewayArgs { /** * 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; /** * Optional. An arbitrary user-provided name for the SecurityGateway. * Cannot exceed 64 characters. */ displayName?: pulumi.Input; /** * Optional. Map of Hubs that represents regional data path deployment with GCP region * as a key. * Structure is documented below. */ hubs?: pulumi.Input[] | undefined>; /** * (Optional, Deprecated) * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. Must be omitted or set to `global`. * * > **Warning:** `location` is deprecated and will be removed in a future major release. * * @deprecated `location` is deprecated and will be removed in a future major release. */ location?: pulumi.Input; /** * Settings related to Cloud Logging. */ logging?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Shared proxy configuration for all apps. * Structure is documented below. */ proxyProtocolConfig?: pulumi.Input; /** * Optional. User-settable SecurityGateway resource ID. * * Must start with a letter. * * Must contain between 4-63 characters from `/a-z-/`. * * Must end with a number or letter. */ securityGatewayId: pulumi.Input; /** * Settings related to the Service Discovery. * Structure is documented below. */ serviceDiscovery?: pulumi.Input; } //# sourceMappingURL=securityGateway.d.ts.map