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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

Describes a domain association that associates a custom domain with 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_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

  The reason for the current status of the domain association.

• #sub_domains ⇒ Array<Types::SubDomain>

  The subdomains for the domain association.

Instance Attribute Details

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets branch patterns for automatic subdomain creation.

Returns:

• (Array<String>)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  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 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1377

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_verification_dns_record ⇒ String

The DNS record for certificate verification.

Returns:

• (String)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#domain_association_arn ⇒ String

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

Returns:

• (String)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The name of the domain.

Returns:

• (String)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#domain_status ⇒ String

The current status of the domain association.

Returns:

• (String)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_sub_domain ⇒ Boolean

Enables the automated creation of subdomains for branches.

Returns:

• (Boolean)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason for the current status of the domain association.

Returns:

• (String)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end

#sub_domains ⇒ Array<Types::SubDomain>

The subdomains for the domain association.

Returns:

• (Array<Types::SubDomain>)

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

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,
  :status_reason,
  :certificate_verification_dns_record,
  :sub_domains)
  SENSITIVE = []
  include Aws::Structure
end