Class: Aws::Amplify::Types::CreateDomainAssociationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Amplify::Types::CreateDomainAssociationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-amplify/types.rb

Overview

The request structure for the create domain association request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_id ⇒ String

  The unique ID for an Amplify app.

• #auto_sub_domain_creation_patterns ⇒ Array<String>

  Sets the 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_settings ⇒ Types::CertificateSettings

  The type of SSL/TLS certificate to use for your custom domain.

• #domain_name ⇒ String

  The domain name for the domain association.

• #enable_auto_sub_domain ⇒ Boolean

  Enables the automated creation of subdomains for branches.

• #sub_domain_settings ⇒ Array<Types::SubDomainSetting>

  The setting for the subdomain.

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets the branch patterns for automatic subdomain creation.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  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.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_settings ⇒ Types::CertificateSettings

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name for the domain association.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_sub_domain ⇒ Boolean

Enables the automated creation of subdomains for branches.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#sub_domain_settings ⇒ Array<Types::SubDomainSetting>

The setting for the subdomain.

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

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings,
  :auto_sub_domain_creation_patterns,
  :auto_sub_domain_iam_role,
  :certificate_settings)
  SENSITIVE = []
  include Aws::Structure
end