@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
201 lines (200 loc) • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns.
*
* To get more information about UrlLists, see:
*
* * [API documentation](https://cloud.google.com/secure-web-proxy/docs/reference/network-security/rest/v1/projects.locations.urlLists)
* * How-to Guides
* * Use UrlLists
*
* ## Example Usage
*
* ### Network Security Url Lists Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.UrlList("default", {
* name: "my-url-lists",
* location: "us-central1",
* values: ["www.example.com"],
* });
* ```
* ### Network Security Url Lists Advanced
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.UrlList("default", {
* name: "my-url-lists",
* location: "us-central1",
* description: "my description",
* values: [
* "www.example.com",
* "about.example.com",
* "github.com/example-org/*",
* ],
* });
* ```
*
* ## Import
*
* UrlLists can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/urlLists/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, UrlLists can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/urlList:UrlList default projects/{{project}}/locations/{{location}}/urlLists/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:networksecurity/urlList:UrlList default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:networksecurity/urlList:UrlList default {{location}}/{{name}}
* ```
*/
export declare class UrlList extends pulumi.CustomResource {
/**
* Get an existing UrlList 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?: UrlListState, opts?: pulumi.CustomResourceOptions): UrlList;
/**
* Returns true if the given object is an instance of UrlList. 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 UrlList;
/**
* Output only. Time when the security policy 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>;
/**
* The location of the url lists.
*
*
* - - -
*/
readonly location: pulumi.Output<string>;
/**
* Short name of the UrlList resource to be created.
* This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. 'urlList'.
*/
readonly name: pulumi.Output<string>;
/**
* 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>;
/**
* Output only. Time when the security policy 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>;
/**
* FQDNs and URLs.
*/
readonly values: pulumi.Output<string[]>;
/**
* Create a UrlList 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: UrlListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UrlList resources.
*/
export interface UrlListState {
/**
* Output only. Time when the security policy 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>;
/**
* The location of the url lists.
*
*
* - - -
*/
location?: pulumi.Input<string>;
/**
* Short name of the UrlList resource to be created.
* This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. 'urlList'.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Output only. Time when the security policy 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>;
/**
* FQDNs and URLs.
*/
values?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a UrlList resource.
*/
export interface UrlListArgs {
/**
* Free-text description of the resource.
*/
description?: pulumi.Input<string>;
/**
* The location of the url lists.
*
*
* - - -
*/
location: pulumi.Input<string>;
/**
* Short name of the UrlList resource to be created.
* This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. 'urlList'.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* FQDNs and URLs.
*/
values: pulumi.Input<pulumi.Input<string>[]>;
}