Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. appengine
  5. appengine/v1beta
  6. DomainMapping

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.appengine/v1beta.DomainMapping

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains. Auto-naming is currently not supported for this resource.

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,
                  app_id: Optional[str] = None,
                  id: Optional[str] = None,
                  override_strategy: Optional[str] = None,
                  ssl_settings: Optional[SslSettingsArgs] = 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: google-native:appengine/v1beta:DomainMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DomainMappingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DomainMappingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DomainMappingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampledomainMappingResourceResourceFromAppenginev1beta = new GoogleNative.AppEngine.V1Beta.DomainMapping("exampledomainMappingResourceResourceFromAppenginev1beta", new()
{
    AppId = "string",
    Id = "string",
    OverrideStrategy = "string",
    SslSettings = new GoogleNative.AppEngine.V1Beta.Inputs.SslSettingsArgs
    {
        CertificateId = "string",
        SslManagementType = GoogleNative.AppEngine.V1Beta.SslSettingsSslManagementType.Automatic,
    },
});
Copy
example, err := appenginev1beta.NewDomainMapping(ctx, "exampledomainMappingResourceResourceFromAppenginev1beta", &appenginev1beta.DomainMappingArgs{
	AppId:            pulumi.String("string"),
	Id:               pulumi.String("string"),
	OverrideStrategy: pulumi.String("string"),
	SslSettings: &appengine.SslSettingsArgs{
		CertificateId:     pulumi.String("string"),
		SslManagementType: appenginev1beta.SslSettingsSslManagementTypeAutomatic,
	},
})
Copy
var exampledomainMappingResourceResourceFromAppenginev1beta = new DomainMapping("exampledomainMappingResourceResourceFromAppenginev1beta", DomainMappingArgs.builder()
    .appId("string")
    .id("string")
    .overrideStrategy("string")
    .sslSettings(SslSettingsArgs.builder()
        .certificateId("string")
        .sslManagementType("AUTOMATIC")
        .build())
    .build());
Copy
exampledomain_mapping_resource_resource_from_appenginev1beta = google_native.appengine.v1beta.DomainMapping("exampledomainMappingResourceResourceFromAppenginev1beta",
    app_id="string",
    id="string",
    override_strategy="string",
    ssl_settings={
        "certificate_id": "string",
        "ssl_management_type": google_native.appengine.v1beta.SslSettingsSslManagementType.AUTOMATIC,
    })
Copy
const exampledomainMappingResourceResourceFromAppenginev1beta = new google_native.appengine.v1beta.DomainMapping("exampledomainMappingResourceResourceFromAppenginev1beta", {
    appId: "string",
    id: "string",
    overrideStrategy: "string",
    sslSettings: {
        certificateId: "string",
        sslManagementType: google_native.appengine.v1beta.SslSettingsSslManagementType.Automatic,
    },
});
Copy
type: google-native:appengine/v1beta:DomainMapping
properties:
    appId: string
    id: string
    overrideStrategy: string
    sslSettings:
        certificateId: string
        sslManagementType: AUTOMATIC
Copy

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:

AppId
This property is required.
Changes to this property will trigger replacement.
string
Id 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.
SslSettings Pulumi.GoogleNative.AppEngine.V1Beta.Inputs.SslSettings
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
AppId
This property is required.
Changes to this property will trigger replacement.
string
Id 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.
SslSettings SslSettingsArgs
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
appId
This property is required.
Changes to this property will trigger replacement.
String
id 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.
sslSettings SslSettings
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
appId
This property is required.
Changes to this property will trigger replacement.
string
id 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.
sslSettings SslSettings
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
app_id
This property is required.
Changes to this property will trigger replacement.
str
id 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.
ssl_settings SslSettingsArgs
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
appId
This property is required.
Changes to this property will trigger replacement.
String
id 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.
sslSettings Property Map
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

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
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
ResourceRecords List<Pulumi.GoogleNative.AppEngine.V1Beta.Outputs.ResourceRecordResponse>
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.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
ResourceRecords []ResourceRecordResponse
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.
id String
The provider-assigned unique ID for this managed resource.
name String
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
resourceRecords List<ResourceRecordResponse>
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.
id string
The provider-assigned unique ID for this managed resource.
name string
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
resourceRecords ResourceRecordResponse[]
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.
id str
The provider-assigned unique ID for this managed resource.
name str
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
resource_records Sequence[ResourceRecordResponse]
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.
id String
The provider-assigned unique ID for this managed resource.
name String
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
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.

Supporting Types

ResourceRecordResponse
, ResourceRecordResponseArgs

Name This property is required. string
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
Rrdata This property is required. 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 This property is required. string
Resource record type. Example: AAAA.
Name This property is required. string
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
Rrdata This property is required. 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 This property is required. string
Resource record type. Example: AAAA.
name This property is required. String
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
rrdata This property is required. 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 This property is required. String
Resource record type. Example: AAAA.
name This property is required. string
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
rrdata This property is required. 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 This property is required. string
Resource record type. Example: AAAA.
name This property is required. str
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
rrdata This property is required. 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 This property is required. str
Resource record type. Example: AAAA.
name This property is required. String
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
rrdata This property is required. 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 This property is required. String
Resource record type. Example: AAAA.

SslSettings
, SslSettingsArgs

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.
SslManagementType Pulumi.GoogleNative.AppEngine.V1Beta.SslSettingsSslManagementType
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
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.
SslManagementType SslSettingsSslManagementType
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
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.
sslManagementType SslSettingsSslManagementType
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
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.
sslManagementType SslSettingsSslManagementType
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
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.
ssl_management_type SslSettingsSslManagementType
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
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.
sslManagementType "AUTOMATIC" | "MANUAL"
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.

SslSettingsResponse
, SslSettingsResponseArgs

CertificateId This property is required. 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 This property is required. string
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
SslManagementType This property is required. string
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
CertificateId This property is required. 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 This property is required. string
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
SslManagementType This property is required. string
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
certificateId This property is required. 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 This property is required. String
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
sslManagementType This property is required. String
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
certificateId This property is required. 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 This property is required. string
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
sslManagementType This property is required. string
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
certificate_id This property is required. 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 This property is required. str
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
ssl_management_type This property is required. str
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
certificateId This property is required. 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 This property is required. String
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 certificate_id 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 certificate_id field with an UpdateDomainMappingRequest.
sslManagementType This property is required. String
SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.

SslSettingsSslManagementType
, SslSettingsSslManagementTypeArgs

Automatic
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
Manual
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
SslSettingsSslManagementTypeAutomatic
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
SslSettingsSslManagementTypeManual
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
Automatic
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
Manual
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
Automatic
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
Manual
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
AUTOMATIC
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
MANUAL
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
"AUTOMATIC"
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
"MANUAL"
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native