@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
185 lines (184 loc) • 6.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource to hold the state and status of a user's domain mapping.
*
* To get more information about DomainMapping, see:
*
* * [API documentation](https://cloud.google.com/run/docs/reference/rest/v1/projects.locations.domainmappings)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/run/docs/mapping-custom-domains)
*
* ## Example Usage
*
* ### Cloud Run Domain Mapping Basic
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default locations/{{location}}/namespaces/{{project}}/domainmappings/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default {{location}}/{{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:cloudrun/domainMapping:DomainMapping default {{location}}/{{name}}
* ```
*/
export declare class DomainMapping extends pulumi.CustomResource {
/**
* Get an existing DomainMapping resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainMappingState, opts?: pulumi.CustomResourceOptions): DomainMapping;
/**
* Returns true if the given object is an instance of DomainMapping. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DomainMapping;
/**
* The location of the cloud run instance. eg us-central1
*/
readonly location: pulumi.Output<string>;
/**
* Metadata associated with this DomainMapping.
* Structure is documented below.
*/
readonly metadata: pulumi.Output<outputs.cloudrun.DomainMappingMetadata>;
/**
* Name should be a [verified](https://support.google.com/webmasters/answer/9008080) domain
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The spec for this DomainMapping.
* Structure is documented below.
*/
readonly spec: pulumi.Output<outputs.cloudrun.DomainMappingSpec>;
/**
* (Output)
* Status of the condition, one of True, False, Unknown.
*/
readonly statuses: pulumi.Output<outputs.cloudrun.DomainMappingStatus[]>;
/**
* Create a DomainMapping resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainMappingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DomainMapping resources.
*/
export interface DomainMappingState {
/**
* The location of the cloud run instance. eg us-central1
*/
location?: pulumi.Input<string>;
/**
* Metadata associated with this DomainMapping.
* Structure is documented below.
*/
metadata?: pulumi.Input<inputs.cloudrun.DomainMappingMetadata>;
/**
* Name should be a [verified](https://support.google.com/webmasters/answer/9008080) domain
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The spec for this DomainMapping.
* Structure is documented below.
*/
spec?: pulumi.Input<inputs.cloudrun.DomainMappingSpec>;
/**
* (Output)
* Status of the condition, one of True, False, Unknown.
*/
statuses?: pulumi.Input<pulumi.Input<inputs.cloudrun.DomainMappingStatus>[]>;
}
/**
* The set of arguments for constructing a DomainMapping resource.
*/
export interface DomainMappingArgs {
/**
* The location of the cloud run instance. eg us-central1
*/
location: pulumi.Input<string>;
/**
* Metadata associated with this DomainMapping.
* Structure is documented below.
*/
metadata?: pulumi.Input<inputs.cloudrun.DomainMappingMetadata>;
/**
* Name should be a [verified](https://support.google.com/webmasters/answer/9008080) domain
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The spec for this DomainMapping.
* Structure is documented below.
*/
spec: pulumi.Input<inputs.cloudrun.DomainMappingSpec>;
}