@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
229 lines • 9.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The Compute NetworkFirewallPolicyAssociation resource
*
* To get more information about RegionNetworkFirewallPolicyAssociation, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionNetworkFirewallPolicies/addAssociation)
*
* ## Example Usage
*
* ### Region Network Firewall Policy Association
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.RegionNetworkFirewallPolicy("policy", {
* name: "my-policy",
* project: "my-project-name",
* description: "Sample global network firewall policy",
* region: "us-west1",
* });
* const network = new gcp.compute.Network("network", {
* name: "my-network",
* autoCreateSubnetworks: false,
* });
* const _default = new gcp.compute.RegionNetworkFirewallPolicyAssociation("default", {
* name: "my-association",
* project: "my-project-name",
* attachmentTarget: network.id,
* firewallPolicy: policy.id,
* region: "us-west1",
* });
* ```
* ### Region Network Firewall Policy Association Priority
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policy = new gcp.compute.RegionNetworkFirewallPolicy("policy", {
* name: "my-policy",
* project: "my-project-name",
* description: "Sample global network firewall policy",
* region: "us-west1",
* });
* const network = new gcp.compute.Network("network", {
* name: "my-network",
* autoCreateSubnetworks: false,
* });
* const association = new gcp.compute.RegionNetworkFirewallPolicyAssociation("association", {
* name: "my-association",
* project: "my-project-name",
* attachmentTarget: network.id,
* firewallPolicy: policy.id,
* region: "us-west1",
* priority: 1,
* });
* ```
*
* ## Import
*
* RegionNetworkFirewallPolicyAssociation can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/firewallPolicies/{{firewall_policy}}/associations/{{name}}`
* * `{{project}}/{{region}}/{{firewall_policy}}/{{name}}`
* * `{{region}}/{{firewall_policy}}/{{name}}`
* * `{{project}}/{{firewall_policy}}/{{name}}`
* * `{{firewall_policy}}/{{name}}`
*
* When using the `pulumi import` command, RegionNetworkFirewallPolicyAssociation can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionNetworkFirewallPolicyAssociation:RegionNetworkFirewallPolicyAssociation default projects/{{project}}/regions/{{region}}/firewallPolicies/{{firewall_policy}}/associations/{{name}}
* $ pulumi import gcp:compute/regionNetworkFirewallPolicyAssociation:RegionNetworkFirewallPolicyAssociation default {{project}}/{{region}}/{{firewall_policy}}/{{name}}
* $ pulumi import gcp:compute/regionNetworkFirewallPolicyAssociation:RegionNetworkFirewallPolicyAssociation default {{region}}/{{firewall_policy}}/{{name}}
* $ pulumi import gcp:compute/regionNetworkFirewallPolicyAssociation:RegionNetworkFirewallPolicyAssociation default {{project}}/{{firewall_policy}}/{{name}}
* $ pulumi import gcp:compute/regionNetworkFirewallPolicyAssociation:RegionNetworkFirewallPolicyAssociation default {{firewall_policy}}/{{name}}
* ```
*/
export declare class RegionNetworkFirewallPolicyAssociation extends pulumi.CustomResource {
/**
* Get an existing RegionNetworkFirewallPolicyAssociation 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?: RegionNetworkFirewallPolicyAssociationState, opts?: pulumi.CustomResourceOptions): RegionNetworkFirewallPolicyAssociation;
/**
* Returns true if the given object is an instance of RegionNetworkFirewallPolicyAssociation. 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 RegionNetworkFirewallPolicyAssociation;
/**
* The target that the firewall policy is attached to.
*/
readonly attachmentTarget: 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>;
/**
* The firewall policy of the resource.
*/
readonly firewallPolicy: pulumi.Output<string>;
/**
* The name for an association.
*/
readonly name: pulumi.Output<string>;
/**
* (Optional, Beta)
* An integer indicating the priority of an association.
*/
readonly priority: pulumi.Output<number>;
/**
* 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>;
/**
* The location of this resource.
*/
readonly region: pulumi.Output<string>;
/**
* The short name of the firewall policy of the association.
*/
readonly shortName: pulumi.Output<string>;
/**
* Create a RegionNetworkFirewallPolicyAssociation 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: RegionNetworkFirewallPolicyAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionNetworkFirewallPolicyAssociation resources.
*/
export interface RegionNetworkFirewallPolicyAssociationState {
/**
* The target that the firewall policy is attached to.
*/
attachmentTarget?: 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>;
/**
* The firewall policy of the resource.
*/
firewallPolicy?: pulumi.Input<string | undefined>;
/**
* The name for an association.
*/
name?: pulumi.Input<string | undefined>;
/**
* (Optional, Beta)
* An integer indicating the priority of an association.
*/
priority?: pulumi.Input<number | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The location of this resource.
*/
region?: pulumi.Input<string | undefined>;
/**
* The short name of the firewall policy of the association.
*/
shortName?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a RegionNetworkFirewallPolicyAssociation resource.
*/
export interface RegionNetworkFirewallPolicyAssociationArgs {
/**
* The target that the firewall policy is attached to.
*/
attachmentTarget: pulumi.Input<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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The firewall policy of the resource.
*/
firewallPolicy: pulumi.Input<string>;
/**
* The name for an association.
*/
name?: pulumi.Input<string | undefined>;
/**
* (Optional, Beta)
* An integer indicating the priority of an association.
*/
priority?: pulumi.Input<number | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The location of this resource.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=regionNetworkFirewallPolicyAssociation.d.ts.map