aws-sdk-directoryservice 1.87.0 → 1.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-directoryservice/client.rb +547 -4
- data/lib/aws-sdk-directoryservice/client_api.rb +303 -0
- data/lib/aws-sdk-directoryservice/errors.rb +21 -0
- data/lib/aws-sdk-directoryservice/types.rb +754 -7
- data/lib/aws-sdk-directoryservice/waiters.rb +120 -0
- data/lib/aws-sdk-directoryservice.rb +2 -1
- data/sig/client.rbs +110 -0
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +188 -0
- data/sig/waiters.rbs +12 -0
- metadata +2 -1
@@ -10,6 +10,36 @@
|
|
10
10
|
module Aws::DirectoryService
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# A directory assessment is automatically created when you create a
|
14
|
+
# hybrid directory. There are two types of assessments: `CUSTOMER` and
|
15
|
+
# `SYSTEM`. Your Amazon Web Services account has a limit of 100
|
16
|
+
# `CUSTOMER` directory assessments.
|
17
|
+
#
|
18
|
+
# If you attempt to create a hybrid directory; and you already have 100
|
19
|
+
# `CUSTOMER` directory assessments;, you will encounter an error. Delete
|
20
|
+
# assessments to free up capacity before trying again.
|
21
|
+
#
|
22
|
+
# You can request an increase to your `CUSTOMER` directory assessment
|
23
|
+
# quota by contacting customer support or delete existing CUSTOMER
|
24
|
+
# directory assessments; to free up capacity.
|
25
|
+
#
|
26
|
+
# @!attribute [rw] message
|
27
|
+
# The descriptive message for the exception.
|
28
|
+
# @return [String]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] request_id
|
31
|
+
# The Amazon Web Services request identifier.
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ADAssessmentLimitExceededException AWS API Documentation
|
35
|
+
#
|
36
|
+
class ADAssessmentLimitExceededException < Struct.new(
|
37
|
+
:message,
|
38
|
+
:request_id)
|
39
|
+
SENSITIVE = []
|
40
|
+
include Aws::Structure
|
41
|
+
end
|
42
|
+
|
13
43
|
# @!attribute [rw] shared_directory_id
|
14
44
|
# Identifier of the shared directory in the directory consumer
|
15
45
|
# account. This identifier is different for each directory owner
|
@@ -162,8 +192,8 @@ module Aws::DirectoryService
|
|
162
192
|
# @return [String]
|
163
193
|
#
|
164
194
|
# @!attribute [rw] vpc_settings
|
165
|
-
# Contains VPC information for the CreateDirectory
|
166
|
-
#
|
195
|
+
# Contains VPC information for the CreateDirectory, CreateMicrosoftAD,
|
196
|
+
# or CreateHybridAD operation.
|
167
197
|
# @return [Types::DirectoryVpcSettings]
|
168
198
|
#
|
169
199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AddRegionRequest AWS API Documentation
|
@@ -201,6 +231,270 @@ module Aws::DirectoryService
|
|
201
231
|
#
|
202
232
|
class AddTagsToResourceResult < Aws::EmptyStructure; end
|
203
233
|
|
234
|
+
# Contains detailed information about a directory assessment, including
|
235
|
+
# configuration parameters, status, and validation results.
|
236
|
+
#
|
237
|
+
# @!attribute [rw] assessment_id
|
238
|
+
# The unique identifier of the directory assessment.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @!attribute [rw] directory_id
|
242
|
+
# The identifier of the directory associated with this assessment.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] dns_name
|
246
|
+
# The fully qualified domain name (FQDN) of the Active Directory
|
247
|
+
# domain being assessed.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] start_time
|
251
|
+
# The date and time when the assessment was initiated.
|
252
|
+
# @return [Time]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] last_update_date_time
|
255
|
+
# The date and time when the assessment status was last updated.
|
256
|
+
# @return [Time]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] status
|
259
|
+
# The current status of the assessment. Valid values include
|
260
|
+
# `SUCCESS`, `FAILED`, `PENDING`, and `IN_PROGRESS`.
|
261
|
+
# @return [String]
|
262
|
+
#
|
263
|
+
# @!attribute [rw] status_code
|
264
|
+
# A detailed status code providing additional information about the
|
265
|
+
# assessment state.
|
266
|
+
# @return [String]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] status_reason
|
269
|
+
# A human-readable description of the current assessment status,
|
270
|
+
# including any error details or progress information.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] customer_dns_ips
|
274
|
+
# The IP addresses of the DNS servers or domain controllers in your
|
275
|
+
# self-managed AD environment.
|
276
|
+
# @return [Array<String>]
|
277
|
+
#
|
278
|
+
# @!attribute [rw] vpc_id
|
279
|
+
# Contains Amazon VPC information for the `StartADAssessment`
|
280
|
+
# operation.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] subnet_ids
|
284
|
+
# A list of subnet identifiers in the Amazon VPC in which the hybrid
|
285
|
+
# directory is created.
|
286
|
+
# @return [Array<String>]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] security_group_ids
|
289
|
+
# The security groups identifiers attached to the network interfaces.
|
290
|
+
# @return [Array<String>]
|
291
|
+
#
|
292
|
+
# @!attribute [rw] self_managed_instance_ids
|
293
|
+
# The identifiers of the self-managed AD instances used to perform the
|
294
|
+
# assessment.
|
295
|
+
# @return [Array<String>]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] report_type
|
298
|
+
# The type of assessment report generated. Valid values are `CUSTOMER`
|
299
|
+
# and `SYSTEM`.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @!attribute [rw] version
|
303
|
+
# The version of the assessment framework used to evaluate your
|
304
|
+
# self-managed AD environment.
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/Assessment AWS API Documentation
|
308
|
+
#
|
309
|
+
class Assessment < Struct.new(
|
310
|
+
:assessment_id,
|
311
|
+
:directory_id,
|
312
|
+
:dns_name,
|
313
|
+
:start_time,
|
314
|
+
:last_update_date_time,
|
315
|
+
:status,
|
316
|
+
:status_code,
|
317
|
+
:status_reason,
|
318
|
+
:customer_dns_ips,
|
319
|
+
:vpc_id,
|
320
|
+
:subnet_ids,
|
321
|
+
:security_group_ids,
|
322
|
+
:self_managed_instance_ids,
|
323
|
+
:report_type,
|
324
|
+
:version)
|
325
|
+
SENSITIVE = []
|
326
|
+
include Aws::Structure
|
327
|
+
end
|
328
|
+
|
329
|
+
# Contains configuration parameters required to perform a directory
|
330
|
+
# assessment.
|
331
|
+
#
|
332
|
+
# @!attribute [rw] customer_dns_ips
|
333
|
+
# A list of IP addresses for the DNS servers or domain controllers in
|
334
|
+
# your self-managed AD that are tested during the assessment.
|
335
|
+
# @return [Array<String>]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] dns_name
|
338
|
+
# The fully qualified domain name (FQDN) of the self-managed AD domain
|
339
|
+
# to assess.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] vpc_settings
|
343
|
+
# Contains VPC information for the CreateDirectory, CreateMicrosoftAD,
|
344
|
+
# or CreateHybridAD operation.
|
345
|
+
# @return [Types::DirectoryVpcSettings]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] instance_ids
|
348
|
+
# The identifiers of the self-managed instances with SSM that are used
|
349
|
+
# to perform connectivity and validation tests.
|
350
|
+
# @return [Array<String>]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] security_group_ids
|
353
|
+
# By default, the service attaches a security group to allow network
|
354
|
+
# access to the self-managed nodes in your Amazon VPC. You can
|
355
|
+
# optionally supply your own security group that allows network
|
356
|
+
# traffic to and from your self-managed domain controllers outside of
|
357
|
+
# your Amazon VPC.
|
358
|
+
# @return [Array<String>]
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AssessmentConfiguration AWS API Documentation
|
361
|
+
#
|
362
|
+
class AssessmentConfiguration < Struct.new(
|
363
|
+
:customer_dns_ips,
|
364
|
+
:dns_name,
|
365
|
+
:vpc_settings,
|
366
|
+
:instance_ids,
|
367
|
+
:security_group_ids)
|
368
|
+
SENSITIVE = []
|
369
|
+
include Aws::Structure
|
370
|
+
end
|
371
|
+
|
372
|
+
# Contains the results of validation tests performed against a specific
|
373
|
+
# domain controller during a directory assessment.
|
374
|
+
#
|
375
|
+
# @!attribute [rw] domain_controller_ip
|
376
|
+
# The IP address of the domain controller that was tested during the
|
377
|
+
# assessment.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] validations
|
381
|
+
# A list of validation results for different test categories performed
|
382
|
+
# against this domain controller.
|
383
|
+
# @return [Array<Types::AssessmentValidation>]
|
384
|
+
#
|
385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AssessmentReport AWS API Documentation
|
386
|
+
#
|
387
|
+
class AssessmentReport < Struct.new(
|
388
|
+
:domain_controller_ip,
|
389
|
+
:validations)
|
390
|
+
SENSITIVE = []
|
391
|
+
include Aws::Structure
|
392
|
+
end
|
393
|
+
|
394
|
+
# Contains summary information about a directory assessment, providing a
|
395
|
+
# high-level overview without detailed validation results.
|
396
|
+
#
|
397
|
+
# @!attribute [rw] assessment_id
|
398
|
+
# The unique identifier of the directory assessment.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] directory_id
|
402
|
+
# The identifier of the directory associated with this assessment.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] dns_name
|
406
|
+
# The fully qualified domain name (FQDN) of the Active Directory
|
407
|
+
# domain being assessed.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] start_time
|
411
|
+
# The date and time when the assessment was initiated.
|
412
|
+
# @return [Time]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] last_update_date_time
|
415
|
+
# The date and time when the assessment status was last updated.
|
416
|
+
# @return [Time]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] status
|
419
|
+
# The current status of the assessment. Valid values include
|
420
|
+
# `SUCCESS`, `FAILED`, `PENDING`, and `IN_PROGRESS`.
|
421
|
+
# @return [String]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] customer_dns_ips
|
424
|
+
# The IP addresses of the DNS servers or domain controllers in your
|
425
|
+
# self-managed AD environment.
|
426
|
+
# @return [Array<String>]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] report_type
|
429
|
+
# The type of assessment report generated. Valid values include
|
430
|
+
# `CUSTOMER` and `SYSTEM`.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AssessmentSummary AWS API Documentation
|
434
|
+
#
|
435
|
+
class AssessmentSummary < Struct.new(
|
436
|
+
:assessment_id,
|
437
|
+
:directory_id,
|
438
|
+
:dns_name,
|
439
|
+
:start_time,
|
440
|
+
:last_update_date_time,
|
441
|
+
:status,
|
442
|
+
:customer_dns_ips,
|
443
|
+
:report_type)
|
444
|
+
SENSITIVE = []
|
445
|
+
include Aws::Structure
|
446
|
+
end
|
447
|
+
|
448
|
+
# Contains information about a specific validation test performed during
|
449
|
+
# a directory assessment.
|
450
|
+
#
|
451
|
+
# @!attribute [rw] category
|
452
|
+
# The category of the validation test.
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] name
|
456
|
+
# The name of the specific validation test performed within the
|
457
|
+
# category.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] status
|
461
|
+
# The result status of the validation test. Valid values include
|
462
|
+
# `SUCCESS`, `FAILED`, `PENDING`, and `IN_PROGRESS`.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] status_code
|
466
|
+
# A detailed status code providing additional information about the
|
467
|
+
# validation result.
|
468
|
+
# @return [String]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] status_reason
|
471
|
+
# A human-readable description of the validation result, including any
|
472
|
+
# error details or recommendations.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] start_time
|
476
|
+
# The date and time when the validation test was started.
|
477
|
+
# @return [Time]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] last_update_date_time
|
480
|
+
# The date and time when the validation test was completed or last
|
481
|
+
# updated.
|
482
|
+
# @return [Time]
|
483
|
+
#
|
484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AssessmentValidation AWS API Documentation
|
485
|
+
#
|
486
|
+
class AssessmentValidation < Struct.new(
|
487
|
+
:category,
|
488
|
+
:name,
|
489
|
+
:status,
|
490
|
+
:status_code,
|
491
|
+
:status_reason,
|
492
|
+
:start_time,
|
493
|
+
:last_update_date_time)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
204
498
|
# Represents a named directory attribute.
|
205
499
|
#
|
206
500
|
# @!attribute [rw] name
|
@@ -836,6 +1130,52 @@ module Aws::DirectoryService
|
|
836
1130
|
include Aws::Structure
|
837
1131
|
end
|
838
1132
|
|
1133
|
+
# @!attribute [rw] secret_arn
|
1134
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Secrets
|
1135
|
+
# Manager secret that contains the credentials for the service account
|
1136
|
+
# used to join hybrid domain controllers to your self-managed AD
|
1137
|
+
# domain. This secret is used once and not stored.
|
1138
|
+
#
|
1139
|
+
# The secret must contain key-value pairs with keys matching
|
1140
|
+
# `customerAdAdminDomainUsername` and `customerAdAdminDomainPassword`.
|
1141
|
+
# For example:
|
1142
|
+
# `{"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}`.
|
1143
|
+
# @return [String]
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] assessment_id
|
1146
|
+
# The unique identifier of the successful directory assessment that
|
1147
|
+
# validates your self-managed AD environment. You must have a
|
1148
|
+
# successful directory assessment before you create a hybrid
|
1149
|
+
# directory.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] tags
|
1153
|
+
# The tags to be assigned to the directory. Each tag consists of a key
|
1154
|
+
# and value pair. You can specify multiple tags as a list.
|
1155
|
+
# @return [Array<Types::Tag>]
|
1156
|
+
#
|
1157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateHybridADRequest AWS API Documentation
|
1158
|
+
#
|
1159
|
+
class CreateHybridADRequest < Struct.new(
|
1160
|
+
:secret_arn,
|
1161
|
+
:assessment_id,
|
1162
|
+
:tags)
|
1163
|
+
SENSITIVE = []
|
1164
|
+
include Aws::Structure
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# @!attribute [rw] directory_id
|
1168
|
+
# The unique identifier of the newly created hybrid directory.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateHybridADResult AWS API Documentation
|
1172
|
+
#
|
1173
|
+
class CreateHybridADResult < Struct.new(
|
1174
|
+
:directory_id)
|
1175
|
+
SENSITIVE = []
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1178
|
+
|
839
1179
|
# @!attribute [rw] directory_id
|
840
1180
|
# Identifier of the directory to which you want to subscribe and
|
841
1181
|
# receive real-time logs to your specified CloudWatch log group.
|
@@ -1034,6 +1374,30 @@ module Aws::DirectoryService
|
|
1034
1374
|
include Aws::Structure
|
1035
1375
|
end
|
1036
1376
|
|
1377
|
+
# @!attribute [rw] assessment_id
|
1378
|
+
# The unique identifier of the directory assessment to delete.
|
1379
|
+
# @return [String]
|
1380
|
+
#
|
1381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteADAssessmentRequest AWS API Documentation
|
1382
|
+
#
|
1383
|
+
class DeleteADAssessmentRequest < Struct.new(
|
1384
|
+
:assessment_id)
|
1385
|
+
SENSITIVE = []
|
1386
|
+
include Aws::Structure
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
# @!attribute [rw] assessment_id
|
1390
|
+
# The unique identifier of the deleted directory assessment.
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteADAssessmentResult AWS API Documentation
|
1394
|
+
#
|
1395
|
+
class DeleteADAssessmentResult < Struct.new(
|
1396
|
+
:assessment_id)
|
1397
|
+
SENSITIVE = []
|
1398
|
+
include Aws::Structure
|
1399
|
+
end
|
1400
|
+
|
1037
1401
|
# Deletes a conditional forwarder.
|
1038
1402
|
#
|
1039
1403
|
# @!attribute [rw] directory_id
|
@@ -1217,6 +1581,38 @@ module Aws::DirectoryService
|
|
1217
1581
|
#
|
1218
1582
|
class DeregisterEventTopicResult < Aws::EmptyStructure; end
|
1219
1583
|
|
1584
|
+
# @!attribute [rw] assessment_id
|
1585
|
+
# The identifier of the directory assessment to describe.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeADAssessmentRequest AWS API Documentation
|
1589
|
+
#
|
1590
|
+
class DescribeADAssessmentRequest < Struct.new(
|
1591
|
+
:assessment_id)
|
1592
|
+
SENSITIVE = []
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
1596
|
+
# @!attribute [rw] assessment
|
1597
|
+
# Detailed information about the self-managed instance settings (IDs
|
1598
|
+
# and DNS IPs).
|
1599
|
+
# @return [Types::Assessment]
|
1600
|
+
#
|
1601
|
+
# @!attribute [rw] assessment_reports
|
1602
|
+
# A list of assessment reports containing validation results for each
|
1603
|
+
# domain controller and test category. Each report includes specific
|
1604
|
+
# validation details and outcomes.
|
1605
|
+
# @return [Array<Types::AssessmentReport>]
|
1606
|
+
#
|
1607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeADAssessmentResult AWS API Documentation
|
1608
|
+
#
|
1609
|
+
class DescribeADAssessmentResult < Struct.new(
|
1610
|
+
:assessment,
|
1611
|
+
:assessment_reports)
|
1612
|
+
SENSITIVE = []
|
1613
|
+
include Aws::Structure
|
1614
|
+
end
|
1615
|
+
|
1220
1616
|
# @!attribute [rw] directory_id
|
1221
1617
|
# The identifier of the directory.
|
1222
1618
|
# @return [String]
|
@@ -1514,6 +1910,51 @@ module Aws::DirectoryService
|
|
1514
1910
|
include Aws::Structure
|
1515
1911
|
end
|
1516
1912
|
|
1913
|
+
# @!attribute [rw] directory_id
|
1914
|
+
# The identifier of the hybrid directory for which to retrieve update
|
1915
|
+
# information.
|
1916
|
+
# @return [String]
|
1917
|
+
#
|
1918
|
+
# @!attribute [rw] update_type
|
1919
|
+
# The type of update activities to retrieve. Valid values include
|
1920
|
+
# `SelfManagedInstances` and `HybridAdministratorAccount`.
|
1921
|
+
# @return [String]
|
1922
|
+
#
|
1923
|
+
# @!attribute [rw] next_token
|
1924
|
+
# The pagination token from a previous request to
|
1925
|
+
# DescribeHybridADUpdate. Pass null if this is the first request.
|
1926
|
+
# @return [String]
|
1927
|
+
#
|
1928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeHybridADUpdateRequest AWS API Documentation
|
1929
|
+
#
|
1930
|
+
class DescribeHybridADUpdateRequest < Struct.new(
|
1931
|
+
:directory_id,
|
1932
|
+
:update_type,
|
1933
|
+
:next_token)
|
1934
|
+
SENSITIVE = []
|
1935
|
+
include Aws::Structure
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# @!attribute [rw] update_activities
|
1939
|
+
# Information about update activities for the hybrid directory,
|
1940
|
+
# organized by update type.
|
1941
|
+
# @return [Types::HybridUpdateActivities]
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] next_token
|
1944
|
+
# If not null, more results are available. Pass this value for the
|
1945
|
+
# `NextToken` parameter in a subsequent request to retrieve the next
|
1946
|
+
# set of items.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeHybridADUpdateResult AWS API Documentation
|
1950
|
+
#
|
1951
|
+
class DescribeHybridADUpdateResult < Struct.new(
|
1952
|
+
:update_activities,
|
1953
|
+
:next_token)
|
1954
|
+
SENSITIVE = []
|
1955
|
+
include Aws::Structure
|
1956
|
+
end
|
1957
|
+
|
1517
1958
|
# @!attribute [rw] directory_id
|
1518
1959
|
# The identifier of the directory.
|
1519
1960
|
# @return [String]
|
@@ -2128,6 +2569,12 @@ module Aws::DirectoryService
|
|
2128
2569
|
# The operating system (OS) version of the directory.
|
2129
2570
|
# @return [String]
|
2130
2571
|
#
|
2572
|
+
# @!attribute [rw] hybrid_settings
|
2573
|
+
# Contains information about the hybrid directory configuration for
|
2574
|
+
# the directory, including Amazon Web Services System Manager managed
|
2575
|
+
# node identifiers and DNS IPs.
|
2576
|
+
# @return [Types::HybridSettingsDescription]
|
2577
|
+
#
|
2131
2578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DirectoryDescription AWS API Documentation
|
2132
2579
|
#
|
2133
2580
|
class DirectoryDescription < Struct.new(
|
@@ -2156,7 +2603,8 @@ module Aws::DirectoryService
|
|
2156
2603
|
:desired_number_of_domain_controllers,
|
2157
2604
|
:owner_directory_description,
|
2158
2605
|
:regions_info,
|
2159
|
-
:os_version
|
2606
|
+
:os_version,
|
2607
|
+
:hybrid_settings)
|
2160
2608
|
SENSITIVE = [:share_notes]
|
2161
2609
|
include Aws::Structure
|
2162
2610
|
end
|
@@ -2316,8 +2764,8 @@ module Aws::DirectoryService
|
|
2316
2764
|
include Aws::Structure
|
2317
2765
|
end
|
2318
2766
|
|
2319
|
-
# Contains VPC information for the CreateDirectory
|
2320
|
-
# operation.
|
2767
|
+
# Contains VPC information for the CreateDirectory, CreateMicrosoftAD,
|
2768
|
+
# or CreateHybridAD operation.
|
2321
2769
|
#
|
2322
2770
|
# @!attribute [rw] vpc_id
|
2323
2771
|
# The identifier of the VPC in which to create the directory.
|
@@ -2826,6 +3274,172 @@ module Aws::DirectoryService
|
|
2826
3274
|
include Aws::Structure
|
2827
3275
|
end
|
2828
3276
|
|
3277
|
+
# Use to recover to the hybrid directory administrator account
|
3278
|
+
# credentials.
|
3279
|
+
#
|
3280
|
+
# @!attribute [rw] secret_arn
|
3281
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Secrets
|
3282
|
+
# Manager secret that contains the credentials for the AD
|
3283
|
+
# administrator user, and enables hybrid domain controllers to join
|
3284
|
+
# the managed AD domain. For example:
|
3285
|
+
#
|
3286
|
+
# `
|
3287
|
+
# {"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}.
|
3288
|
+
# `
|
3289
|
+
# @return [String]
|
3290
|
+
#
|
3291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridAdministratorAccountUpdate AWS API Documentation
|
3292
|
+
#
|
3293
|
+
class HybridAdministratorAccountUpdate < Struct.new(
|
3294
|
+
:secret_arn)
|
3295
|
+
SENSITIVE = []
|
3296
|
+
include Aws::Structure
|
3297
|
+
end
|
3298
|
+
|
3299
|
+
# Contains configuration settings for self-managed instances with SSM
|
3300
|
+
# used in hybrid directory operations.
|
3301
|
+
#
|
3302
|
+
# @!attribute [rw] customer_dns_ips
|
3303
|
+
# The IP addresses of the DNS servers or domain controllers in your
|
3304
|
+
# self-managed AD environment.
|
3305
|
+
# @return [Array<String>]
|
3306
|
+
#
|
3307
|
+
# @!attribute [rw] instance_ids
|
3308
|
+
# The identifiers of the self-managed instances with SSM used in
|
3309
|
+
# hybrid directory.
|
3310
|
+
# @return [Array<String>]
|
3311
|
+
#
|
3312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridCustomerInstancesSettings AWS API Documentation
|
3313
|
+
#
|
3314
|
+
class HybridCustomerInstancesSettings < Struct.new(
|
3315
|
+
:customer_dns_ips,
|
3316
|
+
:instance_ids)
|
3317
|
+
SENSITIVE = []
|
3318
|
+
include Aws::Structure
|
3319
|
+
end
|
3320
|
+
|
3321
|
+
# Describes the current hybrid directory configuration settings for a
|
3322
|
+
# directory.
|
3323
|
+
#
|
3324
|
+
# @!attribute [rw] self_managed_dns_ip_addrs
|
3325
|
+
# The IP addresses of the DNS servers in your self-managed AD
|
3326
|
+
# environment.
|
3327
|
+
# @return [Array<String>]
|
3328
|
+
#
|
3329
|
+
# @!attribute [rw] self_managed_instance_ids
|
3330
|
+
# The identifiers of the self-managed instances with SSM used for
|
3331
|
+
# hybrid directory operations.
|
3332
|
+
# @return [Array<String>]
|
3333
|
+
#
|
3334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridSettingsDescription AWS API Documentation
|
3335
|
+
#
|
3336
|
+
class HybridSettingsDescription < Struct.new(
|
3337
|
+
:self_managed_dns_ip_addrs,
|
3338
|
+
:self_managed_instance_ids)
|
3339
|
+
SENSITIVE = []
|
3340
|
+
include Aws::Structure
|
3341
|
+
end
|
3342
|
+
|
3343
|
+
# Contains information about update activities for different components
|
3344
|
+
# of a hybrid directory.
|
3345
|
+
#
|
3346
|
+
# @!attribute [rw] self_managed_instances
|
3347
|
+
# A list of update activities related to the self-managed instances
|
3348
|
+
# with SSM in the self-managed instances with SSM hybrid directory
|
3349
|
+
# configuration.
|
3350
|
+
# @return [Array<Types::HybridUpdateInfoEntry>]
|
3351
|
+
#
|
3352
|
+
# @!attribute [rw] hybrid_administrator_account
|
3353
|
+
# A list of update activities related to hybrid directory
|
3354
|
+
# administrator account changes.
|
3355
|
+
# @return [Array<Types::HybridUpdateInfoEntry>]
|
3356
|
+
#
|
3357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridUpdateActivities AWS API Documentation
|
3358
|
+
#
|
3359
|
+
class HybridUpdateActivities < Struct.new(
|
3360
|
+
:self_managed_instances,
|
3361
|
+
:hybrid_administrator_account)
|
3362
|
+
SENSITIVE = []
|
3363
|
+
include Aws::Structure
|
3364
|
+
end
|
3365
|
+
|
3366
|
+
# Contains detailed information about a specific update activity for a
|
3367
|
+
# hybrid directory component.
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] status
|
3370
|
+
# The current status of the update activity. Valid values include
|
3371
|
+
# `UPDATED`, `UPDATING`, and `UPDATE_FAILED`.
|
3372
|
+
# @return [String]
|
3373
|
+
#
|
3374
|
+
# @!attribute [rw] status_reason
|
3375
|
+
# A human-readable description of the update status, including any
|
3376
|
+
# error details or progress information.
|
3377
|
+
# @return [String]
|
3378
|
+
#
|
3379
|
+
# @!attribute [rw] initiated_by
|
3380
|
+
# Specifies if the update was initiated by the customer or Amazon Web
|
3381
|
+
# Services.
|
3382
|
+
# @return [String]
|
3383
|
+
#
|
3384
|
+
# @!attribute [rw] new_value
|
3385
|
+
# The new configuration values being applied in this update.
|
3386
|
+
# @return [Types::HybridUpdateValue]
|
3387
|
+
#
|
3388
|
+
# @!attribute [rw] previous_value
|
3389
|
+
# The previous configuration values before this update was applied.
|
3390
|
+
# @return [Types::HybridUpdateValue]
|
3391
|
+
#
|
3392
|
+
# @!attribute [rw] start_time
|
3393
|
+
# The date and time when the update activity was initiated.
|
3394
|
+
# @return [Time]
|
3395
|
+
#
|
3396
|
+
# @!attribute [rw] last_updated_date_time
|
3397
|
+
# The date and time when the update activity status was last updated.
|
3398
|
+
# @return [Time]
|
3399
|
+
#
|
3400
|
+
# @!attribute [rw] assessment_id
|
3401
|
+
# The identifier of the assessment performed to validate this update
|
3402
|
+
# configuration.
|
3403
|
+
# @return [String]
|
3404
|
+
#
|
3405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridUpdateInfoEntry AWS API Documentation
|
3406
|
+
#
|
3407
|
+
class HybridUpdateInfoEntry < Struct.new(
|
3408
|
+
:status,
|
3409
|
+
:status_reason,
|
3410
|
+
:initiated_by,
|
3411
|
+
:new_value,
|
3412
|
+
:previous_value,
|
3413
|
+
:start_time,
|
3414
|
+
:last_updated_date_time,
|
3415
|
+
:assessment_id)
|
3416
|
+
SENSITIVE = []
|
3417
|
+
include Aws::Structure
|
3418
|
+
end
|
3419
|
+
|
3420
|
+
# Contains the configuration values for a hybrid directory update,
|
3421
|
+
# including Amazon Web Services System Manager managed node and DNS
|
3422
|
+
# information.
|
3423
|
+
#
|
3424
|
+
# @!attribute [rw] instance_ids
|
3425
|
+
# The identifiers of the self-managed instances with SSM in the hybrid
|
3426
|
+
# directory configuration.
|
3427
|
+
# @return [Array<String>]
|
3428
|
+
#
|
3429
|
+
# @!attribute [rw] dns_ips
|
3430
|
+
# The IP addresses of the DNS servers or domain controllers in the
|
3431
|
+
# hybrid directory configuration.
|
3432
|
+
# @return [Array<String>]
|
3433
|
+
#
|
3434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/HybridUpdateValue AWS API Documentation
|
3435
|
+
#
|
3436
|
+
class HybridUpdateValue < Struct.new(
|
3437
|
+
:instance_ids,
|
3438
|
+
:dns_ips)
|
3439
|
+
SENSITIVE = []
|
3440
|
+
include Aws::Structure
|
3441
|
+
end
|
3442
|
+
|
2829
3443
|
# The specified directory setting is not compatible with other settings.
|
2830
3444
|
#
|
2831
3445
|
# @!attribute [rw] message
|
@@ -3106,6 +3720,50 @@ module Aws::DirectoryService
|
|
3106
3720
|
include Aws::Structure
|
3107
3721
|
end
|
3108
3722
|
|
3723
|
+
# @!attribute [rw] directory_id
|
3724
|
+
# The identifier of the directory for which to list assessments. If
|
3725
|
+
# not specified, all assessments in your account are returned.
|
3726
|
+
# @return [String]
|
3727
|
+
#
|
3728
|
+
# @!attribute [rw] next_token
|
3729
|
+
# The pagination token from a previous request to ListADAssessments.
|
3730
|
+
# Pass null if this is the first request.
|
3731
|
+
# @return [String]
|
3732
|
+
#
|
3733
|
+
# @!attribute [rw] limit
|
3734
|
+
# The maximum number of assessment summaries to return.
|
3735
|
+
# @return [Integer]
|
3736
|
+
#
|
3737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListADAssessmentsRequest AWS API Documentation
|
3738
|
+
#
|
3739
|
+
class ListADAssessmentsRequest < Struct.new(
|
3740
|
+
:directory_id,
|
3741
|
+
:next_token,
|
3742
|
+
:limit)
|
3743
|
+
SENSITIVE = []
|
3744
|
+
include Aws::Structure
|
3745
|
+
end
|
3746
|
+
|
3747
|
+
# @!attribute [rw] assessments
|
3748
|
+
# A list of assessment summaries containing basic information about
|
3749
|
+
# each directory assessment.
|
3750
|
+
# @return [Array<Types::AssessmentSummary>]
|
3751
|
+
#
|
3752
|
+
# @!attribute [rw] next_token
|
3753
|
+
# If not null, more results are available. Pass this value for the
|
3754
|
+
# `NextToken` parameter in a subsequent request to retrieve the next
|
3755
|
+
# set of items.
|
3756
|
+
# @return [String]
|
3757
|
+
#
|
3758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListADAssessmentsResult AWS API Documentation
|
3759
|
+
#
|
3760
|
+
class ListADAssessmentsResult < Struct.new(
|
3761
|
+
:assessments,
|
3762
|
+
:next_token)
|
3763
|
+
SENSITIVE = []
|
3764
|
+
include Aws::Structure
|
3765
|
+
end
|
3766
|
+
|
3109
3767
|
# @!attribute [rw] directory_id
|
3110
3768
|
# The identifier of the directory.
|
3111
3769
|
# @return [String]
|
@@ -3521,8 +4179,8 @@ module Aws::DirectoryService
|
|
3521
4179
|
# @return [String]
|
3522
4180
|
#
|
3523
4181
|
# @!attribute [rw] vpc_settings
|
3524
|
-
# Contains VPC information for the CreateDirectory
|
3525
|
-
#
|
4182
|
+
# Contains VPC information for the CreateDirectory, CreateMicrosoftAD,
|
4183
|
+
# or CreateHybridAD operation.
|
3526
4184
|
# @return [Types::DirectoryVpcSettings]
|
3527
4185
|
#
|
3528
4186
|
# @!attribute [rw] desired_number_of_domain_controllers
|
@@ -4211,6 +4869,40 @@ module Aws::DirectoryService
|
|
4211
4869
|
include Aws::Structure
|
4212
4870
|
end
|
4213
4871
|
|
4872
|
+
# @!attribute [rw] assessment_configuration
|
4873
|
+
# Configuration parameters for the directory assessment, including DNS
|
4874
|
+
# server information, domain name, Amazon VPC subnet, and Amazon Web
|
4875
|
+
# Services System Manager managed node details.
|
4876
|
+
# @return [Types::AssessmentConfiguration]
|
4877
|
+
#
|
4878
|
+
# @!attribute [rw] directory_id
|
4879
|
+
# The identifier of the directory for which to perform the assessment.
|
4880
|
+
# This should be an existing directory. If the assessment is not for
|
4881
|
+
# an existing directory, this parameter should be omitted.
|
4882
|
+
# @return [String]
|
4883
|
+
#
|
4884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/StartADAssessmentRequest AWS API Documentation
|
4885
|
+
#
|
4886
|
+
class StartADAssessmentRequest < Struct.new(
|
4887
|
+
:assessment_configuration,
|
4888
|
+
:directory_id)
|
4889
|
+
SENSITIVE = []
|
4890
|
+
include Aws::Structure
|
4891
|
+
end
|
4892
|
+
|
4893
|
+
# @!attribute [rw] assessment_id
|
4894
|
+
# The unique identifier of the newly started directory assessment. Use
|
4895
|
+
# this identifier to monitor assessment progress and retrieve results.
|
4896
|
+
# @return [String]
|
4897
|
+
#
|
4898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/StartADAssessmentResult AWS API Documentation
|
4899
|
+
#
|
4900
|
+
class StartADAssessmentResult < Struct.new(
|
4901
|
+
:assessment_id)
|
4902
|
+
SENSITIVE = []
|
4903
|
+
include Aws::Structure
|
4904
|
+
end
|
4905
|
+
|
4214
4906
|
# @!attribute [rw] directory_id
|
4215
4907
|
# The identifier of the directory for which the schema extension will
|
4216
4908
|
# be applied to.
|
@@ -4526,6 +5218,61 @@ module Aws::DirectoryService
|
|
4526
5218
|
#
|
4527
5219
|
class UpdateDirectorySetupResult < Aws::EmptyStructure; end
|
4528
5220
|
|
5221
|
+
# @!attribute [rw] directory_id
|
5222
|
+
# The identifier of the hybrid directory to update.
|
5223
|
+
# @return [String]
|
5224
|
+
#
|
5225
|
+
# @!attribute [rw] hybrid_administrator_account_update
|
5226
|
+
# We create a hybrid directory administrator account when we create a
|
5227
|
+
# hybrid directory. Use `HybridAdministratorAccountUpdate` to recover
|
5228
|
+
# the hybrid directory administrator account if you have deleted it.
|
5229
|
+
#
|
5230
|
+
# To recover your hybrid directory administrator account, we need
|
5231
|
+
# temporary access to a user in your self-managed AD with
|
5232
|
+
# administrator permissions in the form of a secret from Amazon Web
|
5233
|
+
# Services Secrets Manager. We use these credentials once during
|
5234
|
+
# recovery and don't store them.
|
5235
|
+
#
|
5236
|
+
# If your hybrid directory administrator account exists, then you
|
5237
|
+
# don’t need to use `HybridAdministratorAccountUpdate`, even if you
|
5238
|
+
# have updated your self-managed AD administrator user.
|
5239
|
+
# @return [Types::HybridAdministratorAccountUpdate]
|
5240
|
+
#
|
5241
|
+
# @!attribute [rw] self_managed_instances_settings
|
5242
|
+
# Updates to the self-managed AD configuration, including DNS server
|
5243
|
+
# IP addresses and Amazon Web Services System Manager managed node
|
5244
|
+
# identifiers.
|
5245
|
+
# @return [Types::HybridCustomerInstancesSettings]
|
5246
|
+
#
|
5247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateHybridADRequest AWS API Documentation
|
5248
|
+
#
|
5249
|
+
class UpdateHybridADRequest < Struct.new(
|
5250
|
+
:directory_id,
|
5251
|
+
:hybrid_administrator_account_update,
|
5252
|
+
:self_managed_instances_settings)
|
5253
|
+
SENSITIVE = []
|
5254
|
+
include Aws::Structure
|
5255
|
+
end
|
5256
|
+
|
5257
|
+
# @!attribute [rw] directory_id
|
5258
|
+
# The identifier of the updated hybrid directory.
|
5259
|
+
# @return [String]
|
5260
|
+
#
|
5261
|
+
# @!attribute [rw] assessment_id
|
5262
|
+
# The identifier of the assessment performed to validate the update
|
5263
|
+
# configuration. This assessment ensures the updated settings are
|
5264
|
+
# compatible with your environment.
|
5265
|
+
# @return [String]
|
5266
|
+
#
|
5267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateHybridADResult AWS API Documentation
|
5268
|
+
#
|
5269
|
+
class UpdateHybridADResult < Struct.new(
|
5270
|
+
:directory_id,
|
5271
|
+
:assessment_id)
|
5272
|
+
SENSITIVE = []
|
5273
|
+
include Aws::Structure
|
5274
|
+
end
|
5275
|
+
|
4529
5276
|
# An entry of update information related to a requested update type.
|
4530
5277
|
#
|
4531
5278
|
# @!attribute [rw] region
|