You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateDomainAssociationRequest data as a hash:

{
  app_id: "AppId", # required
  domain_name: "DomainName", # required
  enable_auto_sub_domain: false,
  sub_domain_settings: [ # required
    {
      prefix: "DomainPrefix", # required
      branch_name: "BranchName", # required
    },
  ],
}

Request structure for create Domain Association request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 676

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings)
  include Aws::Structure
end

#domain_nameString

Domain name for the Domain Association.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 676

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings)
  include Aws::Structure
end

#enable_auto_sub_domainBoolean

Enables automated creation of Subdomains for branches.

Returns:

  • (Boolean)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 676

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings)
  include Aws::Structure
end

#sub_domain_settingsArray<Types::SubDomainSetting>

Setting structure for the Subdomain.

Returns:



676
677
678
679
680
681
682
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 676

class CreateDomainAssociationRequest < Struct.new(
  :app_id,
  :domain_name,
  :enable_auto_sub_domain,
  :sub_domain_settings)
  include Aws::Structure
end