CustomDomain class

Creates a CustomDomain. Auto-naming is currently not supported for this resource.

Constructors

CustomDomain(String name, {CustomDomainArgs? args, CustomResourceOptions? options})

Creates a new CustomDomain. name The Pulumi resource name. args Arguments used to configure this CustomDomain. The set of arguments for CustomDomain. options Resource options controlling this resource's behavior.

Properties

annotations ↔ Output<Map<String, String>>

Annotations you can add to leave both human- and machine-readable metadata about your CustomDomain.

late, final

cert ↔ Output<CertificateResponse>

The SSL certificate Hosting has for this custom domain's domain name. For new custom domains, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check the state field for more.

late, final

certPreference ↔ Output<String>

A field that lets you specify which SSL certificate type Hosting creates for your domain name. Spark plan custom domains only have access to the GROUPED cert type, while Blaze plan domains can select any option.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The custom domain's create time.

late, final

customDomainId ↔ Output<String>

Required. The ID of the CustomDomain, which is the domain name you'd like to use with Firebase Hosting.

late, final

deleteTime ↔ Output<String>

The time the CustomDomain was deleted; null for custom domains that haven't been deleted. Deleted custom domains persist for approximately 30 days, after which time Hosting removes them completely. To restore a deleted custom domain, make an UndeleteCustomDomain request.

late, final

etag ↔ Output<String>

A string that represents the current state of the CustomDomain and allows you to confirm its initial state in requests that would modify it. Use the tag to ensure consistency when making UpdateCustomDomain, DeleteCustomDomain, and UndeleteCustomDomain requests.

late, final

expireTime ↔ Output<String>

The minimum time before a soft-deleted CustomDomain is completely removed from Hosting; null for custom domains that haven't been deleted.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

hostState ↔ Output<String>

The HostState of the domain name this CustomDomain refers to.

late, final

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

issues ↔ Output<List<Map<String, dynamic>>>

A set of errors Hosting systems encountered when trying to establish Hosting's ability to serve secure content for your domain name. Resolve these issues to ensure your CustomDomain behaves properly.

late, final

labels ↔ Output<Map<String, String>>

Labels used for extra metadata and/or filtering.

late, final

name ↔ Output<String>

The fully-qualified name of the CustomDomain.

late, final

ownershipState ↔ Output<String>

The OwnershipState of the domain name this CustomDomain refers to.

late, final

project ↔ Output<String>

late, final

reconciling ↔ Output<bool>

A field that, if true, indicates that Hosting's systems are attmepting to make the custom domain's state match your preferred state. This is most frequently true when initially provisioning a CustomDomain after a CreateCustomDomain request or when creating a new SSL certificate to match an updated cert_preference after an UpdateCustomDomain request.

late, final

redirectTarget ↔ Output<String>

A domain name that this CustomDomain should direct traffic towards. If specified, Hosting will respond to requests against this custom domain with an HTTP 301 code, and route traffic to the specified redirect_target instead.

late, final

requiredDnsUpdates ↔ Output<DnsUpdatesResponse>

A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

siteId ↔ Output<String>

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The last time the CustomDomain was updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited