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

Inherits:
Struct
  • Object
show all
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.

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>)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_roleString

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

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_recordString

The DNS record for certificate verification.

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_arnString

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

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_nameString

The name of the domain.

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_statusString

The current status of the domain association.

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_domainBoolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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_reasonString

The reason for the current status of the domain association.

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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

The subdomains for the domain association.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1333

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