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
    },
  ],
  auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
  auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
}

The request structure for the create domain association request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_sub_domain_creation_patternsArray<String>

Sets the branch patterns for automatic subdomain creation.

Returns:

  • (Array<String>)


944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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


944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The domain name for the domain association.

Returns:

  • (String)


944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_sub_domainBoolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean)


944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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)
  SENSITIVE = []
  include Aws::Structure
end

#sub_domain_settingsArray<Types::SubDomainSetting>

The setting for the subdomain.

Returns:



944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 944

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)
  SENSITIVE = []
  include Aws::Structure
end