@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
317 lines (316 loc) • 11.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.
*
* To get more information about AddressGroup, see:
*
* * [API documentation](https://cloud.google.com/traffic-director/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups)
* * How-to Guides
* * [Use AddressGroups](https://cloud.google.com/vpc/docs/use-address-groups-firewall-policies)
*
* ## Example Usage
*
* ### Network Security Address Groups Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.AddressGroup("default", {
* name: "my-address-groups",
* parent: "projects/my-project-name",
* location: "us-central1",
* type: "IPV4",
* capacity: 100,
* items: ["208.80.154.224/32"],
* });
* ```
* ### Network Security Address Groups Organization Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.AddressGroup("default", {
* name: "my-address-groups",
* parent: "organizations/123456789",
* location: "us-central1",
* type: "IPV4",
* capacity: 100,
* items: ["208.80.154.224/32"],
* });
* ```
* ### Network Security Address Groups Advanced
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.AddressGroup("default", {
* name: "my-address-groups",
* parent: "projects/my-project-name",
* location: "us-central1",
* description: "my description",
* type: "IPV4",
* capacity: 100,
* items: ["208.80.154.224/32"],
* });
* ```
* ### Network Security Address Groups Cloud Armor
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.AddressGroup("default", {
* name: "my-address-groups",
* parent: "projects/my-project-name",
* location: "global",
* type: "IPV4",
* capacity: 100,
* purposes: ["CLOUD_ARMOR"],
* items: ["208.80.154.224/32"],
* });
* ```
*
* ## Import
*
* AddressGroup can be imported using any of these accepted formats:
*
* * `{{parent}}/locations/{{location}}/addressGroups/{{name}}`
*
* When using the `pulumi import` command, AddressGroup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/addressGroup:AddressGroup default {{parent}}/locations/{{location}}/addressGroups/{{name}}
* ```
*/
export declare class AddressGroup extends pulumi.CustomResource {
/**
* Get an existing AddressGroup 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?: AddressGroupState, opts?: pulumi.CustomResourceOptions): AddressGroup;
/**
* Returns true if the given object is an instance of AddressGroup. 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 AddressGroup;
/**
* Capacity of the Address Group.
*/
readonly capacity: pulumi.Output<number>;
/**
* The timestamp when the resource was created.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
* Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
*/
readonly createTime: pulumi.Output<string>;
/**
* Free-text description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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;
}>;
/**
* List of items.
*/
readonly items: pulumi.Output<string[] | undefined>;
/**
* Set of label tags associated with the AddressGroup resource.
* An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **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 of the gateway security policy.
* The default value is `global`.
*
*
* - - -
*/
readonly location: pulumi.Output<string>;
/**
* Name of the AddressGroup resource.
*/
readonly name: pulumi.Output<string>;
/**
* The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
*/
readonly parent: pulumi.Output<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* List of supported purposes of the Address Group.
* Each value may be one of: `DEFAULT`, `CLOUD_ARMOR`.
*/
readonly purposes: pulumi.Output<string[]>;
/**
* The type of the Address Group. Possible values are "IPV4" or "IPV6".
* Possible values are: `IPV4`, `IPV6`.
*/
readonly type: pulumi.Output<string>;
/**
* The timestamp when the resource was updated.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
* Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a AddressGroup 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: AddressGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AddressGroup resources.
*/
export interface AddressGroupState {
/**
* Capacity of the Address Group.
*/
capacity?: pulumi.Input<number>;
/**
* The timestamp when the resource was created.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
* Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
*/
createTime?: pulumi.Input<string>;
/**
* Free-text description of the resource.
*/
description?: pulumi.Input<string>;
/**
* 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>;
}>;
/**
* List of items.
*/
items?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Set of label tags associated with the AddressGroup resource.
* An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **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>;
}>;
/**
* The location of the gateway security policy.
* The default value is `global`.
*
*
* - - -
*/
location?: pulumi.Input<string>;
/**
* Name of the AddressGroup resource.
*/
name?: pulumi.Input<string>;
/**
* The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
*/
parent?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* List of supported purposes of the Address Group.
* Each value may be one of: `DEFAULT`, `CLOUD_ARMOR`.
*/
purposes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the Address Group. Possible values are "IPV4" or "IPV6".
* Possible values are: `IPV4`, `IPV6`.
*/
type?: pulumi.Input<string>;
/**
* The timestamp when the resource was updated.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
* Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AddressGroup resource.
*/
export interface AddressGroupArgs {
/**
* Capacity of the Address Group.
*/
capacity: pulumi.Input<number>;
/**
* Free-text description of the resource.
*/
description?: pulumi.Input<string>;
/**
* List of items.
*/
items?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Set of label tags associated with the AddressGroup resource.
* An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **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>;
}>;
/**
* The location of the gateway security policy.
* The default value is `global`.
*
*
* - - -
*/
location: pulumi.Input<string>;
/**
* Name of the AddressGroup resource.
*/
name?: pulumi.Input<string>;
/**
* The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
*/
parent?: pulumi.Input<string>;
/**
* List of supported purposes of the Address Group.
* Each value may be one of: `DEFAULT`, `CLOUD_ARMOR`.
*/
purposes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the Address Group. Possible values are "IPV4" or "IPV6".
* Possible values are: `IPV4`, `IPV6`.
*/
type: pulumi.Input<string>;
}