Class: Aws::Amplify::Types::UpdateDomainAssociationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Amplify::Types::UpdateDomainAssociationRequest

Defined in:

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

Overview

The request structure for the update 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.

• #domain_name ⇒ String

  The name of the domain.

• #enable_auto_sub_domain ⇒ Boolean

  Enables the automated creation of subdomains for branches.

• #sub_domain_settings ⇒ Array<Types::SubDomainSetting>

  Describes the settings for the subdomain.

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

• (String)

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

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

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets the branch patterns for automatic subdomain creation.

Returns:

• (Array<String>)

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

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

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

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

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

#sub_domain_settings ⇒ Array<Types::SubDomainSetting>

Describes the settings for the subdomain.

Returns:

• (Array<Types::SubDomainSetting>)

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

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