DomainMapping

A domain serving an App Engine application.

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, domain_name=None, override_strategy=None, project=None, ssl_settings=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:

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.
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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SslSettings DomainMappingSslSettings: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sslSettings DomainMappingSslSettings: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ssl_settings Dict[DomainMappingSslSettings]: 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: Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
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.

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 []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.

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

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

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, domain_name=None, name=None, override_strategy=None, project=None, resource_records=None, ssl_settings=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:

DomainName string: Relative name of the domain serving the application. Example: example.com.
Name string: Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
OverrideStrategy string: Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
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.
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: Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
OverrideStrategy string: Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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.
SslSettings DomainMappingSslSettings: 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: Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
overrideStrategy string: Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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.
sslSettings DomainMappingSslSettings: 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: Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
override_strategy str: Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resource_records 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.
ssl_settings Dict[DomainMappingSslSettings]: SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. Structure is documented below.

Supporting Types

DomainMappingResourceRecord

See the output API doc for this type.

Name string
Rrdata string
Type string

Name string
Rrdata string
Type string

name string
rrdata string
type string

name str
rrdata str
type str

DomainMappingSslSettings

See the input and output API doc for this type.

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.
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: - 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.
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: - 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.
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: - 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 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.
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.
pendingManagedCertificateId 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 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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud