aws-sdk-pcaconnectorad 1.0.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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-pcaconnectorad/client.rb +2261 -0
- data/lib/aws-sdk-pcaconnectorad/client_api.rb +1065 -0
- data/lib/aws-sdk-pcaconnectorad/customizations.rb +0 -0
- data/lib/aws-sdk-pcaconnectorad/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-pcaconnectorad/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-pcaconnectorad/endpoints.rb +366 -0
- data/lib/aws-sdk-pcaconnectorad/errors.rb +217 -0
- data/lib/aws-sdk-pcaconnectorad/plugins/endpoints.rb +118 -0
- data/lib/aws-sdk-pcaconnectorad/resource.rb +26 -0
- data/lib/aws-sdk-pcaconnectorad/types.rb +2840 -0
- data/lib/aws-sdk-pcaconnectorad.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,2840 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::PcaConnectorAd
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# An access control entry allows or denies Active Directory groups based
|
14
|
+
# on their security identifiers (SIDs) from enrolling and/or
|
15
|
+
# autoenrolling with the template.
|
16
|
+
#
|
17
|
+
# @!attribute [rw] access_rights
|
18
|
+
# Permissions to allow or deny an Active Directory group to enroll or
|
19
|
+
# autoenroll certificates issued against a template.
|
20
|
+
# @return [Types::AccessRights]
|
21
|
+
#
|
22
|
+
# @!attribute [rw] created_at
|
23
|
+
# The date and time that the Access Control Entry was created.
|
24
|
+
# @return [Time]
|
25
|
+
#
|
26
|
+
# @!attribute [rw] group_display_name
|
27
|
+
# Name of the Active Directory group. This name does not need to match
|
28
|
+
# the group name in Active Directory.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] group_security_identifier
|
32
|
+
# Security identifier (SID) of the group object from Active Directory.
|
33
|
+
# The SID starts with "S-".
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] template_arn
|
37
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
38
|
+
# [CreateTemplate][1].
|
39
|
+
#
|
40
|
+
#
|
41
|
+
#
|
42
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] updated_at
|
46
|
+
# The date and time that the Access Control Entry was updated.
|
47
|
+
# @return [Time]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/AccessControlEntry AWS API Documentation
|
50
|
+
#
|
51
|
+
class AccessControlEntry < Struct.new(
|
52
|
+
:access_rights,
|
53
|
+
:created_at,
|
54
|
+
:group_display_name,
|
55
|
+
:group_security_identifier,
|
56
|
+
:template_arn,
|
57
|
+
:updated_at)
|
58
|
+
SENSITIVE = []
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
62
|
+
# Summary of group access control entries that allow or deny Active
|
63
|
+
# Directory groups based on their security identifiers (SIDs) from
|
64
|
+
# enrolling and/or autofenrolling with the template.
|
65
|
+
#
|
66
|
+
# @!attribute [rw] access_rights
|
67
|
+
# Allow or deny an Active Directory group from enrolling and
|
68
|
+
# autoenrolling certificates issued against a template.
|
69
|
+
# @return [Types::AccessRights]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] created_at
|
72
|
+
# The date and time that the Access Control Entry was created.
|
73
|
+
# @return [Time]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] group_display_name
|
76
|
+
# Name of the Active Directory group. This name does not need to match
|
77
|
+
# the group name in Active Directory.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] group_security_identifier
|
81
|
+
# Security identifier (SID) of the group object from Active Directory.
|
82
|
+
# The SID starts with "S-".
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] template_arn
|
86
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
87
|
+
# [CreateTemplate][1].
|
88
|
+
#
|
89
|
+
#
|
90
|
+
#
|
91
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] updated_at
|
95
|
+
# The date and time that the Access Control Entry was updated.
|
96
|
+
# @return [Time]
|
97
|
+
#
|
98
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/AccessControlEntrySummary AWS API Documentation
|
99
|
+
#
|
100
|
+
class AccessControlEntrySummary < Struct.new(
|
101
|
+
:access_rights,
|
102
|
+
:created_at,
|
103
|
+
:group_display_name,
|
104
|
+
:group_security_identifier,
|
105
|
+
:template_arn,
|
106
|
+
:updated_at)
|
107
|
+
SENSITIVE = []
|
108
|
+
include Aws::Structure
|
109
|
+
end
|
110
|
+
|
111
|
+
# You can receive this error if you attempt to create a resource share
|
112
|
+
# when you don't have the required permissions. This can be caused by
|
113
|
+
# insufficient permissions in policies attached to your Amazon Web
|
114
|
+
# Services Identity and Access Management (IAM) principal. It can also
|
115
|
+
# happen because of restrictions in place from an Amazon Web Services
|
116
|
+
# Organizations service control policy (SCP) that affects your Amazon
|
117
|
+
# Web Services account.
|
118
|
+
#
|
119
|
+
# @!attribute [rw] message
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/AccessDeniedException AWS API Documentation
|
123
|
+
#
|
124
|
+
class AccessDeniedException < Struct.new(
|
125
|
+
:message)
|
126
|
+
SENSITIVE = []
|
127
|
+
include Aws::Structure
|
128
|
+
end
|
129
|
+
|
130
|
+
# Allow or deny permissions for an Active Directory group to enroll or
|
131
|
+
# autoenroll certificates for a template.
|
132
|
+
#
|
133
|
+
# @!attribute [rw] auto_enroll
|
134
|
+
# Allow or deny an Active Directory group from autoenrolling
|
135
|
+
# certificates issued against a template. The Active Directory group
|
136
|
+
# must be allowed to enroll to allow autoenrollment
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] enroll
|
140
|
+
# Allow or deny an Active Directory group from enrolling certificates
|
141
|
+
# issued against a template.
|
142
|
+
# @return [String]
|
143
|
+
#
|
144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/AccessRights AWS API Documentation
|
145
|
+
#
|
146
|
+
class AccessRights < Struct.new(
|
147
|
+
:auto_enroll,
|
148
|
+
:enroll)
|
149
|
+
SENSITIVE = []
|
150
|
+
include Aws::Structure
|
151
|
+
end
|
152
|
+
|
153
|
+
# Application policies describe what the certificate can be used for.
|
154
|
+
#
|
155
|
+
# @!attribute [rw] critical
|
156
|
+
# Marks the application policy extension as critical.
|
157
|
+
# @return [Boolean]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] policies
|
160
|
+
# Application policies describe what the certificate can be used for.
|
161
|
+
# @return [Array<Types::ApplicationPolicy>]
|
162
|
+
#
|
163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ApplicationPolicies AWS API Documentation
|
164
|
+
#
|
165
|
+
class ApplicationPolicies < Struct.new(
|
166
|
+
:critical,
|
167
|
+
:policies)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
172
|
+
# Application policies describe what the certificate can be used for.
|
173
|
+
#
|
174
|
+
# @note ApplicationPolicy is a union - when making an API calls you must set exactly one of the members.
|
175
|
+
#
|
176
|
+
# @note ApplicationPolicy is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ApplicationPolicy corresponding to the set member.
|
177
|
+
#
|
178
|
+
# @!attribute [rw] policy_object_identifier
|
179
|
+
# The object identifier (OID) of an application policy.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] policy_type
|
183
|
+
# The type of application policy
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ApplicationPolicy AWS API Documentation
|
187
|
+
#
|
188
|
+
class ApplicationPolicy < Struct.new(
|
189
|
+
:policy_object_identifier,
|
190
|
+
:policy_type,
|
191
|
+
:unknown)
|
192
|
+
SENSITIVE = []
|
193
|
+
include Aws::Structure
|
194
|
+
include Aws::Structure::Union
|
195
|
+
|
196
|
+
class PolicyObjectIdentifier < ApplicationPolicy; end
|
197
|
+
class PolicyType < ApplicationPolicy; end
|
198
|
+
class Unknown < ApplicationPolicy; end
|
199
|
+
end
|
200
|
+
|
201
|
+
# Information describing the end of the validity period of the
|
202
|
+
# certificate. This parameter sets the “Not After” date for the
|
203
|
+
# certificate. Certificate validity is the period of time during which a
|
204
|
+
# certificate is valid. Validity can be expressed as an explicit date
|
205
|
+
# and time when the certificate expires, or as a span of time after
|
206
|
+
# issuance, stated in days, months, or years. For more information, see
|
207
|
+
# Validity in RFC 5280. This value is unaffected when ValidityNotBefore
|
208
|
+
# is also specified. For example, if Validity is set to 20 days in the
|
209
|
+
# future, the certificate will expire 20 days from issuance time
|
210
|
+
# regardless of the ValidityNotBefore value.
|
211
|
+
#
|
212
|
+
# @!attribute [rw] renewal_period
|
213
|
+
# Renewal period is the period of time before certificate expiration
|
214
|
+
# when a new certificate will be requested.
|
215
|
+
# @return [Types::ValidityPeriod]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] validity_period
|
218
|
+
# Information describing the end of the validity period of the
|
219
|
+
# certificate. This parameter sets the “Not After” date for the
|
220
|
+
# certificate. Certificate validity is the period of time during which
|
221
|
+
# a certificate is valid. Validity can be expressed as an explicit
|
222
|
+
# date and time when the certificate expires, or as a span of time
|
223
|
+
# after issuance, stated in days, months, or years. For more
|
224
|
+
# information, see Validity in RFC 5280. This value is unaffected when
|
225
|
+
# ValidityNotBefore is also specified. For example, if Validity is set
|
226
|
+
# to 20 days in the future, the certificate will expire 20 days from
|
227
|
+
# issuance time regardless of the ValidityNotBefore value.
|
228
|
+
# @return [Types::ValidityPeriod]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CertificateValidity AWS API Documentation
|
231
|
+
#
|
232
|
+
class CertificateValidity < Struct.new(
|
233
|
+
:renewal_period,
|
234
|
+
:validity_period)
|
235
|
+
SENSITIVE = []
|
236
|
+
include Aws::Structure
|
237
|
+
end
|
238
|
+
|
239
|
+
# This request cannot be completed for one of the following reasons
|
240
|
+
# because the requested resource was being concurrently modified by
|
241
|
+
# another request.
|
242
|
+
#
|
243
|
+
# @!attribute [rw] message
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] resource_id
|
247
|
+
# The identifier of the Amazon Web Services resource.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] resource_type
|
251
|
+
# The resource type, which can be one of `Connector`, `Template`,
|
252
|
+
# `TemplateGroupAccessControlEntry`, `ServicePrincipalName`, or
|
253
|
+
# `DirectoryRegistration`.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ConflictException AWS API Documentation
|
257
|
+
#
|
258
|
+
class ConflictException < Struct.new(
|
259
|
+
:message,
|
260
|
+
:resource_id,
|
261
|
+
:resource_type)
|
262
|
+
SENSITIVE = []
|
263
|
+
include Aws::Structure
|
264
|
+
end
|
265
|
+
|
266
|
+
# Amazon Web Services Private CA Connector for Active Directory is a
|
267
|
+
# service that links your Active Directory with Amazon Web Services
|
268
|
+
# Private CA. The connector brokers the exchange of certificates from
|
269
|
+
# Amazon Web Services Private CA to domain-joined users and machines
|
270
|
+
# managed with Active Directory.
|
271
|
+
#
|
272
|
+
# @!attribute [rw] arn
|
273
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
274
|
+
# [CreateConnector][1].
|
275
|
+
#
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] certificate_authority_arn
|
282
|
+
# The Amazon Resource Name (ARN) of the certificate authority being
|
283
|
+
# used.
|
284
|
+
# @return [String]
|
285
|
+
#
|
286
|
+
# @!attribute [rw] certificate_enrollment_policy_server_endpoint
|
287
|
+
# Certificate enrollment endpoint for Active Directory domain-joined
|
288
|
+
# objects reach out to when requesting certificates.
|
289
|
+
# @return [String]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] created_at
|
292
|
+
# The date and time that the connector was created.
|
293
|
+
# @return [Time]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] directory_id
|
296
|
+
# The identifier of the Active Directory.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] status
|
300
|
+
# Status of the connector. Status can be creating, active, deleting,
|
301
|
+
# or failed.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @!attribute [rw] status_reason
|
305
|
+
# Additional information about the connector status if the status is
|
306
|
+
# failed.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @!attribute [rw] updated_at
|
310
|
+
# The date and time that the connector was updated.
|
311
|
+
# @return [Time]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] vpc_information
|
314
|
+
# Information of the VPC and security group(s) used with the
|
315
|
+
# connector.
|
316
|
+
# @return [Types::VpcInformation]
|
317
|
+
#
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/Connector AWS API Documentation
|
319
|
+
#
|
320
|
+
class Connector < Struct.new(
|
321
|
+
:arn,
|
322
|
+
:certificate_authority_arn,
|
323
|
+
:certificate_enrollment_policy_server_endpoint,
|
324
|
+
:created_at,
|
325
|
+
:directory_id,
|
326
|
+
:status,
|
327
|
+
:status_reason,
|
328
|
+
:updated_at,
|
329
|
+
:vpc_information)
|
330
|
+
SENSITIVE = []
|
331
|
+
include Aws::Structure
|
332
|
+
end
|
333
|
+
|
334
|
+
# Summary description of the Amazon Web Services Private CA AD
|
335
|
+
# connectors belonging to an Amazon Web Services account.
|
336
|
+
#
|
337
|
+
# @!attribute [rw] arn
|
338
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
339
|
+
# [CreateConnector][1].
|
340
|
+
#
|
341
|
+
#
|
342
|
+
#
|
343
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] certificate_authority_arn
|
347
|
+
# The Amazon Resource Name (ARN) of the certificate authority being
|
348
|
+
# used.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] certificate_enrollment_policy_server_endpoint
|
352
|
+
# Certificate enrollment endpoint for Active Directory domain-joined
|
353
|
+
# objects to request certificates.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] created_at
|
357
|
+
# The date and time that the connector was created.
|
358
|
+
# @return [Time]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] directory_id
|
361
|
+
# The identifier of the Active Directory.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] status
|
365
|
+
# Status of the connector. Status can be creating, active, deleting,
|
366
|
+
# or failed.
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] status_reason
|
370
|
+
# Additional information about the connector status if the status is
|
371
|
+
# failed.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] updated_at
|
375
|
+
# The date and time that the connector was updated.
|
376
|
+
# @return [Time]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] vpc_information
|
379
|
+
# Information of the VPC and security group(s) used with the
|
380
|
+
# connector.
|
381
|
+
# @return [Types::VpcInformation]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ConnectorSummary AWS API Documentation
|
384
|
+
#
|
385
|
+
class ConnectorSummary < Struct.new(
|
386
|
+
:arn,
|
387
|
+
:certificate_authority_arn,
|
388
|
+
:certificate_enrollment_policy_server_endpoint,
|
389
|
+
:created_at,
|
390
|
+
:directory_id,
|
391
|
+
:status,
|
392
|
+
:status_reason,
|
393
|
+
:updated_at,
|
394
|
+
:vpc_information)
|
395
|
+
SENSITIVE = []
|
396
|
+
include Aws::Structure
|
397
|
+
end
|
398
|
+
|
399
|
+
# @!attribute [rw] certificate_authority_arn
|
400
|
+
# The Amazon Resource Name (ARN) of the certificate authority being
|
401
|
+
# used.
|
402
|
+
# @return [String]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] client_token
|
405
|
+
# Idempotency token.
|
406
|
+
#
|
407
|
+
# **A suitable default value is auto-generated.** You should normally
|
408
|
+
# not need to pass this option.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] directory_id
|
412
|
+
# The identifier of the Active Directory.
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] tags
|
416
|
+
# Metadata assigned to a connector consisting of a key-value pair.
|
417
|
+
# @return [Hash<String,String>]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] vpc_information
|
420
|
+
# Security group IDs that describe the inbound and outbound rules.
|
421
|
+
# @return [Types::VpcInformation]
|
422
|
+
#
|
423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateConnectorRequest AWS API Documentation
|
424
|
+
#
|
425
|
+
class CreateConnectorRequest < Struct.new(
|
426
|
+
:certificate_authority_arn,
|
427
|
+
:client_token,
|
428
|
+
:directory_id,
|
429
|
+
:tags,
|
430
|
+
:vpc_information)
|
431
|
+
SENSITIVE = []
|
432
|
+
include Aws::Structure
|
433
|
+
end
|
434
|
+
|
435
|
+
# @!attribute [rw] connector_arn
|
436
|
+
# If successful, the Amazon Resource Name (ARN) of the connector for
|
437
|
+
# Active Directory.
|
438
|
+
# @return [String]
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateConnectorResponse AWS API Documentation
|
441
|
+
#
|
442
|
+
class CreateConnectorResponse < Struct.new(
|
443
|
+
:connector_arn)
|
444
|
+
SENSITIVE = []
|
445
|
+
include Aws::Structure
|
446
|
+
end
|
447
|
+
|
448
|
+
# @!attribute [rw] client_token
|
449
|
+
# Idempotency token.
|
450
|
+
#
|
451
|
+
# **A suitable default value is auto-generated.** You should normally
|
452
|
+
# not need to pass this option.
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] directory_id
|
456
|
+
# The identifier of the Active Directory.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] tags
|
460
|
+
# Metadata assigned to a directory registration consisting of a
|
461
|
+
# key-value pair.
|
462
|
+
# @return [Hash<String,String>]
|
463
|
+
#
|
464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateDirectoryRegistrationRequest AWS API Documentation
|
465
|
+
#
|
466
|
+
class CreateDirectoryRegistrationRequest < Struct.new(
|
467
|
+
:client_token,
|
468
|
+
:directory_id,
|
469
|
+
:tags)
|
470
|
+
SENSITIVE = []
|
471
|
+
include Aws::Structure
|
472
|
+
end
|
473
|
+
|
474
|
+
# @!attribute [rw] directory_registration_arn
|
475
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
476
|
+
# [CreateDirectoryRegistration][1].
|
477
|
+
#
|
478
|
+
#
|
479
|
+
#
|
480
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateDirectoryRegistrationResponse AWS API Documentation
|
484
|
+
#
|
485
|
+
class CreateDirectoryRegistrationResponse < Struct.new(
|
486
|
+
:directory_registration_arn)
|
487
|
+
SENSITIVE = []
|
488
|
+
include Aws::Structure
|
489
|
+
end
|
490
|
+
|
491
|
+
# @!attribute [rw] client_token
|
492
|
+
# Idempotency token.
|
493
|
+
#
|
494
|
+
# **A suitable default value is auto-generated.** You should normally
|
495
|
+
# not need to pass this option.
|
496
|
+
# @return [String]
|
497
|
+
#
|
498
|
+
# @!attribute [rw] connector_arn
|
499
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
500
|
+
# [CreateConnector][1].
|
501
|
+
#
|
502
|
+
#
|
503
|
+
#
|
504
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] directory_registration_arn
|
508
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
509
|
+
# [CreateDirectoryRegistration][1].
|
510
|
+
#
|
511
|
+
#
|
512
|
+
#
|
513
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateServicePrincipalNameRequest AWS API Documentation
|
517
|
+
#
|
518
|
+
class CreateServicePrincipalNameRequest < Struct.new(
|
519
|
+
:client_token,
|
520
|
+
:connector_arn,
|
521
|
+
:directory_registration_arn)
|
522
|
+
SENSITIVE = []
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
526
|
+
# @!attribute [rw] access_rights
|
527
|
+
# Allow or deny permissions for an Active Directory group to enroll or
|
528
|
+
# autoenroll certificates for a template.
|
529
|
+
# @return [Types::AccessRights]
|
530
|
+
#
|
531
|
+
# @!attribute [rw] client_token
|
532
|
+
# Idempotency token.
|
533
|
+
#
|
534
|
+
# **A suitable default value is auto-generated.** You should normally
|
535
|
+
# not need to pass this option.
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @!attribute [rw] group_display_name
|
539
|
+
# Name of the Active Directory group. This name does not need to match
|
540
|
+
# the group name in Active Directory.
|
541
|
+
# @return [String]
|
542
|
+
#
|
543
|
+
# @!attribute [rw] group_security_identifier
|
544
|
+
# Security identifier (SID) of the group object from Active Directory.
|
545
|
+
# The SID starts with "S-".
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] template_arn
|
549
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
550
|
+
# [CreateTemplate][1].
|
551
|
+
#
|
552
|
+
#
|
553
|
+
#
|
554
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateTemplateGroupAccessControlEntryRequest AWS API Documentation
|
558
|
+
#
|
559
|
+
class CreateTemplateGroupAccessControlEntryRequest < Struct.new(
|
560
|
+
:access_rights,
|
561
|
+
:client_token,
|
562
|
+
:group_display_name,
|
563
|
+
:group_security_identifier,
|
564
|
+
:template_arn)
|
565
|
+
SENSITIVE = []
|
566
|
+
include Aws::Structure
|
567
|
+
end
|
568
|
+
|
569
|
+
# @!attribute [rw] client_token
|
570
|
+
# Idempotency token.
|
571
|
+
#
|
572
|
+
# **A suitable default value is auto-generated.** You should normally
|
573
|
+
# not need to pass this option.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] connector_arn
|
577
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
578
|
+
# [CreateConnector][1].
|
579
|
+
#
|
580
|
+
#
|
581
|
+
#
|
582
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] definition
|
586
|
+
# Template configuration to define the information included in
|
587
|
+
# certificates. Define certificate validity and renewal periods,
|
588
|
+
# certificate request handling and enrollment options, key usage
|
589
|
+
# extensions, application policies, and cryptography settings.
|
590
|
+
# @return [Types::TemplateDefinition]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] name
|
593
|
+
# Name of the template. The template name must be unique.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] tags
|
597
|
+
# Metadata assigned to a template consisting of a key-value pair.
|
598
|
+
# @return [Hash<String,String>]
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateTemplateRequest AWS API Documentation
|
601
|
+
#
|
602
|
+
class CreateTemplateRequest < Struct.new(
|
603
|
+
:client_token,
|
604
|
+
:connector_arn,
|
605
|
+
:definition,
|
606
|
+
:name,
|
607
|
+
:tags)
|
608
|
+
SENSITIVE = []
|
609
|
+
include Aws::Structure
|
610
|
+
end
|
611
|
+
|
612
|
+
# @!attribute [rw] template_arn
|
613
|
+
# If successful, the Amazon Resource Name (ARN) of the template.
|
614
|
+
# @return [String]
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/CreateTemplateResponse AWS API Documentation
|
617
|
+
#
|
618
|
+
class CreateTemplateResponse < Struct.new(
|
619
|
+
:template_arn)
|
620
|
+
SENSITIVE = []
|
621
|
+
include Aws::Structure
|
622
|
+
end
|
623
|
+
|
624
|
+
# @!attribute [rw] connector_arn
|
625
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
626
|
+
# [CreateConnector][1].
|
627
|
+
#
|
628
|
+
#
|
629
|
+
#
|
630
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
631
|
+
# @return [String]
|
632
|
+
#
|
633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DeleteConnectorRequest AWS API Documentation
|
634
|
+
#
|
635
|
+
class DeleteConnectorRequest < Struct.new(
|
636
|
+
:connector_arn)
|
637
|
+
SENSITIVE = []
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# @!attribute [rw] directory_registration_arn
|
642
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
643
|
+
# [CreateDirectoryRegistration][1].
|
644
|
+
#
|
645
|
+
#
|
646
|
+
#
|
647
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DeleteDirectoryRegistrationRequest AWS API Documentation
|
651
|
+
#
|
652
|
+
class DeleteDirectoryRegistrationRequest < Struct.new(
|
653
|
+
:directory_registration_arn)
|
654
|
+
SENSITIVE = []
|
655
|
+
include Aws::Structure
|
656
|
+
end
|
657
|
+
|
658
|
+
# @!attribute [rw] connector_arn
|
659
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
660
|
+
# [CreateConnector][1].
|
661
|
+
#
|
662
|
+
#
|
663
|
+
#
|
664
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] directory_registration_arn
|
668
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
669
|
+
# [CreateDirectoryRegistration][1].
|
670
|
+
#
|
671
|
+
#
|
672
|
+
#
|
673
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DeleteServicePrincipalNameRequest AWS API Documentation
|
677
|
+
#
|
678
|
+
class DeleteServicePrincipalNameRequest < Struct.new(
|
679
|
+
:connector_arn,
|
680
|
+
:directory_registration_arn)
|
681
|
+
SENSITIVE = []
|
682
|
+
include Aws::Structure
|
683
|
+
end
|
684
|
+
|
685
|
+
# @!attribute [rw] group_security_identifier
|
686
|
+
# Security identifier (SID) of the group object from Active Directory.
|
687
|
+
# The SID starts with "S-".
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] template_arn
|
691
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
692
|
+
# [CreateTemplate][1].
|
693
|
+
#
|
694
|
+
#
|
695
|
+
#
|
696
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DeleteTemplateGroupAccessControlEntryRequest AWS API Documentation
|
700
|
+
#
|
701
|
+
class DeleteTemplateGroupAccessControlEntryRequest < Struct.new(
|
702
|
+
:group_security_identifier,
|
703
|
+
:template_arn)
|
704
|
+
SENSITIVE = []
|
705
|
+
include Aws::Structure
|
706
|
+
end
|
707
|
+
|
708
|
+
# @!attribute [rw] template_arn
|
709
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
710
|
+
# [CreateTemplate][1].
|
711
|
+
#
|
712
|
+
#
|
713
|
+
#
|
714
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
715
|
+
# @return [String]
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DeleteTemplateRequest AWS API Documentation
|
718
|
+
#
|
719
|
+
class DeleteTemplateRequest < Struct.new(
|
720
|
+
:template_arn)
|
721
|
+
SENSITIVE = []
|
722
|
+
include Aws::Structure
|
723
|
+
end
|
724
|
+
|
725
|
+
# The directory registration represents the authorization of the
|
726
|
+
# connector service with a directory.
|
727
|
+
#
|
728
|
+
# @!attribute [rw] arn
|
729
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
730
|
+
# CreateDirectoryRegistration.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] created_at
|
734
|
+
# The date and time that the directory registration was created.
|
735
|
+
# @return [Time]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] directory_id
|
738
|
+
# The identifier of the Active Directory.
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @!attribute [rw] status
|
742
|
+
# Status of the directory registration.
|
743
|
+
# @return [String]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] status_reason
|
746
|
+
# Additional information about the directory registration status if
|
747
|
+
# the status is failed.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] updated_at
|
751
|
+
# The date and time that the directory registration was updated.
|
752
|
+
# @return [Time]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DirectoryRegistration AWS API Documentation
|
755
|
+
#
|
756
|
+
class DirectoryRegistration < Struct.new(
|
757
|
+
:arn,
|
758
|
+
:created_at,
|
759
|
+
:directory_id,
|
760
|
+
:status,
|
761
|
+
:status_reason,
|
762
|
+
:updated_at)
|
763
|
+
SENSITIVE = []
|
764
|
+
include Aws::Structure
|
765
|
+
end
|
766
|
+
|
767
|
+
# The directory registration represents the authorization of the
|
768
|
+
# connector service with the Active Directory.
|
769
|
+
#
|
770
|
+
# @!attribute [rw] arn
|
771
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
772
|
+
# [CreateDirectoryRegistration][1].
|
773
|
+
#
|
774
|
+
#
|
775
|
+
#
|
776
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
777
|
+
# @return [String]
|
778
|
+
#
|
779
|
+
# @!attribute [rw] created_at
|
780
|
+
# The date and time that the directory registration was created.
|
781
|
+
# @return [Time]
|
782
|
+
#
|
783
|
+
# @!attribute [rw] directory_id
|
784
|
+
# The identifier of the Active Directory.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @!attribute [rw] status
|
788
|
+
# Status of the directory registration.
|
789
|
+
# @return [String]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] status_reason
|
792
|
+
# Additional information about the directory registration status if
|
793
|
+
# the status is failed.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] updated_at
|
797
|
+
# The date and time that the directory registration was updated.
|
798
|
+
# @return [Time]
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/DirectoryRegistrationSummary AWS API Documentation
|
801
|
+
#
|
802
|
+
class DirectoryRegistrationSummary < Struct.new(
|
803
|
+
:arn,
|
804
|
+
:created_at,
|
805
|
+
:directory_id,
|
806
|
+
:status,
|
807
|
+
:status_reason,
|
808
|
+
:updated_at)
|
809
|
+
SENSITIVE = []
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
813
|
+
# Template configurations for v2 template schema.
|
814
|
+
#
|
815
|
+
# @!attribute [rw] enable_key_reuse_on_nt_token_keyset_storage_full
|
816
|
+
# Allow renewal using the same key.
|
817
|
+
# @return [Boolean]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] include_symmetric_algorithms
|
820
|
+
# Include symmetric algorithms allowed by the subject.
|
821
|
+
# @return [Boolean]
|
822
|
+
#
|
823
|
+
# @!attribute [rw] no_security_extension
|
824
|
+
# This flag instructs the CA to not include the security extension
|
825
|
+
# szOID\_NTDS\_CA\_SECURITY\_EXT (OID:1.3.6.1.4.1.311.25.2), as
|
826
|
+
# specified in \[MS-WCCE\] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9,
|
827
|
+
# in the issued certificate. This addresses a Windows Kerberos
|
828
|
+
# elevation-of-privilege vulnerability.
|
829
|
+
# @return [Boolean]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] remove_invalid_certificate_from_personal_store
|
832
|
+
# Delete expired or revoked certificates instead of archiving them.
|
833
|
+
# @return [Boolean]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] user_interaction_required
|
836
|
+
# Require user interaction when the subject is enrolled and the
|
837
|
+
# private key associated with the certificate is used.
|
838
|
+
# @return [Boolean]
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/EnrollmentFlagsV2 AWS API Documentation
|
841
|
+
#
|
842
|
+
class EnrollmentFlagsV2 < Struct.new(
|
843
|
+
:enable_key_reuse_on_nt_token_keyset_storage_full,
|
844
|
+
:include_symmetric_algorithms,
|
845
|
+
:no_security_extension,
|
846
|
+
:remove_invalid_certificate_from_personal_store,
|
847
|
+
:user_interaction_required)
|
848
|
+
SENSITIVE = []
|
849
|
+
include Aws::Structure
|
850
|
+
end
|
851
|
+
|
852
|
+
# Template configurations for v3 template schema.
|
853
|
+
#
|
854
|
+
# @!attribute [rw] enable_key_reuse_on_nt_token_keyset_storage_full
|
855
|
+
# Allow renewal using the same key.
|
856
|
+
# @return [Boolean]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] include_symmetric_algorithms
|
859
|
+
# Include symmetric algorithms allowed by the subject.
|
860
|
+
# @return [Boolean]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] no_security_extension
|
863
|
+
# This flag instructs the CA to not include the security extension
|
864
|
+
# szOID\_NTDS\_CA\_SECURITY\_EXT (OID:1.3.6.1.4.1.311.25.2), as
|
865
|
+
# specified in \[MS-WCCE\] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9,
|
866
|
+
# in the issued certificate. This addresses a Windows Kerberos
|
867
|
+
# elevation-of-privilege vulnerability.
|
868
|
+
# @return [Boolean]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] remove_invalid_certificate_from_personal_store
|
871
|
+
# Delete expired or revoked certificates instead of archiving them.
|
872
|
+
# @return [Boolean]
|
873
|
+
#
|
874
|
+
# @!attribute [rw] user_interaction_required
|
875
|
+
# Require user interaction when the subject is enrolled and the
|
876
|
+
# private key associated with the certificate is used.
|
877
|
+
# @return [Boolean]
|
878
|
+
#
|
879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/EnrollmentFlagsV3 AWS API Documentation
|
880
|
+
#
|
881
|
+
class EnrollmentFlagsV3 < Struct.new(
|
882
|
+
:enable_key_reuse_on_nt_token_keyset_storage_full,
|
883
|
+
:include_symmetric_algorithms,
|
884
|
+
:no_security_extension,
|
885
|
+
:remove_invalid_certificate_from_personal_store,
|
886
|
+
:user_interaction_required)
|
887
|
+
SENSITIVE = []
|
888
|
+
include Aws::Structure
|
889
|
+
end
|
890
|
+
|
891
|
+
# Template configurations for v4 template schema.
|
892
|
+
#
|
893
|
+
# @!attribute [rw] enable_key_reuse_on_nt_token_keyset_storage_full
|
894
|
+
# Allow renewal using the same key.
|
895
|
+
# @return [Boolean]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] include_symmetric_algorithms
|
898
|
+
# Include symmetric algorithms allowed by the subject.
|
899
|
+
# @return [Boolean]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] no_security_extension
|
902
|
+
# This flag instructs the CA to not include the security extension
|
903
|
+
# szOID\_NTDS\_CA\_SECURITY\_EXT (OID:1.3.6.1.4.1.311.25.2), as
|
904
|
+
# specified in \[MS-WCCE\] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9,
|
905
|
+
# in the issued certificate. This addresses a Windows Kerberos
|
906
|
+
# elevation-of-privilege vulnerability.
|
907
|
+
# @return [Boolean]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] remove_invalid_certificate_from_personal_store
|
910
|
+
# Delete expired or revoked certificates instead of archiving them.
|
911
|
+
# @return [Boolean]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] user_interaction_required
|
914
|
+
# Require user interaction when the subject is enrolled and the
|
915
|
+
# private key associated with the certificate is used.
|
916
|
+
# @return [Boolean]
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/EnrollmentFlagsV4 AWS API Documentation
|
919
|
+
#
|
920
|
+
class EnrollmentFlagsV4 < Struct.new(
|
921
|
+
:enable_key_reuse_on_nt_token_keyset_storage_full,
|
922
|
+
:include_symmetric_algorithms,
|
923
|
+
:no_security_extension,
|
924
|
+
:remove_invalid_certificate_from_personal_store,
|
925
|
+
:user_interaction_required)
|
926
|
+
SENSITIVE = []
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
930
|
+
# Certificate extensions for v2 template schema
|
931
|
+
#
|
932
|
+
# @!attribute [rw] application_policies
|
933
|
+
# Application policies specify what the certificate is used for and
|
934
|
+
# its purpose.
|
935
|
+
# @return [Types::ApplicationPolicies]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] key_usage
|
938
|
+
# The key usage extension defines the purpose (e.g., encipherment,
|
939
|
+
# signature, certificate signing) of the key contained in the
|
940
|
+
# certificate.
|
941
|
+
# @return [Types::KeyUsage]
|
942
|
+
#
|
943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ExtensionsV2 AWS API Documentation
|
944
|
+
#
|
945
|
+
class ExtensionsV2 < Struct.new(
|
946
|
+
:application_policies,
|
947
|
+
:key_usage)
|
948
|
+
SENSITIVE = []
|
949
|
+
include Aws::Structure
|
950
|
+
end
|
951
|
+
|
952
|
+
# Certificate extensions for v3 template schema
|
953
|
+
#
|
954
|
+
# @!attribute [rw] application_policies
|
955
|
+
# Application policies specify what the certificate is used for and
|
956
|
+
# its purpose.
|
957
|
+
# @return [Types::ApplicationPolicies]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] key_usage
|
960
|
+
# The key usage extension defines the purpose (e.g., encipherment,
|
961
|
+
# signature, certificate signing) of the key contained in the
|
962
|
+
# certificate.
|
963
|
+
# @return [Types::KeyUsage]
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ExtensionsV3 AWS API Documentation
|
966
|
+
#
|
967
|
+
class ExtensionsV3 < Struct.new(
|
968
|
+
:application_policies,
|
969
|
+
:key_usage)
|
970
|
+
SENSITIVE = []
|
971
|
+
include Aws::Structure
|
972
|
+
end
|
973
|
+
|
974
|
+
# Certificate extensions for v4 template schema
|
975
|
+
#
|
976
|
+
# @!attribute [rw] application_policies
|
977
|
+
# Application policies specify what the certificate is used for and
|
978
|
+
# its purpose.
|
979
|
+
# @return [Types::ApplicationPolicies]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] key_usage
|
982
|
+
# The key usage extension defines the purpose (e.g., encipherment,
|
983
|
+
# signature) of the key contained in the certificate.
|
984
|
+
# @return [Types::KeyUsage]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ExtensionsV4 AWS API Documentation
|
987
|
+
#
|
988
|
+
class ExtensionsV4 < Struct.new(
|
989
|
+
:application_policies,
|
990
|
+
:key_usage)
|
991
|
+
SENSITIVE = []
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# General flags for v2 template schema that defines if the template is
|
996
|
+
# for a machine or a user and if the template can be issued using
|
997
|
+
# autoenrollment.
|
998
|
+
#
|
999
|
+
# @!attribute [rw] auto_enrollment
|
1000
|
+
# Allows certificate issuance using autoenrollment. Set to TRUE to
|
1001
|
+
# allow autoenrollment.
|
1002
|
+
# @return [Boolean]
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] machine_type
|
1005
|
+
# Defines if the template is for machines or users. Set to TRUE if the
|
1006
|
+
# template is for machines. Set to FALSE if the template is for users.
|
1007
|
+
# @return [Boolean]
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GeneralFlagsV2 AWS API Documentation
|
1010
|
+
#
|
1011
|
+
class GeneralFlagsV2 < Struct.new(
|
1012
|
+
:auto_enrollment,
|
1013
|
+
:machine_type)
|
1014
|
+
SENSITIVE = []
|
1015
|
+
include Aws::Structure
|
1016
|
+
end
|
1017
|
+
|
1018
|
+
# General flags for v3 template schema that defines if the template is
|
1019
|
+
# for a machine or a user and if the template can be issued using
|
1020
|
+
# autoenrollment.
|
1021
|
+
#
|
1022
|
+
# @!attribute [rw] auto_enrollment
|
1023
|
+
# Allows certificate issuance using autoenrollment. Set to TRUE to
|
1024
|
+
# allow autoenrollment.
|
1025
|
+
# @return [Boolean]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] machine_type
|
1028
|
+
# Defines if the template is for machines or users. Set to TRUE if the
|
1029
|
+
# template is for machines. Set to FALSE if the template is for users
|
1030
|
+
# @return [Boolean]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GeneralFlagsV3 AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class GeneralFlagsV3 < Struct.new(
|
1035
|
+
:auto_enrollment,
|
1036
|
+
:machine_type)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# General flags for v4 template schema that defines if the template is
|
1042
|
+
# for a machine or a user and if the template can be issued using
|
1043
|
+
# autoenrollment.
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] auto_enrollment
|
1046
|
+
# Allows certificate issuance using autoenrollment. Set to TRUE to
|
1047
|
+
# allow autoenrollment.
|
1048
|
+
# @return [Boolean]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] machine_type
|
1051
|
+
# Defines if the template is for machines or users. Set to TRUE if the
|
1052
|
+
# template is for machines. Set to FALSE if the template is for users
|
1053
|
+
# @return [Boolean]
|
1054
|
+
#
|
1055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GeneralFlagsV4 AWS API Documentation
|
1056
|
+
#
|
1057
|
+
class GeneralFlagsV4 < Struct.new(
|
1058
|
+
:auto_enrollment,
|
1059
|
+
:machine_type)
|
1060
|
+
SENSITIVE = []
|
1061
|
+
include Aws::Structure
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# @!attribute [rw] connector_arn
|
1065
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1066
|
+
# [CreateConnector][1].
|
1067
|
+
#
|
1068
|
+
#
|
1069
|
+
#
|
1070
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetConnectorRequest AWS API Documentation
|
1074
|
+
#
|
1075
|
+
class GetConnectorRequest < Struct.new(
|
1076
|
+
:connector_arn)
|
1077
|
+
SENSITIVE = []
|
1078
|
+
include Aws::Structure
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# @!attribute [rw] connector
|
1082
|
+
# A structure that contains information about your connector.
|
1083
|
+
# @return [Types::Connector]
|
1084
|
+
#
|
1085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetConnectorResponse AWS API Documentation
|
1086
|
+
#
|
1087
|
+
class GetConnectorResponse < Struct.new(
|
1088
|
+
:connector)
|
1089
|
+
SENSITIVE = []
|
1090
|
+
include Aws::Structure
|
1091
|
+
end
|
1092
|
+
|
1093
|
+
# @!attribute [rw] directory_registration_arn
|
1094
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1095
|
+
# [CreateDirectoryRegistration][1].
|
1096
|
+
#
|
1097
|
+
#
|
1098
|
+
#
|
1099
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetDirectoryRegistrationRequest AWS API Documentation
|
1103
|
+
#
|
1104
|
+
class GetDirectoryRegistrationRequest < Struct.new(
|
1105
|
+
:directory_registration_arn)
|
1106
|
+
SENSITIVE = []
|
1107
|
+
include Aws::Structure
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
# @!attribute [rw] directory_registration
|
1111
|
+
# The directory registration represents the authorization of the
|
1112
|
+
# connector service with a directory.
|
1113
|
+
# @return [Types::DirectoryRegistration]
|
1114
|
+
#
|
1115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetDirectoryRegistrationResponse AWS API Documentation
|
1116
|
+
#
|
1117
|
+
class GetDirectoryRegistrationResponse < Struct.new(
|
1118
|
+
:directory_registration)
|
1119
|
+
SENSITIVE = []
|
1120
|
+
include Aws::Structure
|
1121
|
+
end
|
1122
|
+
|
1123
|
+
# @!attribute [rw] connector_arn
|
1124
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1125
|
+
# [CreateConnector][1].
|
1126
|
+
#
|
1127
|
+
#
|
1128
|
+
#
|
1129
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
1130
|
+
# @return [String]
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] directory_registration_arn
|
1133
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1134
|
+
# [CreateDirectoryRegistration][1].
|
1135
|
+
#
|
1136
|
+
#
|
1137
|
+
#
|
1138
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
1139
|
+
# @return [String]
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetServicePrincipalNameRequest AWS API Documentation
|
1142
|
+
#
|
1143
|
+
class GetServicePrincipalNameRequest < Struct.new(
|
1144
|
+
:connector_arn,
|
1145
|
+
:directory_registration_arn)
|
1146
|
+
SENSITIVE = []
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# @!attribute [rw] service_principal_name
|
1151
|
+
# The service principal name that the connector uses to authenticate
|
1152
|
+
# with Active Directory.
|
1153
|
+
# @return [Types::ServicePrincipalName]
|
1154
|
+
#
|
1155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetServicePrincipalNameResponse AWS API Documentation
|
1156
|
+
#
|
1157
|
+
class GetServicePrincipalNameResponse < Struct.new(
|
1158
|
+
:service_principal_name)
|
1159
|
+
SENSITIVE = []
|
1160
|
+
include Aws::Structure
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
# @!attribute [rw] group_security_identifier
|
1164
|
+
# Security identifier (SID) of the group object from Active Directory.
|
1165
|
+
# The SID starts with "S-".
|
1166
|
+
# @return [String]
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] template_arn
|
1169
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1170
|
+
# [CreateTemplate][1].
|
1171
|
+
#
|
1172
|
+
#
|
1173
|
+
#
|
1174
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
1175
|
+
# @return [String]
|
1176
|
+
#
|
1177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetTemplateGroupAccessControlEntryRequest AWS API Documentation
|
1178
|
+
#
|
1179
|
+
class GetTemplateGroupAccessControlEntryRequest < Struct.new(
|
1180
|
+
:group_security_identifier,
|
1181
|
+
:template_arn)
|
1182
|
+
SENSITIVE = []
|
1183
|
+
include Aws::Structure
|
1184
|
+
end
|
1185
|
+
|
1186
|
+
# @!attribute [rw] access_control_entry
|
1187
|
+
# An access control entry allows or denies an Active Directory group
|
1188
|
+
# from enrolling and/or autoenrolling with a template.
|
1189
|
+
# @return [Types::AccessControlEntry]
|
1190
|
+
#
|
1191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetTemplateGroupAccessControlEntryResponse AWS API Documentation
|
1192
|
+
#
|
1193
|
+
class GetTemplateGroupAccessControlEntryResponse < Struct.new(
|
1194
|
+
:access_control_entry)
|
1195
|
+
SENSITIVE = []
|
1196
|
+
include Aws::Structure
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# @!attribute [rw] template_arn
|
1200
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1201
|
+
# [CreateTemplate][1].
|
1202
|
+
#
|
1203
|
+
#
|
1204
|
+
#
|
1205
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
1206
|
+
# @return [String]
|
1207
|
+
#
|
1208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetTemplateRequest AWS API Documentation
|
1209
|
+
#
|
1210
|
+
class GetTemplateRequest < Struct.new(
|
1211
|
+
:template_arn)
|
1212
|
+
SENSITIVE = []
|
1213
|
+
include Aws::Structure
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
# @!attribute [rw] template
|
1217
|
+
# A certificate template that the connector uses to issue certificates
|
1218
|
+
# from a private CA.
|
1219
|
+
# @return [Types::Template]
|
1220
|
+
#
|
1221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/GetTemplateResponse AWS API Documentation
|
1222
|
+
#
|
1223
|
+
class GetTemplateResponse < Struct.new(
|
1224
|
+
:template)
|
1225
|
+
SENSITIVE = []
|
1226
|
+
include Aws::Structure
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
# The request processing has failed because of an unknown error,
|
1230
|
+
# exception or failure with an internal server.
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] message
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
1235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/InternalServerException AWS API Documentation
|
1236
|
+
#
|
1237
|
+
class InternalServerException < Struct.new(
|
1238
|
+
:message)
|
1239
|
+
SENSITIVE = []
|
1240
|
+
include Aws::Structure
|
1241
|
+
end
|
1242
|
+
|
1243
|
+
# The key usage extension defines the purpose (e.g., encipherment,
|
1244
|
+
# signature) of the key contained in the certificate.
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] critical
|
1247
|
+
# Sets the key usage extension to critical.
|
1248
|
+
# @return [Boolean]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] usage_flags
|
1251
|
+
# The key usage flags represent the purpose (e.g., encipherment,
|
1252
|
+
# signature) of the key contained in the certificate.
|
1253
|
+
# @return [Types::KeyUsageFlags]
|
1254
|
+
#
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/KeyUsage AWS API Documentation
|
1256
|
+
#
|
1257
|
+
class KeyUsage < Struct.new(
|
1258
|
+
:critical,
|
1259
|
+
:usage_flags)
|
1260
|
+
SENSITIVE = []
|
1261
|
+
include Aws::Structure
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
# The key usage flags represent the purpose (e.g., encipherment,
|
1265
|
+
# signature) of the key contained in the certificate.
|
1266
|
+
#
|
1267
|
+
# @!attribute [rw] data_encipherment
|
1268
|
+
# DataEncipherment is asserted when the subject public key is used for
|
1269
|
+
# directly enciphering raw user data without the use of an
|
1270
|
+
# intermediate symmetric cipher.
|
1271
|
+
# @return [Boolean]
|
1272
|
+
#
|
1273
|
+
# @!attribute [rw] digital_signature
|
1274
|
+
# The digitalSignature is asserted when the subject public key is used
|
1275
|
+
# for verifying digital signatures.
|
1276
|
+
# @return [Boolean]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] key_agreement
|
1279
|
+
# KeyAgreement is asserted when the subject public key is used for key
|
1280
|
+
# agreement.
|
1281
|
+
# @return [Boolean]
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] key_encipherment
|
1284
|
+
# KeyEncipherment is asserted when the subject public key is used for
|
1285
|
+
# enciphering private or secret keys, i.e., for key transport.
|
1286
|
+
# @return [Boolean]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] non_repudiation
|
1289
|
+
# NonRepudiation is asserted when the subject public key is used to
|
1290
|
+
# verify digital signatures.
|
1291
|
+
# @return [Boolean]
|
1292
|
+
#
|
1293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/KeyUsageFlags AWS API Documentation
|
1294
|
+
#
|
1295
|
+
class KeyUsageFlags < Struct.new(
|
1296
|
+
:data_encipherment,
|
1297
|
+
:digital_signature,
|
1298
|
+
:key_agreement,
|
1299
|
+
:key_encipherment,
|
1300
|
+
:non_repudiation)
|
1301
|
+
SENSITIVE = []
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# The key usage property defines the purpose of the private key
|
1306
|
+
# contained in the certificate. You can specify specific purposes using
|
1307
|
+
# property flags or all by using property type ALL.
|
1308
|
+
#
|
1309
|
+
# @note KeyUsageProperty is a union - when making an API calls you must set exactly one of the members.
|
1310
|
+
#
|
1311
|
+
# @note KeyUsageProperty is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of KeyUsageProperty corresponding to the set member.
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] property_flags
|
1314
|
+
# You can specify key usage for encryption, key agreement, and
|
1315
|
+
# signature. You can use property flags or property type but not both.
|
1316
|
+
# @return [Types::KeyUsagePropertyFlags]
|
1317
|
+
#
|
1318
|
+
# @!attribute [rw] property_type
|
1319
|
+
# You can specify all key usages using property type ALL. You can use
|
1320
|
+
# property type or property flags but not both.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/KeyUsageProperty AWS API Documentation
|
1324
|
+
#
|
1325
|
+
class KeyUsageProperty < Struct.new(
|
1326
|
+
:property_flags,
|
1327
|
+
:property_type,
|
1328
|
+
:unknown)
|
1329
|
+
SENSITIVE = []
|
1330
|
+
include Aws::Structure
|
1331
|
+
include Aws::Structure::Union
|
1332
|
+
|
1333
|
+
class PropertyFlags < KeyUsageProperty; end
|
1334
|
+
class PropertyType < KeyUsageProperty; end
|
1335
|
+
class Unknown < KeyUsageProperty; end
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# Specifies key usage.
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] decrypt
|
1341
|
+
# Allows key for encryption and decryption.
|
1342
|
+
# @return [Boolean]
|
1343
|
+
#
|
1344
|
+
# @!attribute [rw] key_agreement
|
1345
|
+
# Allows key exchange without encryption.
|
1346
|
+
# @return [Boolean]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] sign
|
1349
|
+
# Allow key use for digital signature.
|
1350
|
+
# @return [Boolean]
|
1351
|
+
#
|
1352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/KeyUsagePropertyFlags AWS API Documentation
|
1353
|
+
#
|
1354
|
+
class KeyUsagePropertyFlags < Struct.new(
|
1355
|
+
:decrypt,
|
1356
|
+
:key_agreement,
|
1357
|
+
:sign)
|
1358
|
+
SENSITIVE = []
|
1359
|
+
include Aws::Structure
|
1360
|
+
end
|
1361
|
+
|
1362
|
+
# @!attribute [rw] max_results
|
1363
|
+
# Use this parameter when paginating results to specify the maximum
|
1364
|
+
# number of items to return in the response on each page. If
|
1365
|
+
# additional items exist beyond the number you specify, the
|
1366
|
+
# `NextToken` element is sent in the response. Use this `NextToken`
|
1367
|
+
# value in a subsequent request to retrieve additional items.
|
1368
|
+
# @return [Integer]
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] next_token
|
1371
|
+
# Use this parameter when paginating results in a subsequent request
|
1372
|
+
# after you receive a response with truncated results. Set it to the
|
1373
|
+
# value of the `NextToken` parameter from the response you just
|
1374
|
+
# received.
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListConnectorsRequest AWS API Documentation
|
1378
|
+
#
|
1379
|
+
class ListConnectorsRequest < Struct.new(
|
1380
|
+
:max_results,
|
1381
|
+
:next_token)
|
1382
|
+
SENSITIVE = []
|
1383
|
+
include Aws::Structure
|
1384
|
+
end
|
1385
|
+
|
1386
|
+
# @!attribute [rw] connectors
|
1387
|
+
# Summary information about each connector you have created.
|
1388
|
+
# @return [Array<Types::ConnectorSummary>]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] next_token
|
1391
|
+
# Use this parameter when paginating results in a subsequent request
|
1392
|
+
# after you receive a response with truncated results. Set it to the
|
1393
|
+
# value of the NextToken parameter from the response you just
|
1394
|
+
# received.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListConnectorsResponse AWS API Documentation
|
1398
|
+
#
|
1399
|
+
class ListConnectorsResponse < Struct.new(
|
1400
|
+
:connectors,
|
1401
|
+
:next_token)
|
1402
|
+
SENSITIVE = []
|
1403
|
+
include Aws::Structure
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
# @!attribute [rw] max_results
|
1407
|
+
# Use this parameter when paginating results to specify the maximum
|
1408
|
+
# number of items to return in the response on each page. If
|
1409
|
+
# additional items exist beyond the number you specify, the
|
1410
|
+
# `NextToken` element is sent in the response. Use this `NextToken`
|
1411
|
+
# value in a subsequent request to retrieve additional items.
|
1412
|
+
# @return [Integer]
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] next_token
|
1415
|
+
# Use this parameter when paginating results in a subsequent request
|
1416
|
+
# after you receive a response with truncated results. Set it to the
|
1417
|
+
# value of the `NextToken` parameter from the response you just
|
1418
|
+
# received.
|
1419
|
+
# @return [String]
|
1420
|
+
#
|
1421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListDirectoryRegistrationsRequest AWS API Documentation
|
1422
|
+
#
|
1423
|
+
class ListDirectoryRegistrationsRequest < Struct.new(
|
1424
|
+
:max_results,
|
1425
|
+
:next_token)
|
1426
|
+
SENSITIVE = []
|
1427
|
+
include Aws::Structure
|
1428
|
+
end
|
1429
|
+
|
1430
|
+
# @!attribute [rw] directory_registrations
|
1431
|
+
# Summary information about each directory registration you have
|
1432
|
+
# created.
|
1433
|
+
# @return [Array<Types::DirectoryRegistrationSummary>]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] next_token
|
1436
|
+
# Use this parameter when paginating results in a subsequent request
|
1437
|
+
# after you receive a response with truncated results. Set it to the
|
1438
|
+
# value of the `NextToken` parameter from the response you just
|
1439
|
+
# received.
|
1440
|
+
# @return [String]
|
1441
|
+
#
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListDirectoryRegistrationsResponse AWS API Documentation
|
1443
|
+
#
|
1444
|
+
class ListDirectoryRegistrationsResponse < Struct.new(
|
1445
|
+
:directory_registrations,
|
1446
|
+
:next_token)
|
1447
|
+
SENSITIVE = []
|
1448
|
+
include Aws::Structure
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
# @!attribute [rw] directory_registration_arn
|
1452
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1453
|
+
# [CreateDirectoryRegistration][1].
|
1454
|
+
#
|
1455
|
+
#
|
1456
|
+
#
|
1457
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] max_results
|
1461
|
+
# Use this parameter when paginating results to specify the maximum
|
1462
|
+
# number of items to return in the response on each page. If
|
1463
|
+
# additional items exist beyond the number you specify, the
|
1464
|
+
# `NextToken` element is sent in the response. Use this `NextToken`
|
1465
|
+
# value in a subsequent request to retrieve additional items.
|
1466
|
+
# @return [Integer]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] next_token
|
1469
|
+
# Use this parameter when paginating results in a subsequent request
|
1470
|
+
# after you receive a response with truncated results. Set it to the
|
1471
|
+
# value of the `NextToken` parameter from the response you just
|
1472
|
+
# received.
|
1473
|
+
# @return [String]
|
1474
|
+
#
|
1475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListServicePrincipalNamesRequest AWS API Documentation
|
1476
|
+
#
|
1477
|
+
class ListServicePrincipalNamesRequest < Struct.new(
|
1478
|
+
:directory_registration_arn,
|
1479
|
+
:max_results,
|
1480
|
+
:next_token)
|
1481
|
+
SENSITIVE = []
|
1482
|
+
include Aws::Structure
|
1483
|
+
end
|
1484
|
+
|
1485
|
+
# @!attribute [rw] next_token
|
1486
|
+
# Use this parameter when paginating results in a subsequent request
|
1487
|
+
# after you receive a response with truncated results. Set it to the
|
1488
|
+
# value of the `NextToken` parameter from the response you just
|
1489
|
+
# received.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] service_principal_names
|
1493
|
+
# The service principal name, if any, that the connector uses to
|
1494
|
+
# authenticate with Active Directory.
|
1495
|
+
# @return [Array<Types::ServicePrincipalNameSummary>]
|
1496
|
+
#
|
1497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListServicePrincipalNamesResponse AWS API Documentation
|
1498
|
+
#
|
1499
|
+
class ListServicePrincipalNamesResponse < Struct.new(
|
1500
|
+
:next_token,
|
1501
|
+
:service_principal_names)
|
1502
|
+
SENSITIVE = []
|
1503
|
+
include Aws::Structure
|
1504
|
+
end
|
1505
|
+
|
1506
|
+
# @!attribute [rw] resource_arn
|
1507
|
+
# The Amazon Resource Name (ARN) that was returned when you created
|
1508
|
+
# the resource.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
1512
|
+
#
|
1513
|
+
class ListTagsForResourceRequest < Struct.new(
|
1514
|
+
:resource_arn)
|
1515
|
+
SENSITIVE = []
|
1516
|
+
include Aws::Structure
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# @!attribute [rw] tags
|
1520
|
+
# The tags, if any, that are associated with your resource.
|
1521
|
+
# @return [Hash<String,String>]
|
1522
|
+
#
|
1523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
1524
|
+
#
|
1525
|
+
class ListTagsForResourceResponse < Struct.new(
|
1526
|
+
:tags)
|
1527
|
+
SENSITIVE = []
|
1528
|
+
include Aws::Structure
|
1529
|
+
end
|
1530
|
+
|
1531
|
+
# @!attribute [rw] max_results
|
1532
|
+
# Use this parameter when paginating results to specify the maximum
|
1533
|
+
# number of items to return in the response on each page. If
|
1534
|
+
# additional items exist beyond the number you specify, the
|
1535
|
+
# `NextToken` element is sent in the response. Use this `NextToken`
|
1536
|
+
# value in a subsequent request to retrieve additional items.
|
1537
|
+
# @return [Integer]
|
1538
|
+
#
|
1539
|
+
# @!attribute [rw] next_token
|
1540
|
+
# Use this parameter when paginating results in a subsequent request
|
1541
|
+
# after you receive a response with truncated results. Set it to the
|
1542
|
+
# value of the `NextToken` parameter from the response you just
|
1543
|
+
# received.
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] template_arn
|
1547
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1548
|
+
# [CreateTemplate][1].
|
1549
|
+
#
|
1550
|
+
#
|
1551
|
+
#
|
1552
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTemplateGroupAccessControlEntriesRequest AWS API Documentation
|
1556
|
+
#
|
1557
|
+
class ListTemplateGroupAccessControlEntriesRequest < Struct.new(
|
1558
|
+
:max_results,
|
1559
|
+
:next_token,
|
1560
|
+
:template_arn)
|
1561
|
+
SENSITIVE = []
|
1562
|
+
include Aws::Structure
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# @!attribute [rw] access_control_entries
|
1566
|
+
# An access control entry grants or denies permission to an Active
|
1567
|
+
# Directory group to enroll certificates for a template.
|
1568
|
+
# @return [Array<Types::AccessControlEntrySummary>]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] next_token
|
1571
|
+
# Use this parameter when paginating results in a subsequent request
|
1572
|
+
# after you receive a response with truncated results. Set it to the
|
1573
|
+
# value of the `NextToken` parameter from the response you just
|
1574
|
+
# received.
|
1575
|
+
# @return [String]
|
1576
|
+
#
|
1577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTemplateGroupAccessControlEntriesResponse AWS API Documentation
|
1578
|
+
#
|
1579
|
+
class ListTemplateGroupAccessControlEntriesResponse < Struct.new(
|
1580
|
+
:access_control_entries,
|
1581
|
+
:next_token)
|
1582
|
+
SENSITIVE = []
|
1583
|
+
include Aws::Structure
|
1584
|
+
end
|
1585
|
+
|
1586
|
+
# @!attribute [rw] connector_arn
|
1587
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1588
|
+
# [CreateConnector][1].
|
1589
|
+
#
|
1590
|
+
#
|
1591
|
+
#
|
1592
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
1593
|
+
# @return [String]
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] max_results
|
1596
|
+
# Use this parameter when paginating results to specify the maximum
|
1597
|
+
# number of items to return in the response on each page. If
|
1598
|
+
# additional items exist beyond the number you specify, the
|
1599
|
+
# `NextToken` element is sent in the response. Use this `NextToken`
|
1600
|
+
# value in a subsequent request to retrieve additional items.
|
1601
|
+
# @return [Integer]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] next_token
|
1604
|
+
# Use this parameter when paginating results in a subsequent request
|
1605
|
+
# after you receive a response with truncated results. Set it to the
|
1606
|
+
# value of the `NextToken` parameter from the response you just
|
1607
|
+
# received.
|
1608
|
+
# @return [String]
|
1609
|
+
#
|
1610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTemplatesRequest AWS API Documentation
|
1611
|
+
#
|
1612
|
+
class ListTemplatesRequest < Struct.new(
|
1613
|
+
:connector_arn,
|
1614
|
+
:max_results,
|
1615
|
+
:next_token)
|
1616
|
+
SENSITIVE = []
|
1617
|
+
include Aws::Structure
|
1618
|
+
end
|
1619
|
+
|
1620
|
+
# @!attribute [rw] next_token
|
1621
|
+
# Use this parameter when paginating results in a subsequent request
|
1622
|
+
# after you receive a response with truncated results. Set it to the
|
1623
|
+
# value of the `NextToken` parameter from the response you just
|
1624
|
+
# received.
|
1625
|
+
# @return [String]
|
1626
|
+
#
|
1627
|
+
# @!attribute [rw] templates
|
1628
|
+
# Custom configuration templates used when issuing a certificate.
|
1629
|
+
# @return [Array<Types::TemplateSummary>]
|
1630
|
+
#
|
1631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ListTemplatesResponse AWS API Documentation
|
1632
|
+
#
|
1633
|
+
class ListTemplatesResponse < Struct.new(
|
1634
|
+
:next_token,
|
1635
|
+
:templates)
|
1636
|
+
SENSITIVE = []
|
1637
|
+
include Aws::Structure
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
# Defines the attributes of the private key.
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] crypto_providers
|
1643
|
+
# Defines the cryptographic providers used to generate the private
|
1644
|
+
# key.
|
1645
|
+
# @return [Array<String>]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] key_spec
|
1648
|
+
# Defines the purpose of the private key. Set it to "KEY\_EXCHANGE"
|
1649
|
+
# or "SIGNATURE" value.
|
1650
|
+
# @return [String]
|
1651
|
+
#
|
1652
|
+
# @!attribute [rw] minimal_key_length
|
1653
|
+
# Set the minimum key length of the private key.
|
1654
|
+
# @return [Integer]
|
1655
|
+
#
|
1656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyAttributesV2 AWS API Documentation
|
1657
|
+
#
|
1658
|
+
class PrivateKeyAttributesV2 < Struct.new(
|
1659
|
+
:crypto_providers,
|
1660
|
+
:key_spec,
|
1661
|
+
:minimal_key_length)
|
1662
|
+
SENSITIVE = []
|
1663
|
+
include Aws::Structure
|
1664
|
+
end
|
1665
|
+
|
1666
|
+
# Defines the attributes of the private key.
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] algorithm
|
1669
|
+
# Defines the algorithm used to generate the private key.
|
1670
|
+
# @return [String]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] crypto_providers
|
1673
|
+
# Defines the cryptographic providers used to generate the private
|
1674
|
+
# key.
|
1675
|
+
# @return [Array<String>]
|
1676
|
+
#
|
1677
|
+
# @!attribute [rw] key_spec
|
1678
|
+
# Defines the purpose of the private key. Set it to "KEY\_EXCHANGE"
|
1679
|
+
# or "SIGNATURE" value.
|
1680
|
+
# @return [String]
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] key_usage_property
|
1683
|
+
# The key usage property defines the purpose of the private key
|
1684
|
+
# contained in the certificate. You can specify specific purposes
|
1685
|
+
# using property flags or all by using property type ALL.
|
1686
|
+
# @return [Types::KeyUsageProperty]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] minimal_key_length
|
1689
|
+
# Set the minimum key length of the private key.
|
1690
|
+
# @return [Integer]
|
1691
|
+
#
|
1692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyAttributesV3 AWS API Documentation
|
1693
|
+
#
|
1694
|
+
class PrivateKeyAttributesV3 < Struct.new(
|
1695
|
+
:algorithm,
|
1696
|
+
:crypto_providers,
|
1697
|
+
:key_spec,
|
1698
|
+
:key_usage_property,
|
1699
|
+
:minimal_key_length)
|
1700
|
+
SENSITIVE = []
|
1701
|
+
include Aws::Structure
|
1702
|
+
end
|
1703
|
+
|
1704
|
+
# Defines the attributes of the private key.
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] algorithm
|
1707
|
+
# Defines the algorithm used to generate the private key.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] crypto_providers
|
1711
|
+
# Defines the cryptographic providers used to generate the private
|
1712
|
+
# key.
|
1713
|
+
# @return [Array<String>]
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] key_spec
|
1716
|
+
# Defines the purpose of the private key. Set it to "KEY\_EXCHANGE"
|
1717
|
+
# or "SIGNATURE" value.
|
1718
|
+
# @return [String]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] key_usage_property
|
1721
|
+
# The key usage property defines the purpose of the private key
|
1722
|
+
# contained in the certificate. You can specify specific purposes
|
1723
|
+
# using property flags or all by using property type ALL.
|
1724
|
+
# @return [Types::KeyUsageProperty]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] minimal_key_length
|
1727
|
+
# Set the minimum key length of the private key.
|
1728
|
+
# @return [Integer]
|
1729
|
+
#
|
1730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyAttributesV4 AWS API Documentation
|
1731
|
+
#
|
1732
|
+
class PrivateKeyAttributesV4 < Struct.new(
|
1733
|
+
:algorithm,
|
1734
|
+
:crypto_providers,
|
1735
|
+
:key_spec,
|
1736
|
+
:key_usage_property,
|
1737
|
+
:minimal_key_length)
|
1738
|
+
SENSITIVE = []
|
1739
|
+
include Aws::Structure
|
1740
|
+
end
|
1741
|
+
|
1742
|
+
# Private key flags for v2 templates specify the client compatibility,
|
1743
|
+
# if the private key can be exported, and if user input is required when
|
1744
|
+
# using a private key.
|
1745
|
+
#
|
1746
|
+
# @!attribute [rw] client_version
|
1747
|
+
# Defines the minimum client compatibility.
|
1748
|
+
# @return [String]
|
1749
|
+
#
|
1750
|
+
# @!attribute [rw] exportable_key
|
1751
|
+
# Allows the private key to be exported.
|
1752
|
+
# @return [Boolean]
|
1753
|
+
#
|
1754
|
+
# @!attribute [rw] strong_key_protection_required
|
1755
|
+
# Require user input when using the private key for enrollment.
|
1756
|
+
# @return [Boolean]
|
1757
|
+
#
|
1758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyFlagsV2 AWS API Documentation
|
1759
|
+
#
|
1760
|
+
class PrivateKeyFlagsV2 < Struct.new(
|
1761
|
+
:client_version,
|
1762
|
+
:exportable_key,
|
1763
|
+
:strong_key_protection_required)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Private key flags for v3 templates specify the client compatibility,
|
1769
|
+
# if the private key can be exported, if user input is required when
|
1770
|
+
# using a private key, and if an alternate signature algorithm should be
|
1771
|
+
# used.
|
1772
|
+
#
|
1773
|
+
# @!attribute [rw] client_version
|
1774
|
+
# Defines the minimum client compatibility.
|
1775
|
+
# @return [String]
|
1776
|
+
#
|
1777
|
+
# @!attribute [rw] exportable_key
|
1778
|
+
# Allows the private key to be exported.
|
1779
|
+
# @return [Boolean]
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] require_alternate_signature_algorithm
|
1782
|
+
# Reguires the PKCS #1 v2.1 signature format for certificates. You
|
1783
|
+
# should verify that your CA, objects, and applications can accept
|
1784
|
+
# this signature format.
|
1785
|
+
# @return [Boolean]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] strong_key_protection_required
|
1788
|
+
# Requirer user input when using the private key for enrollment.
|
1789
|
+
# @return [Boolean]
|
1790
|
+
#
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyFlagsV3 AWS API Documentation
|
1792
|
+
#
|
1793
|
+
class PrivateKeyFlagsV3 < Struct.new(
|
1794
|
+
:client_version,
|
1795
|
+
:exportable_key,
|
1796
|
+
:require_alternate_signature_algorithm,
|
1797
|
+
:strong_key_protection_required)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# Private key flags for v4 templates specify the client compatibility,
|
1803
|
+
# if the private key can be exported, if user input is required when
|
1804
|
+
# using a private key, if an alternate signature algorithm should be
|
1805
|
+
# used, and if certificates are renewed using the same private key.
|
1806
|
+
#
|
1807
|
+
# @!attribute [rw] client_version
|
1808
|
+
# Defines the minimum client compatibility.
|
1809
|
+
# @return [String]
|
1810
|
+
#
|
1811
|
+
# @!attribute [rw] exportable_key
|
1812
|
+
# Allows the private key to be exported.
|
1813
|
+
# @return [Boolean]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] require_alternate_signature_algorithm
|
1816
|
+
# Requires the PKCS #1 v2.1 signature format for certificates. You
|
1817
|
+
# should verify that your CA, objects, and applications can accept
|
1818
|
+
# this signature format.
|
1819
|
+
# @return [Boolean]
|
1820
|
+
#
|
1821
|
+
# @!attribute [rw] require_same_key_renewal
|
1822
|
+
# Renew certificate using the same private key.
|
1823
|
+
# @return [Boolean]
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] strong_key_protection_required
|
1826
|
+
# Require user input when using the private key for enrollment.
|
1827
|
+
# @return [Boolean]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] use_legacy_provider
|
1830
|
+
# Specifies the cryptographic service provider category used to
|
1831
|
+
# generate private keys. Set to TRUE to use Legacy Cryptographic
|
1832
|
+
# Service Providers and FALSE to use Key Storage Providers.
|
1833
|
+
# @return [Boolean]
|
1834
|
+
#
|
1835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/PrivateKeyFlagsV4 AWS API Documentation
|
1836
|
+
#
|
1837
|
+
class PrivateKeyFlagsV4 < Struct.new(
|
1838
|
+
:client_version,
|
1839
|
+
:exportable_key,
|
1840
|
+
:require_alternate_signature_algorithm,
|
1841
|
+
:require_same_key_renewal,
|
1842
|
+
:strong_key_protection_required,
|
1843
|
+
:use_legacy_provider)
|
1844
|
+
SENSITIVE = []
|
1845
|
+
include Aws::Structure
|
1846
|
+
end
|
1847
|
+
|
1848
|
+
# The operation tried to access a nonexistent resource. The resource
|
1849
|
+
# might not be specified correctly, or its status might not be ACTIVE.
|
1850
|
+
#
|
1851
|
+
# @!attribute [rw] message
|
1852
|
+
# @return [String]
|
1853
|
+
#
|
1854
|
+
# @!attribute [rw] resource_id
|
1855
|
+
# The identifier of the Amazon Web Services resource.
|
1856
|
+
# @return [String]
|
1857
|
+
#
|
1858
|
+
# @!attribute [rw] resource_type
|
1859
|
+
# The resource type, which can be one of `Connector`, `Template`,
|
1860
|
+
# `TemplateGroupAccessControlEntry`, `ServicePrincipalName`, or
|
1861
|
+
# `DirectoryRegistration`.
|
1862
|
+
# @return [String]
|
1863
|
+
#
|
1864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ResourceNotFoundException AWS API Documentation
|
1865
|
+
#
|
1866
|
+
class ResourceNotFoundException < Struct.new(
|
1867
|
+
:message,
|
1868
|
+
:resource_id,
|
1869
|
+
:resource_type)
|
1870
|
+
SENSITIVE = []
|
1871
|
+
include Aws::Structure
|
1872
|
+
end
|
1873
|
+
|
1874
|
+
# The service principal name that the connector uses to authenticate
|
1875
|
+
# with Active Directory.
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] connector_arn
|
1878
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1879
|
+
# [CreateConnector.html][1].
|
1880
|
+
#
|
1881
|
+
#
|
1882
|
+
#
|
1883
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] created_at
|
1887
|
+
# The date and time that the service principal name was created.
|
1888
|
+
# @return [Time]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] directory_registration_arn
|
1891
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1892
|
+
# [CreateDirectoryRegistration][1].
|
1893
|
+
#
|
1894
|
+
#
|
1895
|
+
#
|
1896
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
1897
|
+
# @return [String]
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] status
|
1900
|
+
# The status of a service principal name.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] status_reason
|
1904
|
+
# Additional information for the status of a service principal name if
|
1905
|
+
# the status is failed.
|
1906
|
+
# @return [String]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] updated_at
|
1909
|
+
# The date and time that the service principal name was updated.
|
1910
|
+
# @return [Time]
|
1911
|
+
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ServicePrincipalName AWS API Documentation
|
1913
|
+
#
|
1914
|
+
class ServicePrincipalName < Struct.new(
|
1915
|
+
:connector_arn,
|
1916
|
+
:created_at,
|
1917
|
+
:directory_registration_arn,
|
1918
|
+
:status,
|
1919
|
+
:status_reason,
|
1920
|
+
:updated_at)
|
1921
|
+
SENSITIVE = []
|
1922
|
+
include Aws::Structure
|
1923
|
+
end
|
1924
|
+
|
1925
|
+
# The service principal name that the connector uses to authenticate
|
1926
|
+
# with Active Directory.
|
1927
|
+
#
|
1928
|
+
# @!attribute [rw] connector_arn
|
1929
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1930
|
+
# [CreateConnector][1].
|
1931
|
+
#
|
1932
|
+
#
|
1933
|
+
#
|
1934
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
1935
|
+
# @return [String]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] created_at
|
1938
|
+
# The date and time that the service principal name was created.
|
1939
|
+
# @return [Time]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] directory_registration_arn
|
1942
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
1943
|
+
# [CreateDirectoryRegistration][1].
|
1944
|
+
#
|
1945
|
+
#
|
1946
|
+
#
|
1947
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
|
1948
|
+
# @return [String]
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] status
|
1951
|
+
# The status of a service principal name.
|
1952
|
+
# @return [String]
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] status_reason
|
1955
|
+
# Additional information for the status of a service principal name if
|
1956
|
+
# the status is failed.
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] updated_at
|
1960
|
+
# Time when the service principal name was updated.
|
1961
|
+
# @return [Time]
|
1962
|
+
#
|
1963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ServicePrincipalNameSummary AWS API Documentation
|
1964
|
+
#
|
1965
|
+
class ServicePrincipalNameSummary < Struct.new(
|
1966
|
+
:connector_arn,
|
1967
|
+
:created_at,
|
1968
|
+
:directory_registration_arn,
|
1969
|
+
:status,
|
1970
|
+
:status_reason,
|
1971
|
+
:updated_at)
|
1972
|
+
SENSITIVE = []
|
1973
|
+
include Aws::Structure
|
1974
|
+
end
|
1975
|
+
|
1976
|
+
# Request would cause a service quota to be exceeded.
|
1977
|
+
#
|
1978
|
+
# @!attribute [rw] message
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] quota_code
|
1982
|
+
# The code associated with the service quota.
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] resource_id
|
1986
|
+
# The identifier of the Amazon Web Services resource.
|
1987
|
+
# @return [String]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] resource_type
|
1990
|
+
# The resource type, which can be one of `Connector`, `Template`,
|
1991
|
+
# `TemplateGroupAccessControlEntry`, `ServicePrincipalName`, or
|
1992
|
+
# `DirectoryRegistration`.
|
1993
|
+
# @return [String]
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] service_code
|
1996
|
+
# Identifies the originating service.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class ServiceQuotaExceededException < Struct.new(
|
2002
|
+
:message,
|
2003
|
+
:quota_code,
|
2004
|
+
:resource_id,
|
2005
|
+
:resource_type,
|
2006
|
+
:service_code)
|
2007
|
+
SENSITIVE = []
|
2008
|
+
include Aws::Structure
|
2009
|
+
end
|
2010
|
+
|
2011
|
+
# Information to include in the subject name and alternate subject name
|
2012
|
+
# of the certificate. The subject name can be common name, directory
|
2013
|
+
# path, DNS as common name, or left blank. You can optionally include
|
2014
|
+
# email to the subject name for user templates. If you leave the subject
|
2015
|
+
# name blank then you must set a subject alternate name. The subject
|
2016
|
+
# alternate name (SAN) can include globally unique identifier (GUID),
|
2017
|
+
# DNS, domain DNS, email, service principal name (SPN), and user
|
2018
|
+
# principal name (UPN). You can leave the SAN blank. If you leave the
|
2019
|
+
# SAN blank, then you must set a subject name.
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] require_common_name
|
2022
|
+
# Include the common name in the subject name.
|
2023
|
+
# @return [Boolean]
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] require_directory_path
|
2026
|
+
# Include the directory path in the subject name.
|
2027
|
+
# @return [Boolean]
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] require_dns_as_cn
|
2030
|
+
# Include the DNS as common name in the subject name.
|
2031
|
+
# @return [Boolean]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] require_email
|
2034
|
+
# Include the subject's email in the subject name.
|
2035
|
+
# @return [Boolean]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] san_require_directory_guid
|
2038
|
+
# Include the globally unique identifier (GUID) in the subject
|
2039
|
+
# alternate name.
|
2040
|
+
# @return [Boolean]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] san_require_dns
|
2043
|
+
# Include the DNS in the subject alternate name.
|
2044
|
+
# @return [Boolean]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] san_require_domain_dns
|
2047
|
+
# Include the domain DNS in the subject alternate name.
|
2048
|
+
# @return [Boolean]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] san_require_email
|
2051
|
+
# Include the subject's email in the subject alternate name.
|
2052
|
+
# @return [Boolean]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] san_require_spn
|
2055
|
+
# Include the service principal name (SPN) in the subject alternate
|
2056
|
+
# name.
|
2057
|
+
# @return [Boolean]
|
2058
|
+
#
|
2059
|
+
# @!attribute [rw] san_require_upn
|
2060
|
+
# Include the user principal name (UPN) in the subject alternate name.
|
2061
|
+
# @return [Boolean]
|
2062
|
+
#
|
2063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/SubjectNameFlagsV2 AWS API Documentation
|
2064
|
+
#
|
2065
|
+
class SubjectNameFlagsV2 < Struct.new(
|
2066
|
+
:require_common_name,
|
2067
|
+
:require_directory_path,
|
2068
|
+
:require_dns_as_cn,
|
2069
|
+
:require_email,
|
2070
|
+
:san_require_directory_guid,
|
2071
|
+
:san_require_dns,
|
2072
|
+
:san_require_domain_dns,
|
2073
|
+
:san_require_email,
|
2074
|
+
:san_require_spn,
|
2075
|
+
:san_require_upn)
|
2076
|
+
SENSITIVE = []
|
2077
|
+
include Aws::Structure
|
2078
|
+
end
|
2079
|
+
|
2080
|
+
# Information to include in the subject name and alternate subject name
|
2081
|
+
# of the certificate. The subject name can be common name, directory
|
2082
|
+
# path, DNS as common name, or left blank. You can optionally include
|
2083
|
+
# email to the subject name for user templates. If you leave the subject
|
2084
|
+
# name blank then you must set a subject alternate name. The subject
|
2085
|
+
# alternate name (SAN) can include globally unique identifier (GUID),
|
2086
|
+
# DNS, domain DNS, email, service principal name (SPN), and user
|
2087
|
+
# principal name (UPN). You can leave the SAN blank. If you leave the
|
2088
|
+
# SAN blank, then you must set a subject name.
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] require_common_name
|
2091
|
+
# Include the common name in the subject name.
|
2092
|
+
# @return [Boolean]
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] require_directory_path
|
2095
|
+
# Include the directory path in the subject name.
|
2096
|
+
# @return [Boolean]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] require_dns_as_cn
|
2099
|
+
# Include the DNS as common name in the subject name.
|
2100
|
+
# @return [Boolean]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] require_email
|
2103
|
+
# Include the subject's email in the subject name.
|
2104
|
+
# @return [Boolean]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] san_require_directory_guid
|
2107
|
+
# Include the globally unique identifier (GUID) in the subject
|
2108
|
+
# alternate name.
|
2109
|
+
# @return [Boolean]
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] san_require_dns
|
2112
|
+
# Include the DNS in the subject alternate name.
|
2113
|
+
# @return [Boolean]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] san_require_domain_dns
|
2116
|
+
# Include the domain DNS in the subject alternate name.
|
2117
|
+
# @return [Boolean]
|
2118
|
+
#
|
2119
|
+
# @!attribute [rw] san_require_email
|
2120
|
+
# Include the subject's email in the subject alternate name.
|
2121
|
+
# @return [Boolean]
|
2122
|
+
#
|
2123
|
+
# @!attribute [rw] san_require_spn
|
2124
|
+
# Include the service principal name (SPN) in the subject alternate
|
2125
|
+
# name.
|
2126
|
+
# @return [Boolean]
|
2127
|
+
#
|
2128
|
+
# @!attribute [rw] san_require_upn
|
2129
|
+
# Include the user principal name (UPN) in the subject alternate name.
|
2130
|
+
# @return [Boolean]
|
2131
|
+
#
|
2132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/SubjectNameFlagsV3 AWS API Documentation
|
2133
|
+
#
|
2134
|
+
class SubjectNameFlagsV3 < Struct.new(
|
2135
|
+
:require_common_name,
|
2136
|
+
:require_directory_path,
|
2137
|
+
:require_dns_as_cn,
|
2138
|
+
:require_email,
|
2139
|
+
:san_require_directory_guid,
|
2140
|
+
:san_require_dns,
|
2141
|
+
:san_require_domain_dns,
|
2142
|
+
:san_require_email,
|
2143
|
+
:san_require_spn,
|
2144
|
+
:san_require_upn)
|
2145
|
+
SENSITIVE = []
|
2146
|
+
include Aws::Structure
|
2147
|
+
end
|
2148
|
+
|
2149
|
+
# Information to include in the subject name and alternate subject name
|
2150
|
+
# of the certificate. The subject name can be common name, directory
|
2151
|
+
# path, DNS as common name, or left blank. You can optionally include
|
2152
|
+
# email to the subject name for user templates. If you leave the subject
|
2153
|
+
# name blank then you must set a subject alternate name. The subject
|
2154
|
+
# alternate name (SAN) can include globally unique identifier (GUID),
|
2155
|
+
# DNS, domain DNS, email, service principal name (SPN), and user
|
2156
|
+
# principal name (UPN). You can leave the SAN blank. If you leave the
|
2157
|
+
# SAN blank, then you must set a subject name.
|
2158
|
+
#
|
2159
|
+
# @!attribute [rw] require_common_name
|
2160
|
+
# Include the common name in the subject name.
|
2161
|
+
# @return [Boolean]
|
2162
|
+
#
|
2163
|
+
# @!attribute [rw] require_directory_path
|
2164
|
+
# Include the directory path in the subject name.
|
2165
|
+
# @return [Boolean]
|
2166
|
+
#
|
2167
|
+
# @!attribute [rw] require_dns_as_cn
|
2168
|
+
# Include the DNS as common name in the subject name.
|
2169
|
+
# @return [Boolean]
|
2170
|
+
#
|
2171
|
+
# @!attribute [rw] require_email
|
2172
|
+
# Include the subject's email in the subject name.
|
2173
|
+
# @return [Boolean]
|
2174
|
+
#
|
2175
|
+
# @!attribute [rw] san_require_directory_guid
|
2176
|
+
# Include the globally unique identifier (GUID) in the subject
|
2177
|
+
# alternate name.
|
2178
|
+
# @return [Boolean]
|
2179
|
+
#
|
2180
|
+
# @!attribute [rw] san_require_dns
|
2181
|
+
# Include the DNS in the subject alternate name.
|
2182
|
+
# @return [Boolean]
|
2183
|
+
#
|
2184
|
+
# @!attribute [rw] san_require_domain_dns
|
2185
|
+
# Include the domain DNS in the subject alternate name.
|
2186
|
+
# @return [Boolean]
|
2187
|
+
#
|
2188
|
+
# @!attribute [rw] san_require_email
|
2189
|
+
# Include the subject's email in the subject alternate name.
|
2190
|
+
# @return [Boolean]
|
2191
|
+
#
|
2192
|
+
# @!attribute [rw] san_require_spn
|
2193
|
+
# Include the service principal name (SPN) in the subject alternate
|
2194
|
+
# name.
|
2195
|
+
# @return [Boolean]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] san_require_upn
|
2198
|
+
# Include the user principal name (UPN) in the subject alternate name.
|
2199
|
+
# @return [Boolean]
|
2200
|
+
#
|
2201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/SubjectNameFlagsV4 AWS API Documentation
|
2202
|
+
#
|
2203
|
+
class SubjectNameFlagsV4 < Struct.new(
|
2204
|
+
:require_common_name,
|
2205
|
+
:require_directory_path,
|
2206
|
+
:require_dns_as_cn,
|
2207
|
+
:require_email,
|
2208
|
+
:san_require_directory_guid,
|
2209
|
+
:san_require_dns,
|
2210
|
+
:san_require_domain_dns,
|
2211
|
+
:san_require_email,
|
2212
|
+
:san_require_spn,
|
2213
|
+
:san_require_upn)
|
2214
|
+
SENSITIVE = []
|
2215
|
+
include Aws::Structure
|
2216
|
+
end
|
2217
|
+
|
2218
|
+
# @!attribute [rw] resource_arn
|
2219
|
+
# The Amazon Resource Name (ARN) that was returned when you created
|
2220
|
+
# the resource.
|
2221
|
+
# @return [String]
|
2222
|
+
#
|
2223
|
+
# @!attribute [rw] tags
|
2224
|
+
# Metadata assigned to a directory registration consisting of a
|
2225
|
+
# key-value pair.
|
2226
|
+
# @return [Hash<String,String>]
|
2227
|
+
#
|
2228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TagResourceRequest AWS API Documentation
|
2229
|
+
#
|
2230
|
+
class TagResourceRequest < Struct.new(
|
2231
|
+
:resource_arn,
|
2232
|
+
:tags)
|
2233
|
+
SENSITIVE = []
|
2234
|
+
include Aws::Structure
|
2235
|
+
end
|
2236
|
+
|
2237
|
+
# An Active Directory compatible certificate template. Connectors issue
|
2238
|
+
# certificates against these templates based on the requestor's Active
|
2239
|
+
# Directory group membership.
|
2240
|
+
#
|
2241
|
+
# @!attribute [rw] arn
|
2242
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2243
|
+
# [CreateTemplate][1].
|
2244
|
+
#
|
2245
|
+
#
|
2246
|
+
#
|
2247
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
2248
|
+
# @return [String]
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] connector_arn
|
2251
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2252
|
+
# [CreateConnector][1].
|
2253
|
+
#
|
2254
|
+
#
|
2255
|
+
#
|
2256
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
2257
|
+
# @return [String]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] created_at
|
2260
|
+
# The date and time that the template was created.
|
2261
|
+
# @return [Time]
|
2262
|
+
#
|
2263
|
+
# @!attribute [rw] definition
|
2264
|
+
# Template configuration to define the information included in
|
2265
|
+
# certificates. Define certificate validity and renewal periods,
|
2266
|
+
# certificate request handling and enrollment options, key usage
|
2267
|
+
# extensions, application policies, and cryptography settings.
|
2268
|
+
# @return [Types::TemplateDefinition]
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] name
|
2271
|
+
# Name of the templates. Template names must be unique.
|
2272
|
+
# @return [String]
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] object_identifier
|
2275
|
+
# Object identifier of a template.
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] policy_schema
|
2279
|
+
# The template schema version. Template schema versions can be v2, v3,
|
2280
|
+
# or v4. The template configuration options change based on the
|
2281
|
+
# template schema version.
|
2282
|
+
# @return [Integer]
|
2283
|
+
#
|
2284
|
+
# @!attribute [rw] revision
|
2285
|
+
# The version of the template. Template updates will increment the
|
2286
|
+
# minor revision. Re-enrolling all certificate holders will increment
|
2287
|
+
# the major revision.
|
2288
|
+
# @return [Types::TemplateRevision]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] status
|
2291
|
+
# Status of the template. Status can be creating, active, deleting, or
|
2292
|
+
# failed.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] updated_at
|
2296
|
+
# The date and time that the template was updated.
|
2297
|
+
# @return [Time]
|
2298
|
+
#
|
2299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/Template AWS API Documentation
|
2300
|
+
#
|
2301
|
+
class Template < Struct.new(
|
2302
|
+
:arn,
|
2303
|
+
:connector_arn,
|
2304
|
+
:created_at,
|
2305
|
+
:definition,
|
2306
|
+
:name,
|
2307
|
+
:object_identifier,
|
2308
|
+
:policy_schema,
|
2309
|
+
:revision,
|
2310
|
+
:status,
|
2311
|
+
:updated_at)
|
2312
|
+
SENSITIVE = []
|
2313
|
+
include Aws::Structure
|
2314
|
+
end
|
2315
|
+
|
2316
|
+
# Template configuration to define the information included in
|
2317
|
+
# certificates. Define certificate validity and renewal periods,
|
2318
|
+
# certificate request handling and enrollment options, key usage
|
2319
|
+
# extensions, application policies, and cryptography settings.
|
2320
|
+
#
|
2321
|
+
# @note TemplateDefinition is a union - when making an API calls you must set exactly one of the members.
|
2322
|
+
#
|
2323
|
+
# @note TemplateDefinition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TemplateDefinition corresponding to the set member.
|
2324
|
+
#
|
2325
|
+
# @!attribute [rw] template_v2
|
2326
|
+
# Template configuration to define the information included in
|
2327
|
+
# certificates. Define certificate validity and renewal periods,
|
2328
|
+
# certificate request handling and enrollment options, key usage
|
2329
|
+
# extensions, application policies, and cryptography settings.
|
2330
|
+
# @return [Types::TemplateV2]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] template_v3
|
2333
|
+
# Template configuration to define the information included in
|
2334
|
+
# certificates. Define certificate validity and renewal periods,
|
2335
|
+
# certificate request handling and enrollment options, key usage
|
2336
|
+
# extensions, application policies, and cryptography settings.
|
2337
|
+
# @return [Types::TemplateV3]
|
2338
|
+
#
|
2339
|
+
# @!attribute [rw] template_v4
|
2340
|
+
# Template configuration to define the information included in
|
2341
|
+
# certificates. Define certificate validity and renewal periods,
|
2342
|
+
# certificate request handling and enrollment options, key usage
|
2343
|
+
# extensions, application policies, and cryptography settings.
|
2344
|
+
# @return [Types::TemplateV4]
|
2345
|
+
#
|
2346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateDefinition AWS API Documentation
|
2347
|
+
#
|
2348
|
+
class TemplateDefinition < Struct.new(
|
2349
|
+
:template_v2,
|
2350
|
+
:template_v3,
|
2351
|
+
:template_v4,
|
2352
|
+
:unknown)
|
2353
|
+
SENSITIVE = []
|
2354
|
+
include Aws::Structure
|
2355
|
+
include Aws::Structure::Union
|
2356
|
+
|
2357
|
+
class TemplateV2 < TemplateDefinition; end
|
2358
|
+
class TemplateV3 < TemplateDefinition; end
|
2359
|
+
class TemplateV4 < TemplateDefinition; end
|
2360
|
+
class Unknown < TemplateDefinition; end
|
2361
|
+
end
|
2362
|
+
|
2363
|
+
# The revision version of the template. Template updates will increment
|
2364
|
+
# the minor revision. Re-enrolling all certificate holders will
|
2365
|
+
# increment the major revision.
|
2366
|
+
#
|
2367
|
+
# @!attribute [rw] major_revision
|
2368
|
+
# The revision version of the template. Re-enrolling all certificate
|
2369
|
+
# holders will increment the major revision.
|
2370
|
+
# @return [Integer]
|
2371
|
+
#
|
2372
|
+
# @!attribute [rw] minor_revision
|
2373
|
+
# The revision version of the template. Re-enrolling all certificate
|
2374
|
+
# holders will increment the major revision.
|
2375
|
+
# @return [Integer]
|
2376
|
+
#
|
2377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateRevision AWS API Documentation
|
2378
|
+
#
|
2379
|
+
class TemplateRevision < Struct.new(
|
2380
|
+
:major_revision,
|
2381
|
+
:minor_revision)
|
2382
|
+
SENSITIVE = []
|
2383
|
+
include Aws::Structure
|
2384
|
+
end
|
2385
|
+
|
2386
|
+
# An Active Directory compatible certificate template. Connectors issue
|
2387
|
+
# certificates against these templates based on the requestor's Active
|
2388
|
+
# Directory group membership.
|
2389
|
+
#
|
2390
|
+
# @!attribute [rw] arn
|
2391
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2392
|
+
# [CreateTemplate][1].
|
2393
|
+
#
|
2394
|
+
#
|
2395
|
+
#
|
2396
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
2397
|
+
# @return [String]
|
2398
|
+
#
|
2399
|
+
# @!attribute [rw] connector_arn
|
2400
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2401
|
+
# [CreateConnector][1].
|
2402
|
+
#
|
2403
|
+
#
|
2404
|
+
#
|
2405
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
|
2406
|
+
# @return [String]
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] created_at
|
2409
|
+
# The date and time that the template was created.
|
2410
|
+
# @return [Time]
|
2411
|
+
#
|
2412
|
+
# @!attribute [rw] definition
|
2413
|
+
# Template configuration to define the information included in
|
2414
|
+
# certificates. Define certificate validity and renewal periods,
|
2415
|
+
# certificate request handling and enrollment options, key usage
|
2416
|
+
# extensions, application policies, and cryptography settings.
|
2417
|
+
# @return [Types::TemplateDefinition]
|
2418
|
+
#
|
2419
|
+
# @!attribute [rw] name
|
2420
|
+
# Name of the template. The template name must be unique.
|
2421
|
+
# @return [String]
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] object_identifier
|
2424
|
+
# Object identifier of a template.
|
2425
|
+
# @return [String]
|
2426
|
+
#
|
2427
|
+
# @!attribute [rw] policy_schema
|
2428
|
+
# The template schema version. Template schema versions can be v2, v3,
|
2429
|
+
# or v4. The template configuration options change based on the
|
2430
|
+
# template schema version.
|
2431
|
+
# @return [Integer]
|
2432
|
+
#
|
2433
|
+
# @!attribute [rw] revision
|
2434
|
+
# The revision version of the template. Template updates will
|
2435
|
+
# increment the minor revision. Re-enrolling all certificate holders
|
2436
|
+
# will increment the major revision.
|
2437
|
+
# @return [Types::TemplateRevision]
|
2438
|
+
#
|
2439
|
+
# @!attribute [rw] status
|
2440
|
+
# Status of the template. Status can be creating, active, deleting, or
|
2441
|
+
# failed.
|
2442
|
+
# @return [String]
|
2443
|
+
#
|
2444
|
+
# @!attribute [rw] updated_at
|
2445
|
+
# The date and time that the template was updated.
|
2446
|
+
# @return [Time]
|
2447
|
+
#
|
2448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateSummary AWS API Documentation
|
2449
|
+
#
|
2450
|
+
class TemplateSummary < Struct.new(
|
2451
|
+
:arn,
|
2452
|
+
:connector_arn,
|
2453
|
+
:created_at,
|
2454
|
+
:definition,
|
2455
|
+
:name,
|
2456
|
+
:object_identifier,
|
2457
|
+
:policy_schema,
|
2458
|
+
:revision,
|
2459
|
+
:status,
|
2460
|
+
:updated_at)
|
2461
|
+
SENSITIVE = []
|
2462
|
+
include Aws::Structure
|
2463
|
+
end
|
2464
|
+
|
2465
|
+
# v2 template schema that uses Legacy Cryptographic Providers.
|
2466
|
+
#
|
2467
|
+
# @!attribute [rw] certificate_validity
|
2468
|
+
# Certificate validity describes the validity and renewal periods of a
|
2469
|
+
# certificate.
|
2470
|
+
# @return [Types::CertificateValidity]
|
2471
|
+
#
|
2472
|
+
# @!attribute [rw] enrollment_flags
|
2473
|
+
# Enrollment flags describe the enrollment settings for certificates
|
2474
|
+
# such as using the existing private key and deleting expired or
|
2475
|
+
# revoked certificates.
|
2476
|
+
# @return [Types::EnrollmentFlagsV2]
|
2477
|
+
#
|
2478
|
+
# @!attribute [rw] extensions
|
2479
|
+
# Extensions describe the key usage extensions and application
|
2480
|
+
# policies for a template.
|
2481
|
+
# @return [Types::ExtensionsV2]
|
2482
|
+
#
|
2483
|
+
# @!attribute [rw] general_flags
|
2484
|
+
# General flags describe whether the template is used for computers or
|
2485
|
+
# users and if the template can be used with autoenrollment.
|
2486
|
+
# @return [Types::GeneralFlagsV2]
|
2487
|
+
#
|
2488
|
+
# @!attribute [rw] private_key_attributes
|
2489
|
+
# Private key attributes allow you to specify the minimal key length,
|
2490
|
+
# key spec, and cryptographic providers for the private key of a
|
2491
|
+
# certificate for v2 templates. V2 templates allow you to use Legacy
|
2492
|
+
# Cryptographic Service Providers.
|
2493
|
+
# @return [Types::PrivateKeyAttributesV2]
|
2494
|
+
#
|
2495
|
+
# @!attribute [rw] private_key_flags
|
2496
|
+
# Private key flags for v2 templates specify the client compatibility,
|
2497
|
+
# if the private key can be exported, and if user input is required
|
2498
|
+
# when using a private key.
|
2499
|
+
# @return [Types::PrivateKeyFlagsV2]
|
2500
|
+
#
|
2501
|
+
# @!attribute [rw] subject_name_flags
|
2502
|
+
# Subject name flags describe the subject name and subject alternate
|
2503
|
+
# name that is included in a certificate.
|
2504
|
+
# @return [Types::SubjectNameFlagsV2]
|
2505
|
+
#
|
2506
|
+
# @!attribute [rw] superseded_templates
|
2507
|
+
# List of templates in Active Directory that are superseded by this
|
2508
|
+
# template.
|
2509
|
+
# @return [Array<String>]
|
2510
|
+
#
|
2511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateV2 AWS API Documentation
|
2512
|
+
#
|
2513
|
+
class TemplateV2 < Struct.new(
|
2514
|
+
:certificate_validity,
|
2515
|
+
:enrollment_flags,
|
2516
|
+
:extensions,
|
2517
|
+
:general_flags,
|
2518
|
+
:private_key_attributes,
|
2519
|
+
:private_key_flags,
|
2520
|
+
:subject_name_flags,
|
2521
|
+
:superseded_templates)
|
2522
|
+
SENSITIVE = []
|
2523
|
+
include Aws::Structure
|
2524
|
+
end
|
2525
|
+
|
2526
|
+
# v3 template schema that uses Key Storage Providers.
|
2527
|
+
#
|
2528
|
+
# @!attribute [rw] certificate_validity
|
2529
|
+
# Certificate validity describes the validity and renewal periods of a
|
2530
|
+
# certificate.
|
2531
|
+
# @return [Types::CertificateValidity]
|
2532
|
+
#
|
2533
|
+
# @!attribute [rw] enrollment_flags
|
2534
|
+
# Enrollment flags describe the enrollment settings for certificates
|
2535
|
+
# such as using the existing private key and deleting expired or
|
2536
|
+
# revoked certificates.
|
2537
|
+
# @return [Types::EnrollmentFlagsV3]
|
2538
|
+
#
|
2539
|
+
# @!attribute [rw] extensions
|
2540
|
+
# Extensions describe the key usage extensions and application
|
2541
|
+
# policies for a template.
|
2542
|
+
# @return [Types::ExtensionsV3]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] general_flags
|
2545
|
+
# General flags describe whether the template is used for computers or
|
2546
|
+
# users and if the template can be used with autoenrollment.
|
2547
|
+
# @return [Types::GeneralFlagsV3]
|
2548
|
+
#
|
2549
|
+
# @!attribute [rw] hash_algorithm
|
2550
|
+
# Specifies the hash algorithm used to hash the private key.
|
2551
|
+
# @return [String]
|
2552
|
+
#
|
2553
|
+
# @!attribute [rw] private_key_attributes
|
2554
|
+
# Private key attributes allow you to specify the algorithm, minimal
|
2555
|
+
# key length, key spec, key usage, and cryptographic providers for the
|
2556
|
+
# private key of a certificate for v3 templates. V3 templates allow
|
2557
|
+
# you to use Key Storage Providers.
|
2558
|
+
# @return [Types::PrivateKeyAttributesV3]
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] private_key_flags
|
2561
|
+
# Private key flags for v3 templates specify the client compatibility,
|
2562
|
+
# if the private key can be exported, if user input is required when
|
2563
|
+
# using a private key, and if an alternate signature algorithm should
|
2564
|
+
# be used.
|
2565
|
+
# @return [Types::PrivateKeyFlagsV3]
|
2566
|
+
#
|
2567
|
+
# @!attribute [rw] subject_name_flags
|
2568
|
+
# Subject name flags describe the subject name and subject alternate
|
2569
|
+
# name that is included in a certificate.
|
2570
|
+
# @return [Types::SubjectNameFlagsV3]
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] superseded_templates
|
2573
|
+
# List of templates in Active Directory that are superseded by this
|
2574
|
+
# template.
|
2575
|
+
# @return [Array<String>]
|
2576
|
+
#
|
2577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateV3 AWS API Documentation
|
2578
|
+
#
|
2579
|
+
class TemplateV3 < Struct.new(
|
2580
|
+
:certificate_validity,
|
2581
|
+
:enrollment_flags,
|
2582
|
+
:extensions,
|
2583
|
+
:general_flags,
|
2584
|
+
:hash_algorithm,
|
2585
|
+
:private_key_attributes,
|
2586
|
+
:private_key_flags,
|
2587
|
+
:subject_name_flags,
|
2588
|
+
:superseded_templates)
|
2589
|
+
SENSITIVE = []
|
2590
|
+
include Aws::Structure
|
2591
|
+
end
|
2592
|
+
|
2593
|
+
# v4 template schema that can use either Legacy Cryptographic Providers
|
2594
|
+
# or Key Storage Providers.
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] certificate_validity
|
2597
|
+
# Certificate validity describes the validity and renewal periods of a
|
2598
|
+
# certificate.
|
2599
|
+
# @return [Types::CertificateValidity]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] enrollment_flags
|
2602
|
+
# Enrollment flags describe the enrollment settings for certificates
|
2603
|
+
# using the existing private key and deleting expired or revoked
|
2604
|
+
# certificates.
|
2605
|
+
# @return [Types::EnrollmentFlagsV4]
|
2606
|
+
#
|
2607
|
+
# @!attribute [rw] extensions
|
2608
|
+
# Extensions describe the key usage extensions and application
|
2609
|
+
# policies for a template.
|
2610
|
+
# @return [Types::ExtensionsV4]
|
2611
|
+
#
|
2612
|
+
# @!attribute [rw] general_flags
|
2613
|
+
# General flags describe whether the template is used for computers or
|
2614
|
+
# users and if the template can be used with autoenrollment.
|
2615
|
+
# @return [Types::GeneralFlagsV4]
|
2616
|
+
#
|
2617
|
+
# @!attribute [rw] hash_algorithm
|
2618
|
+
# Specifies the hash algorithm used to hash the private key. Hash
|
2619
|
+
# algorithm can only be specified when using Key Storage Providers.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2622
|
+
# @!attribute [rw] private_key_attributes
|
2623
|
+
# Private key attributes allow you to specify the minimal key length,
|
2624
|
+
# key spec, key usage, and cryptographic providers for the private key
|
2625
|
+
# of a certificate for v4 templates. V4 templates allow you to use
|
2626
|
+
# either Key Storage Providers or Legacy Cryptographic Service
|
2627
|
+
# Providers. You specify the cryptography provider category in private
|
2628
|
+
# key flags.
|
2629
|
+
# @return [Types::PrivateKeyAttributesV4]
|
2630
|
+
#
|
2631
|
+
# @!attribute [rw] private_key_flags
|
2632
|
+
# Private key flags for v4 templates specify the client compatibility,
|
2633
|
+
# if the private key can be exported, if user input is required when
|
2634
|
+
# using a private key, if an alternate signature algorithm should be
|
2635
|
+
# used, and if certificates are renewed using the same private key.
|
2636
|
+
# @return [Types::PrivateKeyFlagsV4]
|
2637
|
+
#
|
2638
|
+
# @!attribute [rw] subject_name_flags
|
2639
|
+
# Subject name flags describe the subject name and subject alternate
|
2640
|
+
# name that is included in a certificate.
|
2641
|
+
# @return [Types::SubjectNameFlagsV4]
|
2642
|
+
#
|
2643
|
+
# @!attribute [rw] superseded_templates
|
2644
|
+
# List of templates in Active Directory that are superseded by this
|
2645
|
+
# template.
|
2646
|
+
# @return [Array<String>]
|
2647
|
+
#
|
2648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/TemplateV4 AWS API Documentation
|
2649
|
+
#
|
2650
|
+
class TemplateV4 < Struct.new(
|
2651
|
+
:certificate_validity,
|
2652
|
+
:enrollment_flags,
|
2653
|
+
:extensions,
|
2654
|
+
:general_flags,
|
2655
|
+
:hash_algorithm,
|
2656
|
+
:private_key_attributes,
|
2657
|
+
:private_key_flags,
|
2658
|
+
:subject_name_flags,
|
2659
|
+
:superseded_templates)
|
2660
|
+
SENSITIVE = []
|
2661
|
+
include Aws::Structure
|
2662
|
+
end
|
2663
|
+
|
2664
|
+
# The limit on the number of requests per second was exceeded.
|
2665
|
+
#
|
2666
|
+
# @!attribute [rw] message
|
2667
|
+
# @return [String]
|
2668
|
+
#
|
2669
|
+
# @!attribute [rw] quota_code
|
2670
|
+
# The code associated with the quota.
|
2671
|
+
# @return [String]
|
2672
|
+
#
|
2673
|
+
# @!attribute [rw] service_code
|
2674
|
+
# Identifies the originating service.
|
2675
|
+
# @return [String]
|
2676
|
+
#
|
2677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ThrottlingException AWS API Documentation
|
2678
|
+
#
|
2679
|
+
class ThrottlingException < Struct.new(
|
2680
|
+
:message,
|
2681
|
+
:quota_code,
|
2682
|
+
:service_code)
|
2683
|
+
SENSITIVE = []
|
2684
|
+
include Aws::Structure
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
# @!attribute [rw] resource_arn
|
2688
|
+
# The Amazon Resource Name (ARN) that was returned when you created
|
2689
|
+
# the resource.
|
2690
|
+
# @return [String]
|
2691
|
+
#
|
2692
|
+
# @!attribute [rw] tag_keys
|
2693
|
+
# Specifies a list of tag keys that you want to remove from the
|
2694
|
+
# specified resources.
|
2695
|
+
# @return [Array<String>]
|
2696
|
+
#
|
2697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/UntagResourceRequest AWS API Documentation
|
2698
|
+
#
|
2699
|
+
class UntagResourceRequest < Struct.new(
|
2700
|
+
:resource_arn,
|
2701
|
+
:tag_keys)
|
2702
|
+
SENSITIVE = []
|
2703
|
+
include Aws::Structure
|
2704
|
+
end
|
2705
|
+
|
2706
|
+
# @!attribute [rw] access_rights
|
2707
|
+
# Allow or deny permissions for an Active Directory group to enroll or
|
2708
|
+
# autoenroll certificates for a template.
|
2709
|
+
# @return [Types::AccessRights]
|
2710
|
+
#
|
2711
|
+
# @!attribute [rw] group_display_name
|
2712
|
+
# Name of the Active Directory group. This name does not need to match
|
2713
|
+
# the group name in Active Directory.
|
2714
|
+
# @return [String]
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] group_security_identifier
|
2717
|
+
# Security identifier (SID) of the group object from Active Directory.
|
2718
|
+
# The SID starts with "S-".
|
2719
|
+
# @return [String]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] template_arn
|
2722
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2723
|
+
# [CreateTemplate][1].
|
2724
|
+
#
|
2725
|
+
#
|
2726
|
+
#
|
2727
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
2728
|
+
# @return [String]
|
2729
|
+
#
|
2730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/UpdateTemplateGroupAccessControlEntryRequest AWS API Documentation
|
2731
|
+
#
|
2732
|
+
class UpdateTemplateGroupAccessControlEntryRequest < Struct.new(
|
2733
|
+
:access_rights,
|
2734
|
+
:group_display_name,
|
2735
|
+
:group_security_identifier,
|
2736
|
+
:template_arn)
|
2737
|
+
SENSITIVE = []
|
2738
|
+
include Aws::Structure
|
2739
|
+
end
|
2740
|
+
|
2741
|
+
# @!attribute [rw] definition
|
2742
|
+
# Template configuration to define the information included in
|
2743
|
+
# certificates. Define certificate validity and renewal periods,
|
2744
|
+
# certificate request handling and enrollment options, key usage
|
2745
|
+
# extensions, application policies, and cryptography settings.
|
2746
|
+
# @return [Types::TemplateDefinition]
|
2747
|
+
#
|
2748
|
+
# @!attribute [rw] reenroll_all_certificate_holders
|
2749
|
+
# This setting allows the major version of a template to be increased
|
2750
|
+
# automatically. All members of Active Directory groups that are
|
2751
|
+
# allowed to enroll with a template will receive a new certificate
|
2752
|
+
# issued using that template.
|
2753
|
+
# @return [Boolean]
|
2754
|
+
#
|
2755
|
+
# @!attribute [rw] template_arn
|
2756
|
+
# The Amazon Resource Name (ARN) that was returned when you called
|
2757
|
+
# [CreateTemplate][1].
|
2758
|
+
#
|
2759
|
+
#
|
2760
|
+
#
|
2761
|
+
# [1]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
|
2762
|
+
# @return [String]
|
2763
|
+
#
|
2764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/UpdateTemplateRequest AWS API Documentation
|
2765
|
+
#
|
2766
|
+
class UpdateTemplateRequest < Struct.new(
|
2767
|
+
:definition,
|
2768
|
+
:reenroll_all_certificate_holders,
|
2769
|
+
:template_arn)
|
2770
|
+
SENSITIVE = []
|
2771
|
+
include Aws::Structure
|
2772
|
+
end
|
2773
|
+
|
2774
|
+
# An input validation error occurred. For example, invalid characters in
|
2775
|
+
# a template name, or if a pagination token is invalid.
|
2776
|
+
#
|
2777
|
+
# @!attribute [rw] message
|
2778
|
+
# @return [String]
|
2779
|
+
#
|
2780
|
+
# @!attribute [rw] reason
|
2781
|
+
# The reason for the validation error. This won't be return for every
|
2782
|
+
# validation exception.
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ValidationException AWS API Documentation
|
2786
|
+
#
|
2787
|
+
class ValidationException < Struct.new(
|
2788
|
+
:message,
|
2789
|
+
:reason)
|
2790
|
+
SENSITIVE = []
|
2791
|
+
include Aws::Structure
|
2792
|
+
end
|
2793
|
+
|
2794
|
+
# Information describing the end of the validity period of the
|
2795
|
+
# certificate. This parameter sets the “Not After” date for the
|
2796
|
+
# certificate. Certificate validity is the period of time during which a
|
2797
|
+
# certificate is valid. Validity can be expressed as an explicit date
|
2798
|
+
# and time when the certificate expires, or as a span of time after
|
2799
|
+
# issuance, stated in hours, days, months, or years. For more
|
2800
|
+
# information, see Validity in RFC 5280. This value is unaffected when
|
2801
|
+
# ValidityNotBefore is also specified. For example, if Validity is set
|
2802
|
+
# to 20 days in the future, the certificate will expire 20 days from
|
2803
|
+
# issuance time regardless of the ValidityNotBefore value.
|
2804
|
+
#
|
2805
|
+
# @!attribute [rw] period
|
2806
|
+
# The numeric value for the validity period.
|
2807
|
+
# @return [Integer]
|
2808
|
+
#
|
2809
|
+
# @!attribute [rw] period_type
|
2810
|
+
# The unit of time. You can select hours, days, weeks, months, and
|
2811
|
+
# years.
|
2812
|
+
# @return [String]
|
2813
|
+
#
|
2814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/ValidityPeriod AWS API Documentation
|
2815
|
+
#
|
2816
|
+
class ValidityPeriod < Struct.new(
|
2817
|
+
:period,
|
2818
|
+
:period_type)
|
2819
|
+
SENSITIVE = []
|
2820
|
+
include Aws::Structure
|
2821
|
+
end
|
2822
|
+
|
2823
|
+
# Information about your VPC and security groups used with the
|
2824
|
+
# connector.
|
2825
|
+
#
|
2826
|
+
# @!attribute [rw] security_group_ids
|
2827
|
+
# The security groups used with the connector. You can use a maximum
|
2828
|
+
# of 4 security groups with a connector.
|
2829
|
+
# @return [Array<String>]
|
2830
|
+
#
|
2831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-ad-2018-05-10/VpcInformation AWS API Documentation
|
2832
|
+
#
|
2833
|
+
class VpcInformation < Struct.new(
|
2834
|
+
:security_group_ids)
|
2835
|
+
SENSITIVE = []
|
2836
|
+
include Aws::Structure
|
2837
|
+
end
|
2838
|
+
|
2839
|
+
end
|
2840
|
+
end
|