DomainMapping

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

Create a DomainMapping Resource

new DomainMapping(name: string, args: DomainMappingArgs, opts?: CustomResourceOptions);

def DomainMapping(resource_name, opts=None, location=None, metadata=None, name=None, project=None, spec=None, __props__=None);

func NewDomainMapping(ctx *Context, name string, args DomainMappingArgs, opts ...ResourceOption) (*DomainMapping, error)

public DomainMapping(string name, DomainMappingArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

DomainMapping Resource Properties

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

Inputs

The DomainMapping resource accepts the following input properties:

Location string: The location of the cloud run instance. eg us-central1
Metadata DomainMappingMetadataArgs: Metadata associated with this DomainMapping. Structure is documented below.
Spec DomainMappingSpecArgs: The spec for this DomainMapping. Structure is documented below.
Name string: Name should be a verified domain
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Location string: The location of the cloud run instance. eg us-central1
Metadata DomainMappingMetadata: Metadata associated with this DomainMapping. Structure is documented below.
Spec DomainMappingSpec: The spec for this DomainMapping. Structure is documented below.
Name string: Name should be a verified domain
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

location string: The location of the cloud run instance. eg us-central1
metadata DomainMappingMetadata: Metadata associated with this DomainMapping. Structure is documented below.
spec DomainMappingSpec: The spec for this DomainMapping. Structure is documented below.
name string: Name should be a verified domain
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

location str: The location of the cloud run instance. eg us-central1
metadata Dict[DomainMappingMetadata]: Metadata associated with this DomainMapping. Structure is documented below.
spec Dict[DomainMappingSpec]: The spec for this DomainMapping. Structure is documented below.
name str: Name should be a verified domain
project str: 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 DomainMapping resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Status DomainMappingStatus: The current status of the DomainMapping.

Id string: The provider-assigned unique ID for this managed resource.
Status DomainMappingStatus: The current status of the DomainMapping.

id string: The provider-assigned unique ID for this managed resource.
status DomainMappingStatus: The current status of the DomainMapping.

id str: The provider-assigned unique ID for this managed resource.
status Dict[DomainMappingStatus]: The current status of the DomainMapping.

Look up an 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

static get(resource_name, id, opts=None, location=None, metadata=None, name=None, project=None, spec=None, status=None, __props__=None);

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)

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.

The following state arguments are supported:

Location string: The location of the cloud run instance. eg us-central1
Metadata DomainMappingMetadataArgs: Metadata associated with this DomainMapping. Structure is documented below.
Name string: Name should be a verified domain
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Spec DomainMappingSpecArgs: The spec for this DomainMapping. Structure is documented below.
Status DomainMappingStatusArgs: The current status of the DomainMapping.

Location string: The location of the cloud run instance. eg us-central1
Metadata DomainMappingMetadata: Metadata associated with this DomainMapping. Structure is documented below.
Name string: Name should be a verified domain
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Spec DomainMappingSpec: The spec for this DomainMapping. Structure is documented below.
Status DomainMappingStatus: The current status of the DomainMapping.

location string: The location of the cloud run instance. eg us-central1
metadata DomainMappingMetadata: Metadata associated with this DomainMapping. Structure is documented below.
name string: Name should be a verified domain
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
spec DomainMappingSpec: The spec for this DomainMapping. Structure is documented below.
status DomainMappingStatus: The current status of the DomainMapping.

location str: The location of the cloud run instance. eg us-central1
metadata Dict[DomainMappingMetadata]: Metadata associated with this DomainMapping. Structure is documented below.
name str: Name should be a verified domain
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
spec Dict[DomainMappingSpec]: The spec for this DomainMapping. Structure is documented below.
status Dict[DomainMappingStatus]: The current status of the DomainMapping.

Supporting Types

DomainMappingMetadata

See the input and output API doc for this type.

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: http://kubernetes.io/docs/user-guide/annotations
Generation int: - 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: http://kubernetes.io/docs/user-guide/labels
ResourceVersion string: - 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: - SelfLink is a URL representing this object.
Uid string: - 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: http://kubernetes.io/docs/user-guide/identifiers#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: http://kubernetes.io/docs/user-guide/annotations
Generation int: - 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: http://kubernetes.io/docs/user-guide/labels
ResourceVersion string: - 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: - SelfLink is a URL representing this object.
Uid string: - 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: http://kubernetes.io/docs/user-guide/identifiers#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: http://kubernetes.io/docs/user-guide/annotations
generation number: - 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: http://kubernetes.io/docs/user-guide/labels
resourceVersion string: - 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: - SelfLink is a URL representing this object.
uid string: - 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: http://kubernetes.io/docs/user-guide/identifiers#uids

namespace str: In Cloud Run the namespace must be equal to either the project ID or project number.
annotations Dict[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: http://kubernetes.io/docs/user-guide/annotations
generation float: - A sequence number representing a specific generation of the desired state.
labels Dict[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: http://kubernetes.io/docs/user-guide/labels
resourceVersion str: - 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: - SelfLink is a URL representing this object.
uid str: - 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: http://kubernetes.io/docs/user-guide/identifiers#uids

DomainMappingSpec

See the input and output API doc for this type.

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.
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.
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.
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 str: The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.
certificateMode str: The mode of the certificate.
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.