-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathacmpca.yaml
More file actions
1936 lines (1936 loc) · 73.2 KB
/
acmpca.yaml
File metadata and controls
1936 lines (1936 loc) · 73.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: ACMPCA
version: 2.0.0
x-serviceName: cloudcontrolapi
servers:
- url: https://cloudcontrolapi.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CloudControlApi multi-region endpoint
- url: https://cloudcontrolapi.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia)
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
x-cloud-control-schemas:
AlreadyExistsException: {}
CancelResourceRequestInput:
properties:
RequestToken:
$ref: '#/components/x-cloud-control-schemas/RequestToken'
required:
- RequestToken
title: CancelResourceRequestInput
type: object
CancelResourceRequestOutput:
properties:
ProgressEvent:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: object
ClientToken:
maxLength: 128
minLength: 1
pattern: '[-A-Za-z0-9+/=]+'
type: string
ClientTokenConflictException: {}
ConcurrentModificationException: {}
ConcurrentOperationException: {}
CreateResourceInput:
properties:
ClientToken:
type: string
DesiredState:
allOf:
- $ref: '#/components/x-cloud-control-schemas/Properties'
- description: >-
<p>Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.</p> <note> <p>Cloud Control API currently supports JSON as a structured data format.</p> </note> <pre><code> <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
</li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
<a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p> </code></pre>
RoleArn:
type: string
TypeName:
type: string
TypeVersionId:
type: string
required:
- DesiredState
title: CreateResourceInput
type: object
CreateResourceOutput:
properties:
ProgressEvent:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: object
DeleteResourceInput:
properties:
ClientToken:
type: string
Identifier:
$ref: '#/components/x-cloud-control-schemas/Identifier'
RoleArn:
type: string
TypeName:
type: string
TypeVersionId:
type: string
required:
- Identifier
title: DeleteResourceInput
type: object
DeleteResourceOutput:
properties:
ProgressEvent:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: object
GeneralServiceException: {}
GetResourceInput:
properties:
TypeName:
$ref: '#/components/x-cloud-control-schemas/TypeName'
Identifier:
$ref: '#/components/x-cloud-control-schemas/Identifier'
TypeVersionId:
$ref: '#/components/x-cloud-control-schemas/TypeVersionId'
RoleArn:
$ref: '#/components/x-cloud-control-schemas/RoleArn'
required:
- TypeName
- Identifier
title: GetResourceInput
type: object
GetResourceOutput:
properties:
ResourceDescription:
$ref: '#/components/x-cloud-control-schemas/ResourceDescription'
TypeName:
type: string
type: object
GetResourceRequestStatusInput:
properties:
RequestToken:
$ref: '#/components/x-cloud-control-schemas/RequestToken'
required:
- RequestToken
title: GetResourceRequestStatusInput
type: object
GetResourceRequestStatusOutput:
properties:
ProgressEvent:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: object
HandlerErrorCode:
enum:
- NotUpdatable
- InvalidRequest
- AccessDenied
- InvalidCredentials
- AlreadyExists
- NotFound
- ResourceConflict
- Throttling
- ServiceLimitExceeded
- NotStabilized
- GeneralServiceException
- ServiceInternalError
- ServiceTimeout
- NetworkFailure
- InternalFailure
type: string
HandlerFailureException: {}
HandlerInternalFailureException: {}
HandlerNextToken:
maxLength: 2048
minLength: 1
pattern: .+
type: string
Identifier:
maxLength: 1024
minLength: 1
pattern: .+
type: string
InvalidCredentialsException: {}
InvalidRequestException: {}
MaxResults:
maximum: 100
minimum: 1
type: integer
NetworkFailureException: {}
NextToken:
maxLength: 2048
minLength: 1
pattern: '[-A-Za-z0-9+/=]+'
type: string
NotStabilizedException: {}
NotUpdatableException: {}
Operation:
enum:
- CREATE
- DELETE
- UPDATE
type: string
OperationStatus:
enum:
- PENDING
- IN_PROGRESS
- SUCCESS
- FAILED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETE
type: string
OperationStatuses:
items:
$ref: '#/components/x-cloud-control-schemas/OperationStatus'
type: array
Operations:
items:
$ref: '#/components/x-cloud-control-schemas/Operation'
type: array
PatchDocument:
format: password
maxLength: 65536
minLength: 1
pattern: '[\s\S]*'
type: string
PrivateTypeException: {}
ProgressEvent:
example:
ErrorCode: string
EventTime: number
Identifier: string
Operation: string
OperationStatus: string
RequestToken: string
ResourceModel: string
RetryAfter: number
StatusMessage: string
TypeName: string
properties:
ErrorCode:
type: string
EventTime:
type: number
Identifier:
type: string
Operation:
type: string
OperationStatus:
type: string
RequestToken:
type: string
ResourceModel:
type: string
RetryAfter:
type: number
StatusMessage:
type: string
TypeName:
type: string
type: object
Properties:
format: password
maxLength: 65536
minLength: 1
pattern: '[\s\S]*'
type: string
RequestToken:
maxLength: 128
minLength: 1
pattern: '[-A-Za-z0-9+/=]+'
type: string
RequestTokenNotFoundException: {}
ResourceConflictException: {}
ResourceDescription:
description: Represents information about a provisioned resource.
properties:
Identifier:
type: string
Properties:
type: string
type: object
ResourceDescriptions:
items:
$ref: '#/components/x-cloud-control-schemas/ResourceDescription'
type: array
ResourceNotFoundException: {}
ResourceRequestStatusFilter:
description: The filter criteria to use in determining the requests returned.
properties:
undefined:
allOf:
- $ref: '#/components/x-cloud-control-schemas/OperationStatuses'
- description: >-
<p>The operation statuses to include in the filter.</p> <ul> <li> <p> <code>PENDING</code>: The operation has been requested, but not yet initiated.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The operation is in progress.</p> </li> <li> <p> <code>SUCCESS</code>: The operation completed.</p> </li> <li> <p> <code>FAILED</code>: The operation failed.</p> </li> <li> <p> <code>CANCEL_IN_PROGRESS</code>: The operation is in the process of being canceled.</p> </li> <li> <p>
<code>CANCEL_COMPLETE</code>: The operation has been canceled.</p> </li> </ul>
type: object
ResourceRequestStatusSummaries:
items:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: array
RoleArn:
maxLength: 2048
minLength: 20
pattern: arn:.+:iam::[0-9]{12}:role/.+
type: string
ServiceInternalErrorException: {}
ServiceLimitExceededException: {}
StatusMessage:
maxLength: 1024
minLength: 0
pattern: '[\s\S]*'
type: string
ThrottlingException: {}
Timestamp:
format: date-time
type: string
TypeName:
maxLength: 196
minLength: 10
pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}'
type: string
TypeNotFoundException: {}
TypeVersionId:
maxLength: 128
minLength: 1
pattern: '[A-Za-z0-9-]+'
type: string
UnsupportedActionException: {}
UpdateResourceInput:
properties:
undefined:
allOf:
- $ref: '#/components/x-cloud-control-schemas/PatchDocument'
required:
- Identifier
- PatchDocument
title: UpdateResourceInput
type: object
UpdateResourceOutput:
properties:
ProgressEvent:
$ref: '#/components/x-cloud-control-schemas/ProgressEvent'
type: object
schemas:
ApiPassthrough:
description: |-
Contains X.509 certificate information to be placed in an issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.
type: object
additionalProperties: false
properties:
Extensions:
$ref: '#/components/schemas/Extensions'
description: Specifies X.509 extension information for a certificate.
Subject:
$ref: '#/components/schemas/Subject'
description: Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.
Arn:
type: string
CertificatePolicyList:
type: array
items:
$ref: '#/components/schemas/PolicyInformation'
ExtendedKeyUsage:
description: Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.
type: object
additionalProperties: false
properties:
ExtendedKeyUsageType:
type: string
description: Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).
ExtendedKeyUsageObjectIdentifier:
$ref: '#/components/schemas/CustomObjectIdentifier'
description: Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID).
ExtendedKeyUsageList:
type: array
items:
$ref: '#/components/schemas/ExtendedKeyUsage'
Extensions:
description: Contains X.509 extension information for a certificate.
type: object
additionalProperties: false
properties:
CertificatePolicies:
$ref: '#/components/schemas/CertificatePolicyList'
description: |-
Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
ExtendedKeyUsage:
$ref: '#/components/schemas/ExtendedKeyUsageList'
description: Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.
KeyUsage:
$ref: '#/components/schemas/KeyUsage'
description: Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
SubjectAlternativeNames:
$ref: '#/components/schemas/GeneralNameList'
description: The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.
CustomExtensions:
$ref: '#/components/schemas/CustomExtensionList'
description: Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)
CustomExtensionList:
description: Array of X.509 extensions for a certificate.
type: array
items:
$ref: '#/components/schemas/CustomExtension'
CustomExtension:
description: |-
Specifies the X.509 extension information for a certificate.
Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough``[template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).
type: object
additionalProperties: false
properties:
Critical:
type: boolean
description: Specifies the critical flag of the X.509 extension.
ObjectIdentifier:
$ref: '#/components/schemas/CustomObjectIdentifier'
description: Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)
Value:
type: string
description: Specifies the base64-encoded value of the X.509 extension.
required:
- ObjectIdentifier
- Value
GeneralNameList:
type: array
items:
$ref: '#/components/schemas/GeneralName'
GeneralName:
description: Structure that contains X.509 GeneralName information. Assign one and ONLY one field.
type: object
additionalProperties: false
properties:
OtherName:
$ref: '#/components/schemas/OtherName'
Rfc822Name:
$ref: '#/components/schemas/Rfc822Name'
DnsName:
$ref: '#/components/schemas/DnsName'
DirectoryName:
$ref: '#/components/schemas/Subject'
EdiPartyName:
$ref: '#/components/schemas/EdiPartyName'
UniformResourceIdentifier:
$ref: '#/components/schemas/UniformResourceIdentifier'
IpAddress:
$ref: '#/components/schemas/IpAddress'
RegisteredId:
$ref: '#/components/schemas/CustomObjectIdentifier'
KeyUsage:
description: Structure that contains X.509 KeyUsage information.
type: object
additionalProperties: false
properties:
DigitalSignature:
type: boolean
default: false
NonRepudiation:
type: boolean
default: false
KeyEncipherment:
type: boolean
default: false
DataEncipherment:
type: boolean
default: false
KeyAgreement:
type: boolean
default: false
KeyCertSign:
type: boolean
default: false
CRLSign:
type: boolean
default: false
EncipherOnly:
type: boolean
default: false
DecipherOnly:
type: boolean
default: false
PolicyInformation:
description: Defines the X.509 ``CertificatePolicies`` extension.
type: object
additionalProperties: false
properties:
CertPolicyId:
$ref: '#/components/schemas/CustomObjectIdentifier'
description: Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
PolicyQualifiers:
$ref: '#/components/schemas/PolicyQualifierInfoList'
description: Modifies the given ``CertPolicyId`` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.
required:
- CertPolicyId
PolicyQualifierInfo:
description: Modifies the ``CertPolicyId`` of a ``PolicyInformation`` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.
type: object
additionalProperties: false
properties:
PolicyQualifierId:
type: string
description: Identifies the qualifier modifying a ``CertPolicyId``.
Qualifier:
$ref: '#/components/schemas/Qualifier'
description: Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field.
required:
- PolicyQualifierId
- Qualifier
PolicyQualifierInfoList:
type: array
items:
$ref: '#/components/schemas/PolicyQualifierInfo'
Qualifier:
description: Defines a ``PolicyInformation`` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.
type: object
additionalProperties: false
properties:
CpsUri:
type: string
description: Contains a pointer to a certification practice statement (CPS) published by the CA.
required:
- CpsUri
Subject:
description: Structure that contains X.500 distinguished name information for your CA.
type: object
additionalProperties: false
properties:
Country:
type: string
Organization:
type: string
OrganizationalUnit:
type: string
DistinguishedNameQualifier:
type: string
State:
type: string
CommonName:
type: string
SerialNumber:
type: string
Locality:
type: string
Title:
type: string
Surname:
type: string
GivenName:
type: string
Initials:
type: string
Pseudonym:
type: string
GenerationQualifier:
type: string
CustomAttributes:
$ref: '#/components/schemas/CustomAttributeList'
CustomAttributeList:
description: Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.
type: array
items:
$ref: '#/components/schemas/CustomAttribute'
CustomAttribute:
description: Structure that contains X.500 attribute type and value.
type: object
additionalProperties: false
properties:
ObjectIdentifier:
$ref: '#/components/schemas/CustomObjectIdentifier'
Value:
type: string
required:
- ObjectIdentifier
- Value
Validity:
description: Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the ``IssueCertificate`` operation.
type: object
additionalProperties: false
properties:
Value:
type: number
description: A long integer interpreted according to the value of ``Type``, below.
Type:
type: string
description: Specifies whether the ``Value`` parameter represents days, months, or years.
required:
- Value
- Type
CustomObjectIdentifier:
description: String that contains X.509 ObjectIdentifier information.
type: string
OtherName:
description: Structure that contains X.509 OtherName information.
type: object
additionalProperties: false
properties:
TypeId:
$ref: '#/components/schemas/CustomObjectIdentifier'
Value:
type: string
required:
- TypeId
- Value
Rfc822Name:
description: String that contains X.509 Rfc822Name information.
type: string
DnsName:
description: String that contains X.509 DnsName information.
type: string
EdiPartyName:
description: Structure that contains X.509 EdiPartyName information.
type: object
additionalProperties: false
properties:
PartyName:
type: string
NameAssigner:
type: string
required:
- PartyName
UniformResourceIdentifier:
description: String that contains X.509 UniformResourceIdentifier information.
type: string
IpAddress:
description: String that contains X.509 IpAddress information.
type: string
Certificate:
type: object
properties:
ApiPassthrough:
description: Specifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored.
$ref: '#/components/schemas/ApiPassthrough'
CertificateAuthorityArn:
description: The Amazon Resource Name (ARN) for the private CA issues the certificate.
$ref: '#/components/schemas/Arn'
CertificateSigningRequest:
description: The certificate signing request (CSR) for the certificate.
type: string
minLength: 1
SigningAlgorithm:
description: |-
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
type: string
TemplateArn:
description: Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).
$ref: '#/components/schemas/Arn'
Validity:
description: The period of time during which the certificate will be valid.
$ref: '#/components/schemas/Validity'
ValidityNotBefore:
description: |-
Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value.
Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.
The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.
$ref: '#/components/schemas/Validity'
Certificate:
description: ''
type: string
Arn:
description: ''
$ref: '#/components/schemas/Arn'
required:
- CertificateAuthorityArn
- CertificateSigningRequest
- SigningAlgorithm
- Validity
x-stackql-resource-name: certificate
description: The ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.
x-type-name: AWS::ACMPCA::Certificate
x-stackql-primary-identifier:
- Arn
- CertificateAuthorityArn
x-create-only-properties:
- ApiPassthrough
- CertificateAuthorityArn
- CertificateSigningRequest
- SigningAlgorithm
- TemplateArn
- Validity
- ValidityNotBefore
x-write-only-properties:
- ApiPassthrough
- CertificateSigningRequest
- SigningAlgorithm
- TemplateArn
- Validity
- ValidityNotBefore
x-read-only-properties:
- Arn
- Certificate
x-required-properties:
- CertificateAuthorityArn
- CertificateSigningRequest
- SigningAlgorithm
- Validity
x-tagging:
taggable: false
tagOnCreate: false
tagUpdatable: false
cloudFormationSystemTags: false
x-required-permissions:
create:
- acm-pca:IssueCertificate
- acm-pca:GetCertificate
read:
- acm-pca:GetCertificate
delete:
- acm-pca:GetCertificate
Tag:
type: object
additionalProperties: false
properties:
Key:
type: string
Value:
type: string
required:
- Key
CrlDistributionPointExtensionConfiguration:
description: Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority
type: object
additionalProperties: false
properties:
OmitExtension:
type: boolean
required:
- OmitExtension
CrlConfiguration:
description: Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.
type: object
additionalProperties: false
properties:
Enabled:
type: boolean
ExpirationInDays:
type: integer
CustomCname:
type: string
S3BucketName:
type: string
S3ObjectAcl:
type: string
CrlDistributionPointExtensionConfiguration:
$ref: '#/components/schemas/CrlDistributionPointExtensionConfiguration'
CrlType:
type: string
CustomPath:
type: string
required:
- Enabled
OcspConfiguration:
description: Helps to configure online certificate status protocol (OCSP) responder for your certificate authority
type: object
additionalProperties: false
properties:
Enabled:
type: boolean
OcspCustomCname:
type: string
required:
- Enabled
RevocationConfiguration:
description: Certificate Authority revocation information.
type: object
additionalProperties: false
properties:
CrlConfiguration:
$ref: '#/components/schemas/CrlConfiguration'
OcspConfiguration:
$ref: '#/components/schemas/OcspConfiguration'
AccessMethodType:
description: Pre-defined enum string for X.509 AccessMethod ObjectIdentifiers.
type: string
AccessMethod:
description: Structure that contains X.509 AccessMethod information. Assign one and ONLY one field.
type: object
additionalProperties: false
properties:
CustomObjectIdentifier:
$ref: '#/components/schemas/CustomObjectIdentifier'
AccessMethodType:
$ref: '#/components/schemas/AccessMethodType'
AccessDescription:
description: Structure that contains X.509 AccessDescription information.
type: object
additionalProperties: false
properties:
AccessMethod:
$ref: '#/components/schemas/AccessMethod'
AccessLocation:
$ref: '#/components/schemas/GeneralName'
required:
- AccessMethod
- AccessLocation
SubjectInformationAccess:
description: Array of X.509 AccessDescription.
type: array
items:
$ref: '#/components/schemas/AccessDescription'
CsrExtensions:
description: Structure that contains CSR pass though extensions information.
type: object
additionalProperties: false
properties:
KeyUsage:
$ref: '#/components/schemas/KeyUsage'
SubjectInformationAccess:
$ref: '#/components/schemas/SubjectInformationAccess'
CertificateAuthority:
type: object
properties:
Arn:
description: The Amazon Resource Name (ARN) of the certificate authority.
$ref: '#/components/schemas/Arn'
Type:
description: The type of the certificate authority.
type: string
KeyAlgorithm:
description: Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
type: string
SigningAlgorithm:
description: Algorithm your CA uses to sign certificate requests.
type: string
Subject:
description: Structure that contains X.500 distinguished name information for your CA.
$ref: '#/components/schemas/Subject'
RevocationConfiguration:
description: Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
$ref: '#/components/schemas/RevocationConfiguration'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
CertificateSigningRequest:
description: The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
type: string
CsrExtensions:
description: Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
$ref: '#/components/schemas/CsrExtensions'
KeyStorageSecurityStandard:
description: KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
type: string
UsageMode:
description: Usage mode of the ceritificate authority.
type: string
required:
- Type
- KeyAlgorithm
- SigningAlgorithm
- Subject
x-stackql-resource-name: certificate_authority
description: Private certificate authority.
x-type-name: AWS::ACMPCA::CertificateAuthority
x-stackql-primary-identifier:
- Arn
x-create-only-properties:
- Type
- KeyAlgorithm
- SigningAlgorithm
- Subject
- CsrExtensions
- KeyStorageSecurityStandard
- UsageMode
x-write-only-properties:
- Subject
- CsrExtensions
- RevocationConfiguration
- KeyStorageSecurityStandard
x-read-only-properties:
- Arn
- CertificateSigningRequest
x-required-properties:
- Type
- KeyAlgorithm
- SigningAlgorithm
- Subject
x-tagging:
taggable: true
tagOnCreate: true
tagUpdatable: true
cloudFormationSystemTags: false
tagProperty: /properties/Tags
permissions:
- acm-pca:TagCertificateAuthority
- acm-pca:UntagCertificateAuthority
x-required-permissions:
create:
- acm-pca:CreateCertificateAuthority
- acm-pca:DescribeCertificateAuthority
- acm-pca:GetCertificateAuthorityCsr
- acm-pca:TagCertificateAuthority
read:
- acm-pca:DescribeCertificateAuthority
- acm-pca:GetCertificateAuthorityCsr
- acm-pca:ListTags
update:
- acm-pca:TagCertificateAuthority
- acm-pca:UntagCertificateAuthority
- acm-pca:UpdateCertificateAuthority
delete:
- acm-pca:DeleteCertificateAuthority
- acm-pca:DescribeCertificateAuthority
list:
- acm-pca:DescribeCertificateAuthority
- acm-pca:GetCertificateAuthorityCsr
- acm-pca:ListCertificateAuthorities
- acm-pca:ListTags
CertificateAuthorityActivation:
type: object
properties:
CertificateAuthorityArn:
description: Arn of the Certificate Authority.
type: string
Certificate:
description: Certificate Authority certificate that will be installed in the Certificate Authority.
type: string
CertificateChain:
description: Certificate chain for the Certificate Authority certificate.
type: string
Status:
description: The status of the Certificate Authority.
type: string
CompleteCertificateChain:
description: The complete certificate chain, including the Certificate Authority certificate.
type: string
required:
- CertificateAuthorityArn
- Certificate
x-stackql-resource-name: certificate_authority_activation
description: Used to install the certificate authority certificate and update the certificate authority status.
x-type-name: AWS::ACMPCA::CertificateAuthorityActivation
x-stackql-primary-identifier:
- CertificateAuthorityArn
x-create-only-properties:
- CertificateAuthorityArn
x-write-only-properties:
- Certificate
- CertificateChain
x-read-only-properties:
- CompleteCertificateChain
x-required-properties:
- CertificateAuthorityArn
- Certificate
x-tagging:
taggable: false
tagOnCreate: false
tagUpdatable: false
cloudFormationSystemTags: false
x-required-permissions:
create:
- acm-pca:ImportCertificateAuthorityCertificate
- acm-pca:UpdateCertificateAuthority
read:
- acm-pca:GetCertificateAuthorityCertificate