@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
323 lines • 12.1 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.OrganizationSecurityPolicyRule = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A rule for the OrganizationSecurityPolicy.
*
* To get more information about OrganizationSecurityPolicyRule, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/organizationSecurityPolicies/addRule)
* * How-to Guides
* * [Configure hierarchical security policies](https://docs.cloud.google.com/armor/docs/hierarchical-policies-using)
*
* ## Example Usage
*
* ### Organization Security Policy Rule Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* shortName: "tf-test_56730",
* parent: "organizations/123456789",
* type: "CLOUD_ARMOR",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "allow",
* match: {
* config: {
* srcIpRanges: ["192.168.0.0/16"],
* },
* versionedExpr: "SRC_IPS_V1",
* },
* priority: 100,
* });
* ```
* ### Organization Security Policy Rule Expression
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* shortName: "tf-test_95154",
* parent: "organizations/123456789",
* type: "CLOUD_ARMOR",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "allow",
* match: {
* expr: {
* expression: "request.path.contains('/folder/test/')",
* },
* versionedExpr: "",
* },
* priority: 100,
* });
* ```
* ### Organization Security Policy Rule With Preconfigured Waf Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* shortName: "tf-test_64336",
* parent: "organizations/123456789",
* type: "CLOUD_ARMOR",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "allow",
* match: {
* expr: {
* expression: "evaluatePreconfiguredWaf('sqli-stable', {'sensitivity': 2})",
* },
* versionedExpr: "",
* },
* preconfiguredWafConfig: {
* exclusions: [
* {
* requestHeaders: [{
* operator: "STARTS_WITH",
* value: "User-Agent",
* }],
* requestUris: [{
* operator: "CONTAINS",
* value: "/admin/",
* }],
* targetRuleSet: "sqli-stable",
* },
* {
* requestQueryParams: [{
* operator: "EQUALS",
* value: "user_input",
* }],
* targetRuleSet: "sqli-stable",
* },
* ],
* },
* priority: 100,
* });
* ```
* ### Organization Security Policy Rule With Header Action
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* shortName: "tf-test_34962",
* parent: "organizations/123456789",
* type: "CLOUD_ARMOR",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "allow",
* match: {
* expr: {
* expression: "request.path.contains('/login/')",
* },
* versionedExpr: "",
* },
* headerAction: {
* requestHeadersToAdds: [
* {
* headerName: "X-Forwarded-For",
* headerValue: "true",
* },
* {
* headerName: "X-Custom-Header",
* headerValue: "custom-value",
* },
* ],
* },
* priority: 100,
* });
* ```
* ### Organization Security Policy Rule With Redirect
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* shortName: "tf-test_74000",
* parent: "organizations/123456789",
* type: "CLOUD_ARMOR",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "redirect",
* match: {
* config: {
* srcIpRanges: ["10.0.1.0/24"],
* },
* versionedExpr: "SRC_IPS_V1",
* },
* redirectOptions: {
* type: "EXTERNAL_302",
* target: "https://www.example.com/blocked",
* },
* priority: 100,
* });
* ```
* ### Organization Security Policy Rule Firewall
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
* displayName: "tf-test",
* parent: "organizations/123456789",
* type: "FIREWALL",
* });
* const policyOrganizationSecurityPolicyRule = new gcp.compute.OrganizationSecurityPolicyRule("policy", {
* policyId: policy.id,
* action: "allow",
* direction: "INGRESS",
* enableLogging: true,
* match: {
* config: {
* srcIpRanges: [
* "192.168.0.0/16",
* "10.0.0.0/8",
* ],
* layer4Configs: [
* {
* ipProtocol: "tcp",
* ports: ["22"],
* },
* {
* ipProtocol: "icmp",
* },
* ],
* },
* },
* priority: 100,
* });
* ```
*
* ## Import
*
* OrganizationSecurityPolicyRule can be imported using any of these accepted formats:
*
* * `{{policy_id}}/priority/{{priority}}`
*
* When using the `pulumi import` command, OrganizationSecurityPolicyRule can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/organizationSecurityPolicyRule:OrganizationSecurityPolicyRule default {{policy_id}}/priority/{{priority}}
* ```
*/
class OrganizationSecurityPolicyRule extends pulumi.CustomResource {
/**
* Get an existing OrganizationSecurityPolicyRule 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, id, state, opts) {
return new OrganizationSecurityPolicyRule(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:compute/organizationSecurityPolicyRule:OrganizationSecurityPolicyRule';
/**
* Returns true if the given object is an instance of OrganizationSecurityPolicyRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === OrganizationSecurityPolicyRule.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["action"] = state?.action;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["direction"] = state?.direction;
resourceInputs["enableLogging"] = state?.enableLogging;
resourceInputs["headerAction"] = state?.headerAction;
resourceInputs["match"] = state?.match;
resourceInputs["policyId"] = state?.policyId;
resourceInputs["preconfiguredWafConfig"] = state?.preconfiguredWafConfig;
resourceInputs["preview"] = state?.preview;
resourceInputs["priority"] = state?.priority;
resourceInputs["redirectOptions"] = state?.redirectOptions;
resourceInputs["targetResources"] = state?.targetResources;
resourceInputs["targetServiceAccounts"] = state?.targetServiceAccounts;
}
else {
const args = argsOrState;
if (args?.action === undefined && !opts.urn) {
throw new Error("Missing required property 'action'");
}
if (args?.match === undefined && !opts.urn) {
throw new Error("Missing required property 'match'");
}
if (args?.policyId === undefined && !opts.urn) {
throw new Error("Missing required property 'policyId'");
}
if (args?.priority === undefined && !opts.urn) {
throw new Error("Missing required property 'priority'");
}
resourceInputs["action"] = args?.action;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["direction"] = args?.direction;
resourceInputs["enableLogging"] = args?.enableLogging;
resourceInputs["headerAction"] = args?.headerAction;
resourceInputs["match"] = args?.match;
resourceInputs["policyId"] = args?.policyId;
resourceInputs["preconfiguredWafConfig"] = args?.preconfiguredWafConfig;
resourceInputs["preview"] = args?.preview;
resourceInputs["priority"] = args?.priority;
resourceInputs["redirectOptions"] = args?.redirectOptions;
resourceInputs["targetResources"] = args?.targetResources;
resourceInputs["targetServiceAccounts"] = args?.targetServiceAccounts;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(OrganizationSecurityPolicyRule.__pulumiType, name, resourceInputs, opts);
}
}
exports.OrganizationSecurityPolicyRule = OrganizationSecurityPolicyRule;
//# sourceMappingURL=organizationSecurityPolicyRule.js.map