Class: Aws::Amplify::Types::DomainAssociation

Inherits:

Struct

• Object
• Struct
• Aws::Amplify::Types::DomainAssociation

Includes:

Structure

Defined in:

lib/aws-sdk-amplify/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_sub_domain_creation_patterns ⇒ Array<String>

  Sets branch patterns for automatic subdomain creation.

• #auto_sub_domain_iam_role ⇒ String

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

• #certificate ⇒ Types::Certificate

  Describes the SSL/TLS certificate for the domain association.

• #certificate_verification_dns_record ⇒ String

  The DNS record for certificate verification.

• #domain_association_arn ⇒ String

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

• #domain_name ⇒ String

  The name of the domain.

• #domain_status ⇒ String

  The current status of the domain association.

• #enable_auto_sub_domain ⇒ Boolean

  Enables the automated creation of subdomains for branches.

• #status_reason ⇒ String

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

• #sub_domains ⇒ Array<Types::SubDomain>

  The subdomains for the domain association.

• #update_status ⇒ String

  The status of the domain update operation that is currently in progress.

Instance Attribute Details

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets branch patterns for automatic subdomain creation.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#auto_sub_domain_iam_role ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#certificate ⇒ Types::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.

Returns:

• (Types::Certificate)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_verification_dns_record ⇒ String

The DNS record for certificate verification.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#domain_association_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The name of the domain.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#domain_status ⇒ String

The current status of the domain association.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_sub_domain ⇒ Boolean

Enables the automated creation of subdomains for branches.

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#sub_domains ⇒ Array<Types::SubDomain>

The subdomains for the domain association.

Returns:

• (Array<Types::SubDomain>)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end

#update_status ⇒ String

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

[1]: docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 1524

class DomainAssociation < Struct.new(
  :domain_association_arn,
  :domain_name,
  :enable_auto_sub_domain,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :domain_status,
  :update_status,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains,
  :certificate)
  SENSITIVE = []
  include Aws::Structure
end