Google Cloud v8.25.1, Apr 9 25

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

gcp.compute.PublicDelegatedPrefix

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-gcp

Example Usage
Public Delegated Prefixes Basic
Public Delegated Prefixes Ipv6
Public Delegated Prefix Ipv6 Subnet Mode
Create PublicDelegatedPrefix Resource
Constructor syntax
Constructor example
PublicDelegatedPrefix Resource Properties
Inputs
Outputs
Look up Existing PublicDelegatedPrefix Resource
Import
Package Details

Request a Change

Represents a PublicDelegatedPrefix for use with bring your own IP addresses (BYOIP).

To get more information about PublicDelegatedPrefix, see:

API documentation
How-to Guides
- Using bring your own IP

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const advertised = new gcp.compute.PublicAdvertisedPrefix("advertised", {
    name: "my-prefix",
    description: "description",
    dnsVerificationIp: "127.127.0.0",
    ipCidrRange: "127.127.0.0/16",
});
const prefixes = new gcp.compute.PublicDelegatedPrefix("prefixes", {
    name: "my-prefix",
    region: "us-central1",
    description: "my description",
    ipCidrRange: "127.127.0.0/24",
    parentPrefix: advertised.id,
});

import pulumi
import pulumi_gcp as gcp

advertised = gcp.compute.PublicAdvertisedPrefix("advertised",
    name="my-prefix",
    description="description",
    dns_verification_ip="127.127.0.0",
    ip_cidr_range="127.127.0.0/16")
