DomainMapping

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

new DomainMapping(name: string, args: DomainMappingArgs, opts?: CustomResourceOptions);
@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)
@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: google-native:appengine/v1: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:

AppId 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.V1.Inputs.SslSettingsArgs

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

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

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

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.

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.

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.

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.

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.

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.

SslSettings

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.V1.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 "SSL_MANAGEMENT_TYPE_UNSPECIFIED" | "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

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

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

SslManagementTypeUnspecified
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

Automatic
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

Manual
MANUAL

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

SslSettingsSslManagementTypeSslManagementTypeUnspecified
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

SslSettingsSslManagementTypeAutomatic
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

SslSettingsSslManagementTypeManual
MANUAL

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

SslManagementTypeUnspecified
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

Automatic
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

Manual
MANUAL

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

SslManagementTypeUnspecified
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

Automatic
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

Manual
MANUAL

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

SSL_MANAGEMENT_TYPE_UNSPECIFIED
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

AUTOMATIC
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

MANUAL
MANUAL

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

"SSL_MANAGEMENT_TYPE_UNSPECIFIED"
SSL_MANAGEMENT_TYPE_UNSPECIFIED

Defaults to AUTOMATIC.

"AUTOMATIC"
AUTOMATIC

SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.

"MANUAL"
MANUAL

SSL 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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0