Docs Packages
  1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. appengine
  5. DomainMapping
gcp logo
Google Cloud Classic v6.57.0, May 30 23

gcp.appengine.DomainMapping

Explore with Pulumi AI

A domain serving an App Engine application.

To get more information about DomainMapping, see:

Example Usage

App Engine Domain Mapping Basic

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

return await Deployment.RunAsync(() => 
{
    var domainMapping = new Gcp.AppEngine.DomainMapping("domainMapping", new()
    {
        DomainName = "verified-domain.com",
        SslSettings = new Gcp.AppEngine.Inputs.DomainMappingSslSettingsArgs
        {
            SslManagementType = "AUTOMATIC",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/appengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appengine.NewDomainMapping(ctx, "domainMapping", &appengine.DomainMappingArgs{
			DomainName: pulumi.String("verified-domain.com"),
			SslSettings: &appengine.DomainMappingSslSettingsArgs{
				SslManagementType: pulumi.String("AUTOMATIC"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.appengine.DomainMapping;
import com.pulumi.gcp.appengine.DomainMappingArgs;
import com.pulumi.gcp.appengine.inputs.DomainMappingSslSettingsArgs;
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 domainMapping = new DomainMapping("domainMapping", DomainMappingArgs.builder()        
            .domainName("verified-domain.com")
            .sslSettings(DomainMappingSslSettingsArgs.builder()
                .sslManagementType("AUTOMATIC")
                .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

domain_mapping = gcp.appengine.DomainMapping("domainMapping",
    domain_name="verified-domain.com",
    ssl_settings=gcp.appengine.DomainMappingSslSettingsArgs(
        ssl_management_type="AUTOMATIC",
    ))

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

const domainMapping = new gcp.appengine.DomainMapping("domainMapping", {
    domainName: "verified-domain.com",
    sslSettings: {
        sslManagementType: "AUTOMATIC",
    },
});

resources:
  domainMapping:
    type: gcp:appengine:DomainMapping
    properties:
      domainName: verified-domain.com
      sslSettings:
        sslManagementType: AUTOMATIC

Create DomainMapping Resource

new DomainMapping(name: string, args: DomainMappingArgs, opts?: CustomResourceOptions);
@overload
def DomainMapping(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  domain_name: Optional[str] = None,
                  override_strategy: Optional[str] = None,
                  project: Optional[str] = None,
                  ssl_settings: Optional[DomainMappingSslSettingsArgs] = None)
@overload
def DomainMapping(resource_name: str,
                  args: DomainMappingArgs,
                  opts: Optional[ResourceOptions] = 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:appengine:DomainMapping
properties: # The arguments to resource properties.
options: # 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.
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.

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

The DomainMapping resource accepts the following input properties:

DomainName string

Relative name of the domain serving the application. Example: example.com.

OverrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

Project string

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

SslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

DomainName string

Relative name of the domain serving the application. Example: example.com.

OverrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

Project string

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

SslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName String

Relative name of the domain serving the application. Example: example.com.

overrideStrategy String

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project String

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

sslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName string

Relative name of the domain serving the application. Example: example.com.

overrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project string

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

sslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domain_name str

Relative name of the domain serving the application. Example: example.com.

override_strategy str

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project str

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

ssl_settings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName String

Relative name of the domain serving the application. Example: example.com.

overrideStrategy String

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project String

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

sslSettings Property Map

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

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.

Name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

ResourceRecords List<DomainMappingResourceRecord>

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.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

ResourceRecords []DomainMappingResourceRecord

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.

id String

The provider-assigned unique ID for this managed resource.

name String

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

resourceRecords List<DomainMappingResourceRecord>

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.

id string

The provider-assigned unique ID for this managed resource.

name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

resourceRecords DomainMappingResourceRecord[]

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.

id str

The provider-assigned unique ID for this managed resource.

name str

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

resource_records Sequence[DomainMappingResourceRecord]

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.

id String

The provider-assigned unique ID for this managed resource.

name String

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

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.

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,
        domain_name: Optional[str] = None,
        name: Optional[str] = None,
        override_strategy: Optional[str] = None,
        project: Optional[str] = None,
        resource_records: Optional[Sequence[DomainMappingResourceRecordArgs]] = None,
        ssl_settings: Optional[DomainMappingSslSettingsArgs] = 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)
Resource lookup is not supported in YAML
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:
DomainName string

Relative name of the domain serving the application. Example: example.com.

Name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

OverrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

Project string

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

ResourceRecords List<DomainMappingResourceRecordArgs>

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.

SslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

DomainName string

Relative name of the domain serving the application. Example: example.com.

Name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

OverrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

Project string

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

ResourceRecords []DomainMappingResourceRecordArgs

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.

SslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName String

Relative name of the domain serving the application. Example: example.com.

name String

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

overrideStrategy String

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project String

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

resourceRecords List<DomainMappingResourceRecordArgs>

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.

sslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName string

Relative name of the domain serving the application. Example: example.com.

name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

overrideStrategy string

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project string

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

resourceRecords DomainMappingResourceRecordArgs[]

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.

sslSettings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domain_name str

Relative name of the domain serving the application. Example: example.com.

name str

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

override_strategy str

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project str

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

resource_records Sequence[DomainMappingResourceRecordArgs]

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.

ssl_settings DomainMappingSslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

domainName String

Relative name of the domain serving the application. Example: example.com.

name String

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

overrideStrategy String

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. Default value is STRICT. Possible values are: STRICT, OVERRIDE.

project String

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

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.

sslSettings Property Map

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

Supporting Types

DomainMappingResourceRecord

Name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

Rrdata string

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

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

Rrdata string

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

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

rrdata String

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

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

rrdata string

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

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

rrdata str

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

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

rrdata String

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.

DomainMappingSslSettings

SslManagementType string

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

CertificateId string

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

PendingManagedCertificateId string

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

SslManagementType string

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

CertificateId string

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

PendingManagedCertificateId string

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

sslManagementType String

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

certificateId String

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

pendingManagedCertificateId String

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

sslManagementType string

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

certificateId string

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

pendingManagedCertificateId string

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

ssl_management_type str

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

certificate_id str

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

pending_managed_certificate_id str

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

sslManagementType String

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain. Possible values are: AUTOMATIC, MANUAL.

certificateId String

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

pendingManagedCertificateId String

(Output) ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

Import

DomainMapping can be imported using any of these accepted formats

 $ pulumi import gcp:appengine/domainMapping:DomainMapping default apps/{{project}}/domainMappings/{{domain_name}}

 $ pulumi import gcp:appengine/domainMapping:DomainMapping default {{project}}/{{domain_name}}

 $ pulumi import gcp:appengine/domainMapping:DomainMapping default {{domain_name}}

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.