@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
245 lines (244 loc) • 8.91 kB
TypeScript
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",
* }],
* });
* ```
*
* ## 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}}
* ```
*
* ```sh
* $ pulumi import gcp:beyondcorp/securityGateway:SecurityGateway default {{project}}/{{location}}/{{security_gateway_id}}
* ```
*
* ```sh
* $ 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<pulumi.ID>, 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<string>;
/**
* Service account used for operations that involve resources in consumer projects.
*/
readonly delegatingServiceAccount: pulumi.Output<string>;
/**
* Optional. An arbitrary user-provided name for the SecurityGateway.
* Cannot exceed 64 characters.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Output only. IP addresses that will be used for establishing
* connection to the endpoints.
*/
readonly externalIps: pulumi.Output<string[]>;
/**
* Optional. Map of Hubs that represents regional data path deployment with GCP region
* as a key.
* Structure is documented below.
*/
readonly hubs: pulumi.Output<outputs.beyondcorp.SecurityGatewayHub[] | 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.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Identifier. Name of the resource.
*/
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>;
/**
* 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<string>;
/**
* Output only. The operational state of the SecurityGateway.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* UPDATING
* DELETING
* RUNNING
* DOWN
* ERROR
*/
readonly state: pulumi.Output<string>;
/**
* Output only. Timestamp when the resource was last modified.
*/
readonly updateTime: pulumi.Output<string>;
/**
* 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<string>;
/**
* Service account used for operations that involve resources in consumer projects.
*/
delegatingServiceAccount?: pulumi.Input<string>;
/**
* Optional. An arbitrary user-provided name for the SecurityGateway.
* Cannot exceed 64 characters.
*/
displayName?: pulumi.Input<string>;
/**
* Output only. IP addresses that will be used for establishing
* connection to the endpoints.
*/
externalIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Optional. Map of Hubs that represents regional data path deployment with GCP region
* as a key.
* Structure is documented below.
*/
hubs?: pulumi.Input<pulumi.Input<inputs.beyondcorp.SecurityGatewayHub>[]>;
/**
* (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<string>;
/**
* Identifier. Name of the resource.
*/
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>;
/**
* 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<string>;
/**
* Output only. The operational state of the SecurityGateway.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* UPDATING
* DELETING
* RUNNING
* DOWN
* ERROR
*/
state?: pulumi.Input<string>;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SecurityGateway resource.
*/
export interface SecurityGatewayArgs {
/**
* Optional. An arbitrary user-provided name for the SecurityGateway.
* Cannot exceed 64 characters.
*/
displayName?: pulumi.Input<string>;
/**
* Optional. Map of Hubs that represents regional data path deployment with GCP region
* as a key.
* Structure is documented below.
*/
hubs?: pulumi.Input<pulumi.Input<inputs.beyondcorp.SecurityGatewayHub>[]>;
/**
* (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<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>;
/**
* 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<string>;
}