UrlList class

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
How-to Guides
Use UrlLists

Example Usage

Network Security Url Lists Basic

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"],
});

import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.UrlList("default",
    name="my-url-lists",
    location="us-central1",
    values=["www.example.com"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.NetworkSecurity.UrlList("default", new()
    {
        Name = "my-url-lists",
        Location = "us-central1",
        Values = new[]
        {
            "www.example.com",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewUrlList(ctx, "default", &networksecurity.UrlListArgs{
			Name:     pulumi.String("my-url-lists"),
			Location: pulumi.String("us-central1"),
			Values: pulumi.StringArray{
				pulumi.String("www.example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_networksecurity_urllist" "default" {
  name     = "my-url-lists"
  location = "us-central1"
  values   = ["www.example.com"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.UrlList;
import com.pulumi.gcp.networksecurity.UrlListArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new UrlList("default", UrlListArgs.builder()
            .name("my-url-lists")
            .location("us-central1")
            .values("www.example.com")
            .build());

    }
}

resources:
  default:
    type: gcp:networksecurity:UrlList
    properties:
      name: my-url-lists
      location: us-central1
      values:
        - www.example.com

Network Security Url Lists Advanced

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 pulumi
import pulumi_gcp as gcp

default = 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/*",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.NetworkSecurity.UrlList("default", new()
    {
        Name = "my-url-lists",
        Location = "us-central1",
        Description = "my description",
        Values = new[]
        {
            "www.example.com",
            "about.example.com",
            "github.com/example-org/*",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewUrlList(ctx, "default", &networksecurity.UrlListArgs{
			Name:        pulumi.String("my-url-lists"),
			Location:    pulumi.String("us-central1"),
			Description: pulumi.String("my description"),
			Values: pulumi.StringArray{
				pulumi.String("www.example.com"),
				pulumi.String("about.example.com"),
				pulumi.String("github.com/example-org/*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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/*"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.UrlList;
import com.pulumi.gcp.networksecurity.UrlListArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new UrlList("default", UrlListArgs.builder()
            .name("my-url-lists")
            .location("us-central1")
            .description("my description")
            .values(
                "www.example.com",
                "about.example.com",
                "github.com/example-org/*")
            .build());

    }
}

resources:
  default:
    type: gcp:networksecurity:UrlList
    properties:
      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:

$ pulumi import gcp:networksecurity/urlList:UrlList default projects/{{project}}/locations/{{location}}/urlLists/{{name}}
$ pulumi import gcp:networksecurity/urlList:UrlList default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:networksecurity/urlList:UrlList default {{location}}/{{name}}

Constructors

UrlList(String name, {UrlListArgs? args, CustomResourceOptions? options}): Creates a new UrlList. name The Pulumi resource name. args Arguments used to configure this UrlList. The set of arguments for UrlList. options Resource options controlling this resource's behavior.
UrlList.reference(String urn): Creates a typed reference to an existing UrlList resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: 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'
latefinal
deletionPolicy ↔ 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.
latefinal
description ↔ Output<String?>: Free-text description of the resource.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The location of the url lists.
latefinal
name ↔ 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'.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ 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'.
latefinal
urn ↔ Output<String>: latefinalinherited
values ↔ Output<List<String>>: FQDNs and URLs.
latefinal

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {UrlListState? state, CustomResourceOptions? options}) → UrlList: Gets an existing UrlList resource's state with the given name and id.