Class: Aws::DirectoryService::Types::CreateTrustRequest

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

Overview

Note:

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

{
  directory_id: "DirectoryId", # required
  remote_domain_name: "RemoteDomainName", # required
  trust_password: "TrustPassword", # required
  trust_direction: "One-Way: Outgoing", # required, accepts One-Way: Outgoing, One-Way: Incoming, Two-Way
  trust_type: "Forest", # accepts Forest, External
  conditional_forwarder_ip_addrs: ["IpAddr"],
  selective_auth: "Enabled", # accepts Enabled, Disabled
}

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

Constant Summary collapse

SENSITIVE =
[:trust_password]

Instance Attribute Summary collapse

Instance Attribute Details

#conditional_forwarder_ip_addrsArray<String>

The IP addresses of the remote DNS server associated with RemoteDomainName.

Returns:

  • (Array<String>)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#directory_idString

The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#remote_domain_nameString

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#selective_authString

Optional parameter to enable selective authentication for the trust.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#trust_directionString

The direction of the trust relationship.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#trust_passwordString

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end

#trust_typeString

The trust relationship type. Forest is the default.

Returns:

  • (String)


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1200

class CreateTrustRequest < Struct.new(
  :directory_id,
  :remote_domain_name,
  :trust_password,
  :trust_direction,
  :trust_type,
  :conditional_forwarder_ip_addrs,
  :selective_auth)
  SENSITIVE = [:trust_password]
  include Aws::Structure
end