You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a domain association that associates a custom domain with an Amplify app.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets branch patterns for automatic subdomain creation.

Returns:

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

Returns:

  • (String) —

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

#certificate_verification_dns_record ⇒ String

The DNS record for certificate verification.

Returns:

  • (String) —

    The DNS record for certificate verification.

#domain_association_arn ⇒ String

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

Returns:

  • (String) —

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

#domain_name ⇒ String

The name of the domain.

Returns:

  • (String) —

    The name of the domain.

#domain_status ⇒ String

The current status of the domain association.

Possible values:

  • PENDING_VERIFICATION
  • IN_PROGRESS
  • AVAILABLE
  • PENDING_DEPLOYMENT
  • FAILED
  • CREATING
  • REQUESTING_CERTIFICATE
  • UPDATING

Returns:

  • (String) —

    The current status of the domain association.

#enable_auto_sub_domain ⇒ Boolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean) —

    Enables the automated creation of subdomains for branches.

#status_reason ⇒ String

The reason for the current status of the domain association.

Returns:

  • (String) —

    The reason for the current status of the domain association.

#sub_domains ⇒ Array<Types::SubDomain>

The subdomains for the domain association.

Returns: