@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
312 lines • 12.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A Firewall endpoint is a Cloud Firewall resource that enables
* layer 7 advanced protection capabilities, such as intrusion prevention,
* in your network.
*
* To get more information about FirewallEndpoint, see:
*
* * [API documentation](https://cloud.google.com/firewall/docs/reference/network-security/rest/v1/organizations.locations.firewallEndpoints)
* * How-to Guides
* * [Create and associate firewall endpoints](https://cloud.google.com/firewall/docs/configure-firewall-endpoints)
* * [Firewall endpoint overview](https://cloud.google.com/firewall/docs/about-firewall-endpoints)
*
* > **Warning:** If you are using User ADCs (Application Default Credentials) with this resource,
* you must specify a `billingProjectId` and set `userProjectOverride` to true
* in the provider configuration. Otherwise the ACM API will return a 403 error.
* Your account must have the `serviceusage.services.use` permission on the
* `billingProjectId` you defined.
*
* ## Example Usage
*
* ### Network Security Firewall Endpoint Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.FirewallEndpoint("default", {
* name: "my-firewall-endpoint",
* parent: "organizations/123456789",
* location: "us-central1-a",
* billingProjectId: "my-project-name",
* labels: {
* foo: "bar",
* },
* });
* ```
* ### Network Security Firewall Endpoint Project
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.FirewallEndpoint("default", {
* name: "my-firewall-endpoint",
* parent: "projects/my-project-name",
* location: "us-central1-a",
* labels: {
* foo: "bar",
* },
* });
* ```
*
* ## Import
*
* FirewallEndpoint can be imported using any of these accepted formats:
*
* * `{{parent}}/locations/{{location}}/firewallEndpoints/{{name}}`
*
* When using the `pulumi import` command, FirewallEndpoint can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/firewallEndpoint:FirewallEndpoint default {{parent}}/locations/{{location}}/firewallEndpoints/{{name}}
* ```
*/
export declare class FirewallEndpoint extends pulumi.CustomResource {
/**
* Get an existing FirewallEndpoint 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?: FirewallEndpointState, opts?: pulumi.CustomResourceOptions): FirewallEndpoint;
/**
* Returns true if the given object is an instance of FirewallEndpoint. 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 FirewallEndpoint;
/**
* List of networks that are associated with this endpoint in the local zone.
* This is a projection of the FirewallEndpointAssociations pointing at this
* endpoint. A network will only appear in this list after traffic routing is
* fully configured. Format: projects/{project}/global/networks/{name}.
*/
readonly associatedNetworks: pulumi.Output<string[]>;
/**
* Project to charge for the deployed firewall endpoint.
* This field is required for organization-scoped endpoints.
* For project-scoped endpoints, it is optional but must match the
* endpoint's project if specified.
*/
readonly billingProjectId: pulumi.Output<string>;
/**
* Time the firewall endpoint was created in UTC.
*/
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>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Settings for the endpoint.
* Structure is documented below.
*/
readonly endpointSettings: pulumi.Output<outputs.networksecurity.FirewallEndpointEndpointSettings | undefined>;
/**
* A map of key/value label pairs to assign to the resource.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The location (zone) of the firewall endpoint.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the firewall endpoint resource.
*/
readonly name: pulumi.Output<string>;
/**
* The name of the parent this firewall endpoint belongs to.
* Format: `organizations/{organization_id}` or `projects/{project_id}`.
*/
readonly parent: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Whether reconciling is in progress, recommended per https://google.aip.dev/128.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* Server-defined URL of this resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* The current state of the endpoint.
*/
readonly state: pulumi.Output<string>;
/**
* Time the firewall endpoint was updated in UTC.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a FirewallEndpoint 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: FirewallEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FirewallEndpoint resources.
*/
export interface FirewallEndpointState {
/**
* List of networks that are associated with this endpoint in the local zone.
* This is a projection of the FirewallEndpointAssociations pointing at this
* endpoint. A network will only appear in this list after traffic routing is
* fully configured. Format: projects/{project}/global/networks/{name}.
*/
associatedNetworks?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Project to charge for the deployed firewall endpoint.
* This field is required for organization-scoped endpoints.
* For project-scoped endpoints, it is optional but must match the
* endpoint's project if specified.
*/
billingProjectId?: pulumi.Input<string | undefined>;
/**
* Time the firewall endpoint was created in UTC.
*/
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>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Settings for the endpoint.
* Structure is documented below.
*/
endpointSettings?: pulumi.Input<inputs.networksecurity.FirewallEndpointEndpointSettings | undefined>;
/**
* A map of key/value label pairs to assign to the resource.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location (zone) of the firewall endpoint.
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the firewall endpoint resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* The name of the parent this firewall endpoint belongs to.
* Format: `organizations/{organization_id}` or `projects/{project_id}`.
*/
parent?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Whether reconciling is in progress, recommended per https://google.aip.dev/128.
*/
reconciling?: pulumi.Input<boolean | undefined>;
/**
* Server-defined URL of this resource.
*/
selfLink?: pulumi.Input<string | undefined>;
/**
* The current state of the endpoint.
*/
state?: pulumi.Input<string | undefined>;
/**
* Time the firewall endpoint was updated in UTC.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a FirewallEndpoint resource.
*/
export interface FirewallEndpointArgs {
/**
* Project to charge for the deployed firewall endpoint.
* This field is required for organization-scoped endpoints.
* For project-scoped endpoints, it is optional but must match the
* endpoint's project if specified.
*/
billingProjectId?: 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>;
/**
* Settings for the endpoint.
* Structure is documented below.
*/
endpointSettings?: pulumi.Input<inputs.networksecurity.FirewallEndpointEndpointSettings | undefined>;
/**
* A map of key/value label pairs to assign to the resource.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location (zone) of the firewall endpoint.
*/
location: pulumi.Input<string>;
/**
* The name of the firewall endpoint resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* The name of the parent this firewall endpoint belongs to.
* Format: `organizations/{organization_id}` or `projects/{project_id}`.
*/
parent: pulumi.Input<string>;
}
//# sourceMappingURL=firewallEndpoint.d.ts.map