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

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

Overview

The request structure for the create domain association request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:

  • (Array<String>) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:

  • (Boolean) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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.

Returns:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1009

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