Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. cloudrun
  5. DomainMapping
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.cloudrun.DomainMapping

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    Resource to hold the state and status of a user’s domain mapping.

    To get more information about DomainMapping, see:

    Example Usage

    Cloud Run Domain Mapping Basic

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

const _default = new gcp.cloudrun.Service("default", {
    name: "cloudrun-srv",
    location: "us-central1",
    metadata: {
        namespace: "my-project-name",
    },
    template: {
        spec: {
            containers: [{
                image: "us-docker.pkg.dev/cloudrun/container/hello",
            }],
        },
    },
});
const defaultDomainMapping = new gcp.cloudrun.DomainMapping("default", {
    location: "us-central1",
    name: "verified-domain.com",
    metadata: {
        namespace: "my-project-name",
    },
    spec: {
        routeName: _default.name,
    },
});

    import pulumi
import pulumi_gcp as gcp

default = gcp.cloudrun.Service("default",
    name="cloudrun-srv",
    location="us-central1",
    metadata={
        "namespace": "my-project-name",
    },
    template={
        "spec": {
            "containers": [{
                "image": "us-docker.pkg.dev/cloudrun/container/hello",
            }],
        },
    })
default_domain_mapping = gcp.cloudrun.DomainMapping("default",
    location="us-central1",
    name="verified-domain.com",
    metadata={
        "namespace": "my-project-name",
    },
    spec={
        "route_name": default.name,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := cloudrun.NewService(ctx, "default", &cloudrun.ServiceArgs{
			Name:     pulumi.String("cloudrun-srv"),
			Location: pulumi.String("us-central1"),
			Metadata: &cloudrun.ServiceMetadataArgs{
				Namespace: pulumi.String("my-project-name"),
			},
			Template: &cloudrun.ServiceTemplateArgs{
				Spec: &cloudrun.ServiceTemplateSpecArgs{
					Containers: cloudrun.ServiceTemplateSpecContainerArray{
						&cloudrun.ServiceTemplateSpecContainerArgs{
							Image: pulumi.String("us-docker.pkg.dev/cloudrun/container/hello"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudrun.NewDomainMapping(ctx, "default", &cloudrun.DomainMappingArgs{
			Location: pulumi.String("us-central1"),
			Name:     pulumi.String("verified-domain.com"),
			Metadata: &cloudrun.DomainMappingMetadataArgs{
				Namespace: pulumi.String("my-project-name"),
			},
			Spec: &cloudrun.DomainMappingSpecArgs{
				RouteName: _default.Name,
			},
		})
		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 @default = new Gcp.CloudRun.Service("default", new()
    {
        Name = "cloudrun-srv",
        Location = "us-central1",
        Metadata = new Gcp.CloudRun.Inputs.ServiceMetadataArgs
        {
            Namespace = "my-project-name",
        },
        Template = new Gcp.CloudRun.Inputs.ServiceTemplateArgs
        {
            Spec = new Gcp.CloudRun.Inputs.ServiceTemplateSpecArgs
            {
                Containers = new[]
                {
                    new Gcp.CloudRun.Inputs.ServiceTemplateSpecContainerArgs
                    {
                        Image = "us-docker.pkg.dev/cloudrun/container/hello",
                    },
                },
            },
        },
    });

    var defaultDomainMapping = new Gcp.CloudRun.DomainMapping("default", new()
    {
        Location = "us-central1",
        Name = "verified-domain.com",
        Metadata = new Gcp.CloudRun.Inputs.DomainMappingMetadataArgs
        {
            Namespace = "my-project-name",
        },
        Spec = new Gcp.CloudRun.Inputs.DomainMappingSpecArgs
        {
            RouteName = @default.Name,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudrun.Service;
import com.pulumi.gcp.cloudrun.ServiceArgs;
import com.pulumi.gcp.cloudrun.inputs.ServiceMetadataArgs;
import com.pulumi.gcp.cloudrun.inputs.ServiceTemplateArgs;
import com.pulumi.gcp.cloudrun.inputs.ServiceTemplateSpecArgs;
import com.pulumi.gcp.cloudrun.DomainMapping;
import com.pulumi.gcp.cloudrun.DomainMappingArgs;
import com.pulumi.gcp.cloudrun.inputs.DomainMappingMetadataArgs;
import com.pulumi.gcp.cloudrun.inputs.DomainMappingSpecArgs;
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 default_ = new Service("default", ServiceArgs.builder()
            .name("cloudrun-srv")
            .location("us-central1")
            .metadata(ServiceMetadataArgs.builder()
                .namespace("my-project-name")
                .build())
            .template(ServiceTemplateArgs.builder()
                .spec(ServiceTemplateSpecArgs.builder()
                    .containers(ServiceTemplateSpecContainerArgs.builder()
                        .image("us-docker.pkg.dev/cloudrun/container/hello")
                        .build())
                    .build())
                .build())
            .build());

        var defaultDomainMapping = new DomainMapping("defaultDomainMapping", DomainMappingArgs.builder()
            .location("us-central1")
            .name("verified-domain.com")
            .metadata(DomainMappingMetadataArgs.builder()
                .namespace("my-project-name")
                .build())
            .spec(DomainMappingSpecArgs.builder()
                .routeName(default_.name())
                .build())
            .build());

    }
}

    resources:
  default:
    type: gcp:cloudrun:Service
    properties:
      name: cloudrun-srv
      location: us-central1
      metadata:
        namespace: my-project-name
      template:
        spec:
          containers:
            - image: us-docker.pkg.dev/cloudrun/container/hello
  defaultDomainMapping:
    type: gcp:cloudrun:DomainMapping
    name: default
    properties:
      location: us-central1
      name: verified-domain.com
      metadata:
        namespace: my-project-name
      spec:
        routeName: ${default.name}

    Create DomainMapping Resource

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

    Constructor syntax

    new DomainMapping(name: string, args: DomainMappingArgs, opts?: CustomResourceOptions);
    @overload
def DomainMapping(resource_name: str,
                  args: DomainMappingArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DomainMapping(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  location: Optional[str] = None,
                  spec: Optional[DomainMappingSpecArgs] = None,
                  metadata: Optional[DomainMappingMetadataArgs] = None,
                  name: Optional[str] = None,
                  project: Optional[str] = None)
    func NewDomainMapping(ctx *Context, name string, args DomainMappingArgs, opts ...ResourceOption) (*DomainMapping, error)
    public DomainMapping(string name, DomainMappingArgs args, CustomResourceOptions? opts = null)
    public DomainMapping(String name, DomainMappingArgs args)
public DomainMapping(String name, DomainMappingArgs args, CustomResourceOptions options)

    type: gcp:cloudrun:DomainMapping
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 DomainMappingArgs
    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 DomainMappingArgs
    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 DomainMappingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainMappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainMappingArgs
    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.

    var gcpDomainMappingResource = new Gcp.CloudRun.DomainMapping("gcpDomainMappingResource", new()
{
    Location = "string",
    Spec = new Gcp.CloudRun.Inputs.DomainMappingSpecArgs
    {
        RouteName = "string",
        CertificateMode = "string",
        ForceOverride = false,
    },
    Metadata = new Gcp.CloudRun.Inputs.DomainMappingMetadataArgs
    {
        Namespace = "string",
        Annotations = 
        {
            { "string", "string" },
        },
        EffectiveAnnotations = 
        {
            { "string", "string" },
        },
        EffectiveLabels = 
        {
            { "string", "string" },
        },
        Generation = 0,
        Labels = 
        {
            { "string", "string" },
        },
        PulumiLabels = 
        {
            { "string", "string" },
        },
        ResourceVersion = "string",
        SelfLink = "string",
        Uid = "string",
    },
    Name = "string",
    Project = "string",
});

    example, err := cloudrun.NewDomainMapping(ctx, "gcpDomainMappingResource", &cloudrun.DomainMappingArgs{
	Location: pulumi.String("string"),
	Spec: &cloudrun.DomainMappingSpecArgs{
		RouteName:       pulumi.String("string"),
		CertificateMode: pulumi.String("string"),
		ForceOverride:   pulumi.Bool(false),
	},
	Metadata: &cloudrun.DomainMappingMetadataArgs{
		Namespace: pulumi.String("string"),
		Annotations: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		EffectiveAnnotations: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		EffectiveLabels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Generation: pulumi.Int(0),
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		PulumiLabels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ResourceVersion: pulumi.String("string"),
		SelfLink:        pulumi.String("string"),
		Uid:             pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
})

    var gcpDomainMappingResource = new DomainMapping("gcpDomainMappingResource", DomainMappingArgs.builder()
    .location("string")
    .spec(DomainMappingSpecArgs.builder()
        .routeName("string")
        .certificateMode("string")
        .forceOverride(false)
        .build())
    .metadata(DomainMappingMetadataArgs.builder()
        .namespace("string")
        .annotations(Map.of("string", "string"))
        .effectiveAnnotations(Map.of("string", "string"))
        .effectiveLabels(Map.of("string", "string"))
        .generation(0)
        .labels(Map.of("string", "string"))
        .pulumiLabels(Map.of("string", "string"))
        .resourceVersion("string")
        .selfLink("string")
        .uid("string")
        .build())
    .name("string")
    .project("string")
    .build());

    gcp_domain_mapping_resource = gcp.cloudrun.DomainMapping("gcpDomainMappingResource",
    location="string",
    spec={
        "route_name": "string",
        "certificate_mode": "string",
        "force_override": False,
    },
    metadata={
        "namespace": "string",
        "annotations": {
            "string": "string",
        },
        "effective_annotations": {
            "string": "string",
        },
        "effective_labels": {
            "string": "string",
        },
        "generation": 0,
        "labels": {
            "string": "string",
        },
        "pulumi_labels": {
            "string": "string",
        },
        "resource_version": "string",
        "self_link": "string",
        "uid": "string",
    },
    name="string",
    project="string")

    const gcpDomainMappingResource = new gcp.cloudrun.DomainMapping("gcpDomainMappingResource", {
    location: "string",
    spec: {
        routeName: "string",
        certificateMode: "string",
        forceOverride: false,
    },
    metadata: {
        namespace: "string",
        annotations: {
            string: "string",
        },
        effectiveAnnotations: {
            string: "string",
        },
        effectiveLabels: {
            string: "string",
        },
        generation: 0,
        labels: {
            string: "string",
        },
        pulumiLabels: {
            string: "string",
        },
        resourceVersion: "string",
        selfLink: "string",
        uid: "string",
    },
    name: "string",
    project: "string",
});

    type: gcp:cloudrun:DomainMapping
properties:
    location: string
    metadata:
        annotations:
            string: string
        effectiveAnnotations:
            string: string
        effectiveLabels:
            string: string
        generation: 0
        labels:
            string: string
        namespace: string
        pulumiLabels:
            string: string
        resourceVersion: string
        selfLink: string
        uid: string
    name: string
    project: string
    spec:
        certificateMode: string
        forceOverride: false
        routeName: string

    DomainMapping 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 DomainMapping resource accepts the following input properties:

    Location string
    The location of the cloud run instance. eg us-central1
    Spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    Metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    Name string
    Name should be a verified domain
    Project string
    Location string
    The location of the cloud run instance. eg us-central1
    Spec DomainMappingSpecArgs
    The spec for this DomainMapping. Structure is documented below.
    Metadata DomainMappingMetadataArgs
    Metadata associated with this DomainMapping.
    Name string
    Name should be a verified domain
    Project string
    location String
    The location of the cloud run instance. eg us-central1
    spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    name String
    Name should be a verified domain
    project String
    location string
    The location of the cloud run instance. eg us-central1
    spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    name string
    Name should be a verified domain
    project string
    location str
    The location of the cloud run instance. eg us-central1
    spec DomainMappingSpecArgs
    The spec for this DomainMapping. Structure is documented below.
    metadata DomainMappingMetadataArgs
    Metadata associated with this DomainMapping.
    name str
    Name should be a verified domain
    project str
    location String
    The location of the cloud run instance. eg us-central1
    spec Property Map
    The spec for this DomainMapping. Structure is documented below.
    metadata Property Map
    Metadata associated with this DomainMapping.
    name String
    Name should be a verified domain
    project String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Statuses List<DomainMappingStatus>
    (Output) Status of the condition, one of True, False, Unknown.
    Id string
    The provider-assigned unique ID for this managed resource.
    Statuses []DomainMappingStatus
    (Output) Status of the condition, one of True, False, Unknown.
    id String
    The provider-assigned unique ID for this managed resource.
    statuses List<DomainMappingStatus>
    (Output) Status of the condition, one of True, False, Unknown.
    id string
    The provider-assigned unique ID for this managed resource.
    statuses DomainMappingStatus[]
    (Output) Status of the condition, one of True, False, Unknown.
    id str
    The provider-assigned unique ID for this managed resource.
    statuses Sequence[DomainMappingStatus]
    (Output) Status of the condition, one of True, False, Unknown.
    id String
    The provider-assigned unique ID for this managed resource.
    statuses List<Property Map>
    (Output) Status of the condition, one of True, False, Unknown.

    Look up Existing DomainMapping Resource

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

    public static get(name: string, id: Input<ID>, state?: DomainMappingState, opts?: CustomResourceOptions): DomainMapping
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        metadata: Optional[DomainMappingMetadataArgs] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        spec: Optional[DomainMappingSpecArgs] = None,
        statuses: Optional[Sequence[DomainMappingStatusArgs]] = None) -> DomainMapping
    func GetDomainMapping(ctx *Context, name string, id IDInput, state *DomainMappingState, opts ...ResourceOption) (*DomainMapping, error)
    public static DomainMapping Get(string name, Input<string> id, DomainMappingState? state, CustomResourceOptions? opts = null)
    public static DomainMapping get(String name, Output<String> id, DomainMappingState state, CustomResourceOptions options)
    resources:  _:    type: gcp:cloudrun:DomainMapping    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:
    Location string
    The location of the cloud run instance. eg us-central1
    Metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    Name string
    Name should be a verified domain
    Project string
    Spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    Statuses List<DomainMappingStatus>
    (Output) Status of the condition, one of True, False, Unknown.
    Location string
    The location of the cloud run instance. eg us-central1
    Metadata DomainMappingMetadataArgs
    Metadata associated with this DomainMapping.
    Name string
    Name should be a verified domain
    Project string
    Spec DomainMappingSpecArgs
    The spec for this DomainMapping. Structure is documented below.
    Statuses []DomainMappingStatusArgs
    (Output) Status of the condition, one of True, False, Unknown.
    location String
    The location of the cloud run instance. eg us-central1
    metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    name String
    Name should be a verified domain
    project String
    spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    statuses List<DomainMappingStatus>
    (Output) Status of the condition, one of True, False, Unknown.
    location string
    The location of the cloud run instance. eg us-central1
    metadata DomainMappingMetadata
    Metadata associated with this DomainMapping.
    name string
    Name should be a verified domain
    project string
    spec DomainMappingSpec
    The spec for this DomainMapping. Structure is documented below.
    statuses DomainMappingStatus[]
    (Output) Status of the condition, one of True, False, Unknown.
    location str
    The location of the cloud run instance. eg us-central1
    metadata DomainMappingMetadataArgs
    Metadata associated with this DomainMapping.
    name str
    Name should be a verified domain
    project str
    spec DomainMappingSpecArgs
    The spec for this DomainMapping. Structure is documented below.
    statuses Sequence[DomainMappingStatusArgs]
    (Output) Status of the condition, one of True, False, Unknown.
    location String
    The location of the cloud run instance. eg us-central1
    metadata Property Map
    Metadata associated with this DomainMapping.
    name String
    Name should be a verified domain
    project String
    spec Property Map
    The spec for this DomainMapping. Structure is documented below.
    statuses List<Property Map>
    (Output) Status of the condition, one of True, False, Unknown.

    Supporting Types

    DomainMappingMetadata, DomainMappingMetadataArgs

    Namespace string
    In Cloud Run the namespace must be equal to either the project ID or project number.
    Annotations Dictionary<string, string>
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Generation int
    (Output) A sequence number representing a specific generation of the desired state.
    Labels Dictionary<string, string>
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    PulumiLabels Dictionary<string, string>
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    ResourceVersion string
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    SelfLink string
    (Output) SelfLink is a URL representing this object.
    Uid string
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    Namespace string
    In Cloud Run the namespace must be equal to either the project ID or project number.
    Annotations map[string]string
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    EffectiveAnnotations map[string]string
    EffectiveLabels map[string]string
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Generation int
    (Output) A sequence number representing a specific generation of the desired state.
    Labels map[string]string
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    PulumiLabels map[string]string
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    ResourceVersion string
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    SelfLink string
    (Output) SelfLink is a URL representing this object.
    Uid string
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    namespace String
    In Cloud Run the namespace must be equal to either the project ID or project number.
    annotations Map<String,String>
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    effectiveAnnotations Map<String,String>
    effectiveLabels Map<String,String>
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    generation Integer
    (Output) A sequence number representing a specific generation of the desired state.
    labels Map<String,String>
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    pulumiLabels Map<String,String>
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    resourceVersion String
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    selfLink String
    (Output) SelfLink is a URL representing this object.
    uid String
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    namespace string
    In Cloud Run the namespace must be equal to either the project ID or project number.
    annotations {[key: string]: string}
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[key: string]: string}
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    generation number
    (Output) A sequence number representing a specific generation of the desired state.
    labels {[key: string]: string}
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    pulumiLabels {[key: string]: string}
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    resourceVersion string
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    selfLink string
    (Output) SelfLink is a URL representing this object.
    uid string
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    namespace str
    In Cloud Run the namespace must be equal to either the project ID or project number.
    annotations Mapping[str, str]
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    generation int
    (Output) A sequence number representing a specific generation of the desired state.
    labels Mapping[str, str]
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    pulumi_labels Mapping[str, str]
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    resource_version str
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    self_link str
    (Output) SelfLink is a URL representing this object.
    uid str
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    namespace String
    In Cloud Run the namespace must be equal to either the project ID or project number.
    annotations Map<String>
    Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations Note: The Cloud Run API may add additional annotations that were not provided in your config. If the provider plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    (Output) All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    generation Number
    (Output) A sequence number representing a specific generation of the desired state.
    labels Map<String>
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    pulumiLabels Map<String>
    (Output) The combination of labels configured directly on the resource and default labels configured on the provider.
    resourceVersion String
    (Output) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    selfLink String
    (Output) SelfLink is a URL representing this object.
    uid String
    (Output) UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

    DomainMappingSpec, DomainMappingSpecArgs

    RouteName string
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    CertificateMode string
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    ForceOverride bool
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
    RouteName string
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    CertificateMode string
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    ForceOverride bool
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
    routeName String
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    certificateMode String
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    forceOverride Boolean
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
    routeName string
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    certificateMode string
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    forceOverride boolean
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
    route_name str
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    certificate_mode str
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    force_override bool
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
    routeName String
    The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
    certificateMode String
    The mode of the certificate. Default value is AUTOMATIC. Possible values are: NONE, AUTOMATIC.

    forceOverride Boolean
    If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.

    DomainMappingStatus, DomainMappingStatusArgs

    Conditions List<DomainMappingStatusCondition>
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    MappedRouteName string
    (Output) The name of the route that the mapping currently points to.
    ObservedGeneration int
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    ResourceRecords List<DomainMappingStatusResourceRecord>
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.
    Conditions []DomainMappingStatusCondition
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    MappedRouteName string
    (Output) The name of the route that the mapping currently points to.
    ObservedGeneration int
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    ResourceRecords []DomainMappingStatusResourceRecord
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.
    conditions List<DomainMappingStatusCondition>
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    mappedRouteName String
    (Output) The name of the route that the mapping currently points to.
    observedGeneration Integer
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    resourceRecords List<DomainMappingStatusResourceRecord>
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.
    conditions DomainMappingStatusCondition[]
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    mappedRouteName string
    (Output) The name of the route that the mapping currently points to.
    observedGeneration number
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    resourceRecords DomainMappingStatusResourceRecord[]
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.
    conditions Sequence[DomainMappingStatusCondition]
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    mapped_route_name str
    (Output) The name of the route that the mapping currently points to.
    observed_generation int
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    resource_records Sequence[DomainMappingStatusResourceRecord]
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.
    conditions List<Property Map>
    (Output) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. Structure is documented below.
    mappedRouteName String
    (Output) The name of the route that the mapping currently points to.
    observedGeneration Number
    (Output) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller.
    resourceRecords List<Property Map>
    The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. Structure is documented below.

    DomainMappingStatusCondition, DomainMappingStatusConditionArgs

    Message string
    (Output) Human readable message indicating details about the current status.
    Reason string
    (Output) One-word CamelCase reason for the condition's current status.
    Status string
    (Output) Status of the condition, one of True, False, Unknown.
    Type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    Message string
    (Output) Human readable message indicating details about the current status.
    Reason string
    (Output) One-word CamelCase reason for the condition's current status.
    Status string
    (Output) Status of the condition, one of True, False, Unknown.
    Type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    message String
    (Output) Human readable message indicating details about the current status.
    reason String
    (Output) One-word CamelCase reason for the condition's current status.
    status String
    (Output) Status of the condition, one of True, False, Unknown.
    type String
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    message string
    (Output) Human readable message indicating details about the current status.
    reason string
    (Output) One-word CamelCase reason for the condition's current status.
    status string
    (Output) Status of the condition, one of True, False, Unknown.
    type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    message str
    (Output) Human readable message indicating details about the current status.
    reason str
    (Output) One-word CamelCase reason for the condition's current status.
    status str
    (Output) Status of the condition, one of True, False, Unknown.
    type str
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    message String
    (Output) Human readable message indicating details about the current status.
    reason String
    (Output) One-word CamelCase reason for the condition's current status.
    status String
    (Output) Status of the condition, one of True, False, Unknown.
    type String
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.

    DomainMappingStatusResourceRecord, DomainMappingStatusResourceRecordArgs

    Name string
    Name should be a verified domain
    Rrdata string
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    Type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    Name string
    Name should be a verified domain
    Rrdata string
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    Type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    name String
    Name should be a verified domain
    rrdata String
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    type String
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    name string
    Name should be a verified domain
    rrdata string
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    type string
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    name str
    Name should be a verified domain
    rrdata str
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    type str
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.
    name String
    Name should be a verified domain
    rrdata String
    (Output) Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
    type String
    Resource record type. Example: AAAA. Possible values are: A, AAAA, CNAME.

    Import

    DomainMapping can be imported using any of these accepted formats:

    • locations/{{location}}/namespaces/{{project}}/domainmappings/{{name}}

    • {{location}}/{{project}}/{{name}}

    • {{location}}/{{name}}

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

    $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default locations/{{location}}/namespaces/{{project}}/domainmappings/{{name}}

    $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default {{location}}/{{project}}/{{name}}

    $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default {{location}}/{{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.
    gcp logo
    Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp