DomainMapping class

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

To get more information about DomainMapping, see:

• API documentation
• How-to Guides
• Official Documentation

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,
    })

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

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

resource "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"
      }]
    }
  }
}
resource "gcp_cloudrun_domainmapping" "default" {
  location = "us-central1"
  name     = "verified-domain.com"
  metadata = {
    namespace = "my-project-name"
  }
  spec = {
    route_name = gcp_cloudrun_service.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.inputs.ServiceTemplateSpecContainerArgs;
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var default_ = new 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}

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}}

Constructors

DomainMapping(String name, {DomainMappingArgs? args, CustomResourceOptions? options})

Creates a new DomainMapping. name The Pulumi resource name. args Arguments used to configure this DomainMapping. The set of arguments for DomainMapping. options Resource options controlling this resource's behavior.

DomainMapping.reference(String urn)

Creates a typed reference to an existing DomainMapping resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

The location of the cloud run instance. eg us-central1

late, final

metadata ↔ Output<DomainMappingMetadata>

Metadata associated with this DomainMapping. Structure is documented below.

late, final

name ↔ Output<String>

Name should be a verified domain

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

spec ↔ Output<DomainMappingSpec>

The spec for this DomainMapping. Structure is documented below.

late, final

statuses ↔ Output<List<DomainMappingStatus>>

(Output) Status of the condition, one of True, False, Unknown.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {DomainMappingState? state, CustomResourceOptions? options}) → DomainMapping

Gets an existing DomainMapping resource's state with the given name and id.