prefixes = gcp.compute.PublicDelegatedPrefix("prefixes",
    name="my-prefix",
    region="us-central1",
    description="my description",
    ip_cidr_range="127.127.0.0/24",
    parent_prefix=advertised.id)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		advertised, err := compute.NewPublicAdvertisedPrefix(ctx, "advertised", &compute.PublicAdvertisedPrefixArgs{
			Name:              pulumi.String("my-prefix"),
			Description:       pulumi.String("description"),
			DnsVerificationIp: pulumi.String("127.127.0.0"),
			IpCidrRange:       pulumi.String("127.127.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewPublicDelegatedPrefix(ctx, "prefixes", &compute.PublicDelegatedPrefixArgs{
			Name:         pulumi.String("my-prefix"),
			Region:       pulumi.String("us-central1"),
			Description:  pulumi.String("my description"),
			IpCidrRange:  pulumi.String("127.127.0.0/24"),
			ParentPrefix: advertised.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var advertised = new Gcp.Compute.PublicAdvertisedPrefix("advertised", new()
    {
        Name = "my-prefix",
        Description = "description",
        DnsVerificationIp = "127.127.0.0",
        IpCidrRange = "127.127.0.0/16",
    });

    var prefixes = new Gcp.Compute.PublicDelegatedPrefix("prefixes", new()
    {
        Name = "my-prefix",
        Region = "us-central1",
        Description = "my description",
        IpCidrRange = "127.127.0.0/24",
        ParentPrefix = advertised.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.PublicAdvertisedPrefix;
import com.pulumi.gcp.compute.PublicAdvertisedPrefixArgs;
import com.pulumi.gcp.compute.PublicDelegatedPrefix;
import com.pulumi.gcp.compute.PublicDelegatedPrefixArgs;
import java.util.List;
import java.util.ArrayList;
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 advertised = new PublicAdvertisedPrefix("advertised", PublicAdvertisedPrefixArgs.builder()
            .name("my-prefix")
            .description("description")
            .dnsVerificationIp("127.127.0.0")
            .ipCidrRange("127.127.0.0/16")
            .build());

        var prefixes = new PublicDelegatedPrefix("prefixes", PublicDelegatedPrefixArgs.builder()
            .name("my-prefix")
            .region("us-central1")
            .description("my description")
            .ipCidrRange("127.127.0.0/24")
            .parentPrefix(advertised.id())
            .build());

    }
}

resources:
  advertised:
    type: gcp:compute:PublicAdvertisedPrefix
    properties:
      name: my-prefix
      description: description
      dnsVerificationIp: 127.127.0.0
      ipCidrRange: 127.127.0.0/16
  prefixes:
    type: gcp:compute:PublicDelegatedPrefix
    properties:
      name: my-prefix
      region: us-central1
      description: my description
      ipCidrRange: 127.127.0.0/24
      parentPrefix: ${advertised.id}

Public Delegated Prefixes Ipv6

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const advertised = new gcp.compute.PublicAdvertisedPrefix("advertised", {
    name: "ipv6-pap",
    description: "description",
    dnsVerificationIp: "2001:db8::",
    ipCidrRange: "2001:db8::/32",
    pdpScope: "REGIONAL",
});
const prefix = new gcp.compute.PublicDelegatedPrefix("prefix", {
    name: "ipv6-root-pdp",
    description: "test-delegation-mode-pdp",
    region: "us-west1",
    ipCidrRange: "2001:db8::/40",
    parentPrefix: advertised.id,
    mode: "DELEGATION",
});
const subprefix = new gcp.compute.PublicDelegatedPrefix("subprefix", {
    name: "ipv6-sub-pdp",
    description: "test-forwarding-rule-mode-pdp",
    region: "us-west1",
    ipCidrRange: "2001:db8::/48",
    parentPrefix: prefix.id,
    allocatablePrefixLength: 64,
    mode: "EXTERNAL_IPV6_FORWARDING_RULE_CREATION",
});

import pulumi
import pulumi_gcp as gcp

advertised = gcp.compute.PublicAdvertisedPrefix("advertised",
    name="ipv6-pap",
    description="description",
    dns_verification_ip="2001:db8::",
    ip_cidr_range="2001:db8::/32",
    pdp_scope="REGIONAL")
prefix = gcp.compute.PublicDelegatedPrefix("prefix",
    name="ipv6-root-pdp",
    description="test-delegation-mode-pdp",
    region="us-west1",
    ip_cidr_range="2001:db8::/40",
    parent_prefix=advertised.id,
    mode="DELEGATION")
subprefix = gcp.compute.PublicDelegatedPrefix("subprefix",
    name="ipv6-sub-pdp",
    description="test-forwarding-rule-mode-pdp",
    region="us-west1",
    ip_cidr_range="2001:db8::/48",
    parent_prefix=prefix.id,
    allocatable_prefix_length=64,
    mode="EXTERNAL_IPV6_FORWARDING_RULE_CREATION")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		advertised, err := compute.NewPublicAdvertisedPrefix(ctx, "advertised", &compute.PublicAdvertisedPrefixArgs{
			Name:              pulumi.String("ipv6-pap"),
			Description:       pulumi.String("description"),
			DnsVerificationIp: pulumi.String("2001:db8::"),
			IpCidrRange:       pulumi.String("2001:db8::/32"),
			PdpScope:          pulumi.String("REGIONAL"),
		})
		if err != nil {
			return err
		}
		prefix, err := compute.NewPublicDelegatedPrefix(ctx, "prefix", &compute.PublicDelegatedPrefixArgs{
			Name:         pulumi.String("ipv6-root-pdp"),
			Description:  pulumi.String("test-delegation-mode-pdp"),
			Region:       pulumi.String("us-west1"),
			IpCidrRange:  pulumi.String("2001:db8::/40"),
			ParentPrefix: advertised.ID(),
			Mode:         pulumi.String("DELEGATION"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewPublicDelegatedPrefix(ctx, "subprefix", &compute.PublicDelegatedPrefixArgs{
			Name:                    pulumi.String("ipv6-sub-pdp"),
			Description:             pulumi.String("test-forwarding-rule-mode-pdp"),
			Region:                  pulumi.String("us-west1"),
			IpCidrRange:             pulumi.String("2001:db8::/48"),
			ParentPrefix:            prefix.ID(),
			AllocatablePrefixLength: pulumi.Int(64),
			Mode:                    pulumi.String("EXTERNAL_IPV6_FORWARDING_RULE_CREATION"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var advertised = new Gcp.Compute.PublicAdvertisedPrefix("advertised", new()
    {
        Name = "ipv6-pap",
        Description = "description",
        DnsVerificationIp = "2001:db8::",
        IpCidrRange = "2001:db8::/32",
        PdpScope = "REGIONAL",
    });

    var prefix = new Gcp.Compute.PublicDelegatedPrefix("prefix", new()
    {
        Name = "ipv6-root-pdp",
        Description = "test-delegation-mode-pdp",
        Region = "us-west1",
        IpCidrRange = "2001:db8::/40",
        ParentPrefix = advertised.Id,
        Mode = "DELEGATION",
    });

    var subprefix = new Gcp.Compute.PublicDelegatedPrefix("subprefix", new()
    {
        Name = "ipv6-sub-pdp",
        Description = "test-forwarding-rule-mode-pdp",
        Region = "us-west1",
        IpCidrRange = "2001:db8::/48",
        ParentPrefix = prefix.Id,
        AllocatablePrefixLength = 64,
        Mode = "EXTERNAL_IPV6_FORWARDING_RULE_CREATION",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.PublicAdvertisedPrefix;
import com.pulumi.gcp.compute.PublicAdvertisedPrefixArgs;
import com.pulumi.gcp.compute.PublicDelegatedPrefix;
import com.pulumi.gcp.compute.PublicDelegatedPrefixArgs;
import java.util.List;
import java.util.ArrayList;
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 advertised = new PublicAdvertisedPrefix("advertised", PublicAdvertisedPrefixArgs.builder()
            .name("ipv6-pap")
            .description("description")
            .dnsVerificationIp("2001:db8::")
            .ipCidrRange("2001:db8::/32")
            .pdpScope("REGIONAL")
            .build());

        var prefix = new PublicDelegatedPrefix("prefix", PublicDelegatedPrefixArgs.builder()
            .name("ipv6-root-pdp")
            .description("test-delegation-mode-pdp")
            .region("us-west1")
            .ipCidrRange("2001:db8::/40")
            .parentPrefix(advertised.id())
            .mode("DELEGATION")
            .build());

        var subprefix = new PublicDelegatedPrefix("subprefix", PublicDelegatedPrefixArgs.builder()
            .name("ipv6-sub-pdp")
            .description("test-forwarding-rule-mode-pdp")
            .region("us-west1")
            .ipCidrRange("2001:db8::/48")
            .parentPrefix(prefix.id())
            .allocatablePrefixLength(64)
            .mode("EXTERNAL_IPV6_FORWARDING_RULE_CREATION")
            .build());

    }
}

resources:
  advertised:
    type: gcp:compute:PublicAdvertisedPrefix
    properties:
      name: ipv6-pap
      description: description
      dnsVerificationIp: '2001:db8::'
      ipCidrRange: 2001:db8::/32
      pdpScope: REGIONAL
  prefix:
    type: gcp:compute:PublicDelegatedPrefix
    properties:
      name: ipv6-root-pdp
      description: test-delegation-mode-pdp
      region: us-west1
      ipCidrRange: 2001:db8::/40
      parentPrefix: ${advertised.id}
      mode: DELEGATION
  subprefix:
    type: gcp:compute:PublicDelegatedPrefix
    properties:
      name: ipv6-sub-pdp
      description: test-forwarding-rule-mode-pdp
      region: us-west1
      ipCidrRange: 2001:db8::/48
      parentPrefix: ${prefix.id}
      allocatablePrefixLength: 64
      mode: EXTERNAL_IPV6_FORWARDING_RULE_CREATION

Public Delegated Prefix Ipv6 Subnet Mode

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const advertised = new gcp.compute.PublicAdvertisedPrefix("advertised", {
    name: "ipv6-pap",
    description: "description",
    dnsVerificationIp: "2001:db8::",
    ipCidrRange: "2001:db8::/32",
    pdpScope: "REGIONAL",
});
const prefix = new gcp.compute.PublicDelegatedPrefix("prefix", {
    name: "ipv6-root-pdp",
    description: "test-delegation-mode-pdp",
    region: "us-east1",
    ipCidrRange: "2001:db8::/40",
    parentPrefix: advertised.id,
    mode: "DELEGATION",
});
const subprefix = new gcp.compute.PublicDelegatedPrefix("subprefix", {
    name: "ipv6-sub-pdp",
    description: "test-subnet-mode-pdp",
    region: "us-east1",
    ipCidrRange: "2001:db8::/48",
    parentPrefix: prefix.id,
    mode: "EXTERNAL_IPV6_SUBNETWORK_CREATION",
});

import pulumi
import pulumi_gcp as gcp

advertised = gcp.compute.PublicAdvertisedPrefix("advertised",
    name="ipv6-pap",
    description="description",
    dns_verification_ip="2001:db8::",
    ip_cidr_range="2001:db8::/32",
    pdp_scope="REGIONAL")
prefix = gcp.compute.PublicDelegatedPrefix("prefix",
    name="ipv6-root-pdp",
    description="test-delegation-mode-pdp",
    region="us-east1",
    ip_cidr_range="2001:db8::/40",
    parent_prefix=advertised.id,
    mode="DELEGATION")
subprefix = gcp.compute.PublicDelegatedPrefix("subprefix",
    name="ipv6-sub-pdp",
    description="test-subnet-mode-pdp",
    region="us-east1",
    ip_cidr_range="2001:db8::/48",
    parent_prefix=prefix.id,
    mode="EXTERNAL_IPV6_SUBNETWORK_CREATION")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		advertised, err := compute.NewPublicAdvertisedPrefix(ctx, "advertised", &compute.PublicAdvertisedPrefixArgs{
			Name:              pulumi.String("ipv6-pap"),
			Description:       pulumi.String("description"),
			DnsVerificationIp: pulumi.String("2001:db8::"),
			IpCidrRange:       pulumi.String("2001:db8::/32"),
			PdpScope:          pulumi.String("REGIONAL"),
		})
		if err != nil {
			return err
		}
		prefix, err := compute.NewPublicDelegatedPrefix(ctx, "prefix", &compute.PublicDelegatedPrefixArgs{
			Name:         pulumi.String("ipv6-root-pdp"),
			Description:  pulumi.String("test-delegation-mode-pdp"),
			Region:       pulumi.String("us-east1"),
			IpCidrRange:  pulumi.String("2001:db8::/40"),
			ParentPrefix: advertised.ID(),
			Mode:         pulumi.String("DELEGATION"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewPublicDelegatedPrefix(ctx, "subprefix", &compute.PublicDelegatedPrefixArgs{
			Name:         pulumi.String("ipv6-sub-pdp"),
			Description:  pulumi.String("test-subnet-mode-pdp"),
			Region:       pulumi.String("us-east1"),
			IpCidrRange:  pulumi.String("2001:db8::/48"),
			ParentPrefix: prefix.ID(),
			Mode:         pulumi.String("EXTERNAL_IPV6_SUBNETWORK_CREATION"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var advertised = new Gcp.Compute.PublicAdvertisedPrefix("advertised", new()
    {
        Name = "ipv6-pap",
        Description = "description",
        DnsVerificationIp = "2001:db8::",
        IpCidrRange = "2001:db8::/32",
        PdpScope = "REGIONAL",
    });

    var prefix = new Gcp.Compute.PublicDelegatedPrefix("prefix", new()
    {
        Name = "ipv6-root-pdp",
        Description = "test-delegation-mode-pdp",
        Region = "us-east1",
        IpCidrRange = "2001:db8::/40",
        ParentPrefix = advertised.Id,
        Mode = "DELEGATION",
    });

    var subprefix = new Gcp.Compute.PublicDelegatedPrefix("subprefix", new()
    {
        Name = "ipv6-sub-pdp",
        Description = "test-subnet-mode-pdp",
        Region = "us-east1",
        IpCidrRange = "2001:db8::/48",
        ParentPrefix = prefix.Id,
        Mode = "EXTERNAL_IPV6_SUBNETWORK_CREATION",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.PublicAdvertisedPrefix;
import com.pulumi.gcp.compute.PublicAdvertisedPrefixArgs;
import com.pulumi.gcp.compute.PublicDelegatedPrefix;
import com.pulumi.gcp.compute.PublicDelegatedPrefixArgs;
import java.util.List;
import java.util.ArrayList;
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 advertised = new PublicAdvertisedPrefix("advertised", PublicAdvertisedPrefixArgs.builder()
            .name("ipv6-pap")
            .description("description")
            .dnsVerificationIp("2001:db8::")
            .ipCidrRange("2001:db8::/32")
            .pdpScope("REGIONAL")
            .build());

        var prefix = new PublicDelegatedPrefix("prefix", PublicDelegatedPrefixArgs.builder()
            .name("ipv6-root-pdp")
            .description("test-delegation-mode-pdp")
            .region("us-east1")
            .ipCidrRange("2001:db8::/40")
            .parentPrefix(advertised.id())
            .mode("DELEGATION")
            .build());

        var subprefix = new PublicDelegatedPrefix("subprefix", PublicDelegatedPrefixArgs.builder()
            .name("ipv6-sub-pdp")
            .description("test-subnet-mode-pdp")
            .region("us-east1")
            .ipCidrRange("2001:db8::/48")
            .parentPrefix(prefix.id())
            .mode("EXTERNAL_IPV6_SUBNETWORK_CREATION")
            .build());

    }
}

resources:
  advertised:
    type: gcp:compute:PublicAdvertisedPrefix
    properties:
      name: ipv6-pap
      description: description
      dnsVerificationIp: '2001:db8::'
      ipCidrRange: 2001:db8::/32
      pdpScope: REGIONAL
  prefix:
    type: gcp:compute:PublicDelegatedPrefix
    properties:
      name: ipv6-root-pdp
      description: test-delegation-mode-pdp
      region: us-east1
      ipCidrRange: 2001:db8::/40
      parentPrefix: ${advertised.id}
      mode: DELEGATION
  subprefix:
    type: gcp:compute:PublicDelegatedPrefix
    properties:
      name: ipv6-sub-pdp
      description: test-subnet-mode-pdp
      region: us-east1
      ipCidrRange: 2001:db8::/48
      parentPrefix: ${prefix.id}
      mode: EXTERNAL_IPV6_SUBNETWORK_CREATION

Create PublicDelegatedPrefix Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new PublicDelegatedPrefix(name: string, args: PublicDelegatedPrefixArgs, opts?: CustomResourceOptions);

@overload
def PublicDelegatedPrefix(resource_name: str,
                          args: PublicDelegatedPrefixArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def PublicDelegatedPrefix(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          ip_cidr_range: Optional[str] = None,
                          parent_prefix: Optional[str] = None,
                          region: Optional[str] = None,
                          allocatable_prefix_length: Optional[int] = None,
                          description: Optional[str] = None,
                          is_live_migration: Optional[bool] = None,
                          mode: Optional[str] = None,
                          name: Optional[str] = None,
                          project: Optional[str] = None)

func NewPublicDelegatedPrefix(ctx *Context, name string, args PublicDelegatedPrefixArgs, opts ...ResourceOption) (*PublicDelegatedPrefix, error)

public PublicDelegatedPrefix(string name, PublicDelegatedPrefixArgs args, CustomResourceOptions? opts = null)

public PublicDelegatedPrefix(String name, PublicDelegatedPrefixArgs args)
public PublicDelegatedPrefix(String name, PublicDelegatedPrefixArgs args, CustomResourceOptions options)

type: gcp:compute:PublicDelegatedPrefix
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PublicDelegatedPrefixArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PublicDelegatedPrefixArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PublicDelegatedPrefixArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PublicDelegatedPrefixArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PublicDelegatedPrefixArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var publicDelegatedPrefixResource = new Gcp.Compute.PublicDelegatedPrefix("publicDelegatedPrefixResource", new()
{
    IpCidrRange = "string",
    ParentPrefix = "string",
    Region = "string",
    AllocatablePrefixLength = 0,
    Description = "string",
    IsLiveMigration = false,
    Mode = "string",
    Name = "string",
    Project = "string",
});

example, err := compute.NewPublicDelegatedPrefix(ctx, "publicDelegatedPrefixResource", &compute.PublicDelegatedPrefixArgs{
	IpCidrRange:             pulumi.String("string"),
	ParentPrefix:            pulumi.String("string"),
	Region:                  pulumi.String("string"),
	AllocatablePrefixLength: pulumi.Int(0),
	Description:             pulumi.String("string"),
	IsLiveMigration:         pulumi.Bool(false),
	Mode:                    pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Project:                 pulumi.String("string"),
})

var publicDelegatedPrefixResource = new PublicDelegatedPrefix("publicDelegatedPrefixResource", PublicDelegatedPrefixArgs.builder()
    .ipCidrRange("string")
    .parentPrefix("string")
    .region("string")
    .allocatablePrefixLength(0)
    .description("string")
    .isLiveMigration(false)
    .mode("string")
    .name("string")
    .project("string")
    .build());

public_delegated_prefix_resource = gcp.compute.PublicDelegatedPrefix("publicDelegatedPrefixResource",
    ip_cidr_range="string",
    parent_prefix="string",
    region="string",
    allocatable_prefix_length=0,
    description="string",
    is_live_migration=False,
    mode="string",
    name="string",
    project="string")

const publicDelegatedPrefixResource = new gcp.compute.PublicDelegatedPrefix("publicDelegatedPrefixResource", {
    ipCidrRange: "string",
    parentPrefix: "string",
    region: "string",
    allocatablePrefixLength: 0,
    description: "string",
    isLiveMigration: false,
    mode: "string",
    name: "string",
    project: "string",
});

type: gcp:compute:PublicDelegatedPrefix
properties:
    allocatablePrefixLength: 0
    description: string
    ipCidrRange: string
    isLiveMigration: false
    mode: string
    name: string
    parentPrefix: string
    project: string
    region: string

PublicDelegatedPrefix Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PublicDelegatedPrefix resource accepts the following input properties:

IpCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
ParentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Region string: A region where the prefix will reside.
AllocatablePrefixLength int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
Description string: An optional description of this resource.
IsLiveMigration bool: If true, the prefix will be live migrated.
Mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
Name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

IpCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
ParentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Region string: A region where the prefix will reside.
AllocatablePrefixLength int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
Description string: An optional description of this resource.
IsLiveMigration bool: If true, the prefix will be live migrated.
Mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
Name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ipCidrRange String: The IP address range, in CIDR format, represented by this public delegated prefix.
parentPrefix String: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
region String: A region where the prefix will reside.
allocatablePrefixLength Integer: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description String: An optional description of this resource.
isLiveMigration Boolean: If true, the prefix will be live migrated.
mode String: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name String: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ipCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
parentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
region string: A region where the prefix will reside.
allocatablePrefixLength number: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description string: An optional description of this resource.
isLiveMigration boolean: If true, the prefix will be live migrated.
mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ip_cidr_range str: The IP address range, in CIDR format, represented by this public delegated prefix.
parent_prefix str: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
region str: A region where the prefix will reside.
allocatable_prefix_length int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description str: An optional description of this resource.
is_live_migration bool: If true, the prefix will be live migrated.
mode str: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name str: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ipCidrRange String: The IP address range, in CIDR format, represented by this public delegated prefix.
parentPrefix String: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
region String: A region where the prefix will reside.
allocatablePrefixLength Number: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description String: An optional description of this resource.
isLiveMigration Boolean: If true, the prefix will be live migrated.
mode String: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name String: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the PublicDelegatedPrefix resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

id String: The provider-assigned unique ID for this managed resource.
selfLink String: The URI of the created resource.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

id String: The provider-assigned unique ID for this managed resource.
selfLink String: The URI of the created resource.

Look up Existing PublicDelegatedPrefix Resource

Get an existing PublicDelegatedPrefix resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PublicDelegatedPrefixState, opts?: CustomResourceOptions): PublicDelegatedPrefix

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocatable_prefix_length: Optional[int] = None,
        description: Optional[str] = None,
        ip_cidr_range: Optional[str] = None,
        is_live_migration: Optional[bool] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        parent_prefix: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        self_link: Optional[str] = None) -> PublicDelegatedPrefix

func GetPublicDelegatedPrefix(ctx *Context, name string, id IDInput, state *PublicDelegatedPrefixState, opts ...ResourceOption) (*PublicDelegatedPrefix, error)

public static PublicDelegatedPrefix Get(string name, Input<string> id, PublicDelegatedPrefixState? state, CustomResourceOptions? opts = null)

public static PublicDelegatedPrefix get(String name, Output<String> id, PublicDelegatedPrefixState state, CustomResourceOptions options)

resources:  _:    type: gcp:compute:PublicDelegatedPrefix    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocatablePrefixLength int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
Description string: An optional description of this resource.
IpCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
IsLiveMigration bool: If true, the prefix will be live migrated.
Mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
Name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
ParentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: A region where the prefix will reside.
SelfLink string: The URI of the created resource.

AllocatablePrefixLength int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
Description string: An optional description of this resource.
IpCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
IsLiveMigration bool: If true, the prefix will be live migrated.
Mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
Name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
ParentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: A region where the prefix will reside.
SelfLink string: The URI of the created resource.

allocatablePrefixLength Integer: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description String: An optional description of this resource.
ipCidrRange String: The IP address range, in CIDR format, represented by this public delegated prefix.
isLiveMigration Boolean: If true, the prefix will be live migrated.
mode String: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name String: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
parentPrefix String: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region String: A region where the prefix will reside.
selfLink String: The URI of the created resource.

allocatablePrefixLength number: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description string: An optional description of this resource.
ipCidrRange string: The IP address range, in CIDR format, represented by this public delegated prefix.
isLiveMigration boolean: If true, the prefix will be live migrated.
mode string: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name string: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
parentPrefix string: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: A region where the prefix will reside.
selfLink string: The URI of the created resource.

allocatable_prefix_length int: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description str: An optional description of this resource.
ip_cidr_range str: The IP address range, in CIDR format, represented by this public delegated prefix.
is_live_migration bool: If true, the prefix will be live migrated.
mode str: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name str: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
parent_prefix str: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: A region where the prefix will reside.
self_link str: The URI of the created resource.

allocatablePrefixLength Number: The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
description String: An optional description of this resource.
ipCidrRange String: The IP address range, in CIDR format, represented by this public delegated prefix.
isLiveMigration Boolean: If true, the prefix will be live migrated.
mode String: Specifies the mode of this IPv6 PDP. MODE must be one of: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION and EXTERNAL_IPV6_SUBNETWORK_CREATION. Possible values are: DELEGATION, EXTERNAL_IPV6_FORWARDING_RULE_CREATION, EXTERNAL_IPV6_SUBNETWORK_CREATION.
name String: Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
parentPrefix String: The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region String: A region where the prefix will reside.
selfLink String: The URI of the created resource.

Import

PublicDelegatedPrefix can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/publicDelegatedPrefixes/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}

When using the pulumi import command, PublicDelegatedPrefix can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/publicDelegatedPrefix:PublicDelegatedPrefix default projects/{{project}}/regions/{{region}}/publicDelegatedPrefixes/{{name}}

$ pulumi import gcp:compute/publicDelegatedPrefix:PublicDelegatedPrefix default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:compute/publicDelegatedPrefix:PublicDelegatedPrefix default {{region}}/{{name}}

$ pulumi import gcp:compute/publicDelegatedPrefix:PublicDelegatedPrefix default {{name}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-gcp

Example Usage
Public Delegated Prefixes Basic
Public Delegated Prefixes Ipv6
Public Delegated Prefix Ipv6 Subnet Mode
Create PublicDelegatedPrefix Resource
Constructor syntax
Constructor example
PublicDelegatedPrefix Resource Properties
Inputs
Outputs
Look up Existing PublicDelegatedPrefix Resource
Import
Package Details

Request a Change

gcp.compute.PublicDelegatedPrefix

On this page

On this page

Example Usage

Public Delegated Prefixes Basic

Public Delegated Prefixes Ipv6

Public Delegated Prefix Ipv6 Subnet Mode

Create PublicDelegatedPrefix Resource

Constructor syntax

Parameters

Constructor example

PublicDelegatedPrefix Resource Properties

Inputs

Outputs

Look up Existing PublicDelegatedPrefix Resource

Import

Package Details

On this page

On this page