AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes the association between a custom domain and an Amplify app.

Inheritance Hierarchy

System.Object
  Amazon.Amplify.Model.DomainAssociation

Namespace: Amazon.Amplify.Model
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z

Syntax

C#
public class DomainAssociation

The DomainAssociation type exposes the following members

Constructors

NameDescription
Public Method DomainAssociation()

Properties

NameTypeDescription
Public Property AutoSubDomainCreationPatterns System.Collections.Generic.List<System.String>

Gets and sets the property AutoSubDomainCreationPatterns.

Sets branch patterns for automatic subdomain creation.

Public Property AutoSubDomainIAMRole System.String

Gets and sets the property AutoSubDomainIAMRole.

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Public Property Certificate Amazon.Amplify.Model.Certificate

Gets and sets the property Certificate.

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

Public Property CertificateVerificationDNSRecord System.String

Gets and sets the property CertificateVerificationDNSRecord.

The DNS record for certificate verification.

Public Property DomainAssociationArn System.String

Gets and sets the property DomainAssociationArn.

The Amazon Resource Name (ARN) for the domain association.

Public Property DomainName System.String

Gets and sets the property DomainName.

The name of the domain.

Public Property DomainStatus Amazon.Amplify.DomainStatus

Gets and sets the property DomainStatus.

The current status of the domain association.

Public Property EnableAutoSubDomain System.Boolean

Gets and sets the property EnableAutoSubDomain.

Enables the automated creation of subdomains for branches.

Public Property StatusReason System.String

Gets and sets the property StatusReason.

Additional information that describes why the domain association is in the current state.

Public Property SubDomains System.Collections.Generic.List<Amazon.Amplify.Model.SubDomain>

Gets and sets the property SubDomains.

The subdomains for the domain association.

Public Property UpdateStatus Amazon.Amplify.UpdateStatus

Gets and sets the property UpdateStatus.

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on RouteĀ 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5