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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_sub_domain_creation_patternsArray<String>

Sets branch patterns for automatic subdomain creation.

Returns:

  • (Array<String>)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_roleString

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

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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

#certificateTypes::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:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_recordString

The DNS record for certificate verification.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_arnString

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

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_nameString

The name of the domain.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_statusString

The current status of the domain association.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_domainBoolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_reasonString

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

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_domainsArray<Types::SubDomain>

The subdomains for the domain association.

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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_statusString

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.

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1513

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