@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
185 lines (184 loc) • 6.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A single firewall rule that is evaluated against incoming traffic
* and provides an action to take on matched requests.
*
* To get more information about FirewallRule, see:
*
* * [API documentation](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.firewall.ingressRules)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/appengine/docs/standard/python/creating-firewalls#creating_firewall_rules)
*
* ## Example Usage
*
* ### App Engine Firewall Rule Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myProject = new gcp.organizations.Project("my_project", {
* name: "tf-test-project",
* projectId: "ae-project",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* const app = new gcp.appengine.Application("app", {
* project: myProject.projectId,
* locationId: "us-central",
* });
* const rule = new gcp.appengine.FirewallRule("rule", {
* project: app.project,
* priority: 1000,
* action: "ALLOW",
* sourceRange: "*",
* });
* ```
*
* ## Import
*
* FirewallRule can be imported using any of these accepted formats:
*
* * `apps/{{project}}/firewall/ingressRules/{{priority}}`
*
* * `{{project}}/{{priority}}`
*
* * `{{priority}}`
*
* When using the `pulumi import` command, FirewallRule can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:appengine/firewallRule:FirewallRule default apps/{{project}}/firewall/ingressRules/{{priority}}
* ```
*
* ```sh
* $ pulumi import gcp:appengine/firewallRule:FirewallRule default {{project}}/{{priority}}
* ```
*
* ```sh
* $ pulumi import gcp:appengine/firewallRule:FirewallRule default {{priority}}
* ```
*/
export declare class FirewallRule extends pulumi.CustomResource {
/**
* Get an existing FirewallRule 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?: FirewallRuleState, opts?: pulumi.CustomResourceOptions): FirewallRule;
/**
* Returns true if the given object is an instance of FirewallRule. 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 FirewallRule;
/**
* The action to take if this rule matches.
* Possible values are: `UNSPECIFIED_ACTION`, `ALLOW`, `DENY`.
*
*
* - - -
*/
readonly action: pulumi.Output<string>;
/**
* An optional string description of this rule.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* A positive integer that defines the order of rule evaluation.
* Rules with the lowest priority are evaluated first.
* A default rule at priority Int32.MaxValue matches all IPv4 and
* IPv6 traffic when no previous rule matches. Only the action of
* this rule can be modified by the user.
*/
readonly priority: pulumi.Output<number | undefined>;
/**
* 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>;
/**
* IP address or range, defined using CIDR notation, of requests that this rule applies to.
*/
readonly sourceRange: pulumi.Output<string>;
/**
* Create a FirewallRule 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: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FirewallRule resources.
*/
export interface FirewallRuleState {
/**
* The action to take if this rule matches.
* Possible values are: `UNSPECIFIED_ACTION`, `ALLOW`, `DENY`.
*
*
* - - -
*/
action?: pulumi.Input<string>;
/**
* An optional string description of this rule.
*/
description?: pulumi.Input<string>;
/**
* A positive integer that defines the order of rule evaluation.
* Rules with the lowest priority are evaluated first.
* A default rule at priority Int32.MaxValue matches all IPv4 and
* IPv6 traffic when no previous rule matches. Only the action of
* this rule can be modified by the user.
*/
priority?: pulumi.Input<number>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* IP address or range, defined using CIDR notation, of requests that this rule applies to.
*/
sourceRange?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FirewallRule resource.
*/
export interface FirewallRuleArgs {
/**
* The action to take if this rule matches.
* Possible values are: `UNSPECIFIED_ACTION`, `ALLOW`, `DENY`.
*
*
* - - -
*/
action: pulumi.Input<string>;
/**
* An optional string description of this rule.
*/
description?: pulumi.Input<string>;
/**
* A positive integer that defines the order of rule evaluation.
* Rules with the lowest priority are evaluated first.
* A default rule at priority Int32.MaxValue matches all IPv4 and
* IPv6 traffic when no previous rule matches. Only the action of
* this rule can be modified by the user.
*/
priority?: pulumi.Input<number>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* IP address or range, defined using CIDR notation, of requests that this rule applies to.
*/
sourceRange: pulumi.Input<string>;
}