forked from aws/aws-sdk-go-v2
/
apprunner.2020-05-15.json
2960 lines (2960 loc) · 145 KB
/
apprunner.2020-05-15.json
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
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.apprunner#ASConfigMaxConcurrency": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 1,
"max": 200
}
}
},
"com.amazonaws.apprunner#ASConfigMaxSize": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 1,
"max": 25
}
}
},
"com.amazonaws.apprunner#ASConfigMinSize": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 1,
"max": 25
}
}
},
"com.amazonaws.apprunner#AppRunner": {
"type": "service",
"version": "2020-05-15",
"operations": [
{
"target": "com.amazonaws.apprunner#AssociateCustomDomain"
},
{
"target": "com.amazonaws.apprunner#CreateAutoScalingConfiguration"
},
{
"target": "com.amazonaws.apprunner#CreateConnection"
},
{
"target": "com.amazonaws.apprunner#CreateService"
},
{
"target": "com.amazonaws.apprunner#DeleteAutoScalingConfiguration"
},
{
"target": "com.amazonaws.apprunner#DeleteConnection"
},
{
"target": "com.amazonaws.apprunner#DeleteService"
},
{
"target": "com.amazonaws.apprunner#DescribeAutoScalingConfiguration"
},
{
"target": "com.amazonaws.apprunner#DescribeCustomDomains"
},
{
"target": "com.amazonaws.apprunner#DescribeService"
},
{
"target": "com.amazonaws.apprunner#DisassociateCustomDomain"
},
{
"target": "com.amazonaws.apprunner#ListAutoScalingConfigurations"
},
{
"target": "com.amazonaws.apprunner#ListConnections"
},
{
"target": "com.amazonaws.apprunner#ListOperations"
},
{
"target": "com.amazonaws.apprunner#ListServices"
},
{
"target": "com.amazonaws.apprunner#ListTagsForResource"
},
{
"target": "com.amazonaws.apprunner#PauseService"
},
{
"target": "com.amazonaws.apprunner#ResumeService"
},
{
"target": "com.amazonaws.apprunner#StartDeployment"
},
{
"target": "com.amazonaws.apprunner#TagResource"
},
{
"target": "com.amazonaws.apprunner#UntagResource"
},
{
"target": "com.amazonaws.apprunner#UpdateService"
}
],
"traits": {
"aws.api#service": {
"sdkId": "AppRunner",
"arnNamespace": "apprunner",
"cloudFormationName": "AppRunner",
"cloudTrailEventSource": "apprunner.amazonaws.com",
"endpointPrefix": "apprunner"
},
"aws.auth#sigv4": {
"name": "apprunner"
},
"aws.protocols#awsJson1_0": {},
"smithy.api#documentation": "<fullname>App Runner</fullname>\n\n \n\n <p>App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code\n to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to\n provision and configure Amazon Web Services resources.</p>\n <p>App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations,\n high performance, scalability, and security.</p>\n <p>For more information about App Runner, see the <a href=\"https://docs.aws.amazon.com/apprunner/latest/dg/\">App Runner Developer Guide</a>.\n For release information, see the <a href=\"https://docs.aws.amazon.com/apprunner/latest/relnotes/\">App Runner Release Notes</a>.</p>\n <p>\n To install the Software Development Kits (SDKs), Integrated\n Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see <a href=\"http://aws.amazon.com/tools/\">Tools for\n Amazon Web Services</a>.</p>\n <p>\n <b>Endpoints</b>\n </p>\n <p>For a list of Region-specific endpoints that App Runner supports, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/apprunner.html\">App Runner\n endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"smithy.api#title": "AWS App Runner",
"smithy.api#xmlNamespace": {
"uri": "http://apprunner.amazonaws.com/doc/2020-05-15/"
}
}
},
"com.amazonaws.apprunner#AppRunnerResourceArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1011
},
"smithy.api#pattern": "^arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}$"
}
},
"com.amazonaws.apprunner#AssociateCustomDomain": {
"type": "operation",
"input": {
"target": "com.amazonaws.apprunner#AssociateCustomDomainRequest"
},
"output": {
"target": "com.amazonaws.apprunner#AssociateCustomDomainResponse"
},
"errors": [
{
"target": "com.amazonaws.apprunner#InternalServiceErrorException"
},
{
"target": "com.amazonaws.apprunner#InvalidRequestException"
},
{
"target": "com.amazonaws.apprunner#InvalidStateException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associate your own domain name with the App Runner subdomain URL of your App Runner service.</p>\n <p>After you call <code>AssociateCustomDomain</code> and receive a successful response, use the information in the <a>CustomDomain</a> record\n that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or\n more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks\n domain validity in a certificate stored in <a href=\"https://docs.aws.amazon.com/acm/latest/userguide\">AWS Certificate Manager (ACM)</a>.</p>"
}
},
"com.amazonaws.apprunner#AssociateCustomDomainRequest": {
"type": "structure",
"members": {
"ServiceArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.</p>",
"smithy.api#required": {}
}
},
"DomainName": {
"target": "com.amazonaws.apprunner#DomainName",
"traits": {
"smithy.api#documentation": "<p>A custom domain endpoint to associate. Specify a root domain (for example, <code>example.com</code>), a subdomain (for example,\n <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</p>",
"smithy.api#required": {}
}
},
"EnableWWWSubdomain": {
"target": "com.amazonaws.apprunner#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>Set to <code>true</code> to associate the subdomain <code>www.<i>DomainName</i>\n </code> with the App Runner service in addition to the base\n domain.</p>\n <p>Default: <code>true</code>\n </p>"
}
}
}
},
"com.amazonaws.apprunner#AssociateCustomDomainResponse": {
"type": "structure",
"members": {
"DNSTarget": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.</p>",
"smithy.api#required": {}
}
},
"ServiceArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.</p>",
"smithy.api#required": {}
}
},
"CustomDomain": {
"target": "com.amazonaws.apprunner#CustomDomain",
"traits": {
"smithy.api#documentation": "<p>A description of the domain name that's being associated.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.apprunner#AuthenticationConfiguration": {
"type": "structure",
"members": {
"ConnectionArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code\n repositories.</p>"
}
},
"AccessRoleArn": {
"target": "com.amazonaws.apprunner#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories\n (but not for ECR Public repositories).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.</p>"
}
},
"com.amazonaws.apprunner#AutoScalingConfiguration": {
"type": "structure",
"members": {
"AutoScalingConfigurationArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of this auto scaling configuration.</p>"
}
},
"AutoScalingConfigurationName": {
"target": "com.amazonaws.apprunner#AutoScalingConfigurationName",
"traits": {
"smithy.api#documentation": "<p>The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.</p>"
}
},
"AutoScalingConfigurationRevision": {
"target": "com.amazonaws.apprunner#Integer",
"traits": {
"smithy.api#documentation": "<p>The revision of this auto scaling configuration. It's unique among all the active configurations (<code>\"Status\": \"ACTIVE\"</code>) that share the same\n <code>AutoScalingConfigurationName</code>.</p>"
}
},
"Latest": {
"target": "com.amazonaws.apprunner#Boolean",
"traits": {
"smithy.api#documentation": "<p>It's set to <code>true</code> for the configuration with the highest <code>Revision</code> among all configurations that share the same\n <code>Name</code>. It's set to <code>false</code> otherwise.</p>"
}
},
"Status": {
"target": "com.amazonaws.apprunner#AutoScalingConfigurationStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the auto scaling configuration. If the status of a configuration revision is <code>INACTIVE</code>, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.</p>"
}
},
"MaxConcurrency": {
"target": "com.amazonaws.apprunner#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service\n up.</p>"
}
},
"MinSize": {
"target": "com.amazonaws.apprunner#Integer",
"traits": {
"smithy.api#documentation": "<p>The minimum number of instances that App Runner provisions for a service. The service always has at least <code>MinSize</code> provisioned instances. Some\n of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be\n quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.</p>\n <p>App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.</p>"
}
},
"MaxSize": {
"target": "com.amazonaws.apprunner#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of instances that a service scales up to. At most <code>MaxSize</code> instances actively serve traffic for your service.</p>"
}
},
"CreatedAt": {
"target": "com.amazonaws.apprunner#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the auto scaling configuration was created. It's in Unix time stamp format.</p>"
}
},
"DeletedAt": {
"target": "com.amazonaws.apprunner#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the auto scaling configuration was deleted. It's in Unix time stamp format.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes an App Runner automatic scaling configuration resource. Multiple revisions of a configuration have the same\n <code>AutoScalingConfigurationName</code> and different <code>AutoScalingConfigurationRevision</code> values.</p>\n <p>A higher <code>MinSize</code> increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher\n minimal cost.</p>\n <p>A lower <code>MaxSize</code> controls your cost. The tradeoff is lower responsiveness during peak demand.</p>"
}
},
"com.amazonaws.apprunner#AutoScalingConfigurationName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 4,
"max": 32
},
"smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$"
}
},
"com.amazonaws.apprunner#AutoScalingConfigurationStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "INACTIVE",
"name": "INACTIVE"
}
]
}
},
"com.amazonaws.apprunner#AutoScalingConfigurationSummary": {
"type": "structure",
"members": {
"AutoScalingConfigurationArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of this auto scaling configuration.</p>"
}
},
"AutoScalingConfigurationName": {
"target": "com.amazonaws.apprunner#AutoScalingConfigurationName",
"traits": {
"smithy.api#documentation": "<p>The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.</p>"
}
},
"AutoScalingConfigurationRevision": {
"target": "com.amazonaws.apprunner#Integer",
"traits": {
"smithy.api#documentation": "<p>The revision of this auto scaling configuration. It's unique among all the active configurations (<code>\"Status\": \"ACTIVE\"</code>) with the same\n <code>AutoScalingConfigurationName</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides summary information about an App Runner automatic scaling configuration resource.</p>\n <p>This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration\n details. It's returned by the <a>ListAutoScalingConfigurations</a> action. Complete configuration information is returned by the <a>CreateAutoScalingConfiguration</a>, <a>DescribeAutoScalingConfiguration</a>, and <a>DeleteAutoScalingConfiguration</a>\n actions using the <a>AutoScalingConfiguration</a> type.</p>"
}
},
"com.amazonaws.apprunner#AutoScalingConfigurationSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.apprunner#AutoScalingConfigurationSummary"
}
},
"com.amazonaws.apprunner#Boolean": {
"type": "boolean"
},
"com.amazonaws.apprunner#BuildCommand": {
"type": "string",
"traits": {
"smithy.api#sensitive": {}
}
},
"com.amazonaws.apprunner#CertificateValidationRecord": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The certificate CNAME record name.</p>"
}
},
"Type": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The record type, always <code>CNAME</code>.</p>"
}
},
"Value": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The certificate CNAME record value.</p>"
}
},
"Status": {
"target": "com.amazonaws.apprunner#CertificateValidationRecordStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the certificate CNAME record validation. It should change to <code>SUCCESS</code> after App Runner completes validation with your\n DNS.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes a certificate CNAME record to add to your DNS. For more information, see <a href=\"https://docs.aws.amazon.com/apprunner/latest/api/API_AssociateCustomDomain.html\">AssociateCustomDomain</a>.</p>"
}
},
"com.amazonaws.apprunner#CertificateValidationRecordList": {
"type": "list",
"member": {
"target": "com.amazonaws.apprunner#CertificateValidationRecord"
}
},
"com.amazonaws.apprunner#CertificateValidationRecordStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PENDING_VALIDATION",
"name": "PENDING_VALIDATION"
},
{
"value": "SUCCESS",
"name": "SUCCESS"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.apprunner#CodeConfiguration": {
"type": "structure",
"members": {
"ConfigurationSource": {
"target": "com.amazonaws.apprunner#ConfigurationSource",
"traits": {
"smithy.api#documentation": "<p>The source of the App Runner configuration. Values are interpreted as follows:</p>\n <ul>\n <li>\n <p>\n <code>REPOSITORY</code> – App Runner reads configuration values from the <code>apprunner.yaml</code> file in the source code repository and\n ignores <code>CodeConfigurationValues</code>.</p>\n </li>\n <li>\n <p>\n <code>API</code> – App Runner uses configuration values provided in <code>CodeConfigurationValues</code> and ignores the\n <code>apprunner.yaml</code> file in the source code repository.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"CodeConfigurationValues": {
"target": "com.amazonaws.apprunner#CodeConfigurationValues",
"traits": {
"smithy.api#documentation": "<p>The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a\n <code>apprunner.yaml</code> file in the source code repository (or ignoring the file if it exists).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.</p>"
}
},
"com.amazonaws.apprunner#CodeConfigurationValues": {
"type": "structure",
"members": {
"Runtime": {
"target": "com.amazonaws.apprunner#Runtime",
"traits": {
"smithy.api#documentation": "<p>A runtime environment type for building and running an App Runner service.\n It represents a\n programming language runtime.</p>",
"smithy.api#required": {}
}
},
"BuildCommand": {
"target": "com.amazonaws.apprunner#BuildCommand",
"traits": {
"smithy.api#documentation": "<p>The command App Runner runs to build your application.</p>"
}
},
"StartCommand": {
"target": "com.amazonaws.apprunner#StartCommand",
"traits": {
"smithy.api#documentation": "<p>The command App Runner runs to start your application.</p>"
}
},
"Port": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The port that your application listens to in the container.</p>\n <p>Default: <code>8080</code>\n </p>"
}
},
"RuntimeEnvironmentVariables": {
"target": "com.amazonaws.apprunner#RuntimeEnvironmentVariables",
"traits": {
"smithy.api#documentation": "<p>The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of\n <code>AWSAPPRUNNER</code> are reserved for system use and aren't valid.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible\n configuration options. Fur full configuration capabilities, use a <code>apprunner.yaml</code> file in the source code repository.</p>"
}
},
"com.amazonaws.apprunner#CodeRepository": {
"type": "structure",
"members": {
"RepositoryUrl": {
"target": "com.amazonaws.apprunner#String",
"traits": {
"smithy.api#documentation": "<p>The location of the repository that contains the source code.</p>",
"smithy.api#required": {}
}
},
"SourceCodeVersion": {
"target": "com.amazonaws.apprunner#SourceCodeVersion",
"traits": {
"smithy.api#documentation": "<p>The version that should be used within the source code repository.</p>",
"smithy.api#required": {}
}
},
"CodeConfiguration": {
"target": "com.amazonaws.apprunner#CodeConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration for building and running the service from a source code repository.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes a source code repository.</p>"
}
},
"com.amazonaws.apprunner#ConfigurationSource": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "REPOSITORY",
"name": "REPOSITORY"
},
{
"value": "API",
"name": "API"
}
]
}
},
"com.amazonaws.apprunner#Connection": {
"type": "structure",
"members": {
"ConnectionName": {
"target": "com.amazonaws.apprunner#ConnectionName",
"traits": {
"smithy.api#documentation": "<p>The customer-provided connection name.</p>"
}
},
"ConnectionArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of this connection.</p>"
}
},
"ProviderType": {
"target": "com.amazonaws.apprunner#ProviderType",
"traits": {
"smithy.api#documentation": "<p>The source repository provider.</p>"
}
},
"Status": {
"target": "com.amazonaws.apprunner#ConnectionStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the App Runner connection. When the state is <code>AVAILABLE</code>, you can use the connection to create an App Runner service.</p>"
}
},
"CreatedAt": {
"target": "com.amazonaws.apprunner#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The App Runner connection creation time, expressed as a Unix time stamp.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes an App Runner connection resource.</p>"
}
},
"com.amazonaws.apprunner#ConnectionName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 4,
"max": 32
},
"smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$"
}
},
"com.amazonaws.apprunner#ConnectionStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PENDING_HANDSHAKE",
"name": "PENDING_HANDSHAKE"
},
{
"value": "AVAILABLE",
"name": "AVAILABLE"
},
{
"value": "ERROR",
"name": "ERROR"
},
{
"value": "DELETED",
"name": "DELETED"
}
]
}
},
"com.amazonaws.apprunner#ConnectionSummary": {
"type": "structure",
"members": {
"ConnectionName": {
"target": "com.amazonaws.apprunner#ConnectionName",
"traits": {
"smithy.api#documentation": "<p>The customer-provided connection name.</p>"
}
},
"ConnectionArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of this connection.</p>"
}
},
"ProviderType": {
"target": "com.amazonaws.apprunner#ProviderType",
"traits": {
"smithy.api#documentation": "<p>The source repository provider.</p>"
}
},
"Status": {
"target": "com.amazonaws.apprunner#ConnectionStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the App Runner connection. When the state is <code>AVAILABLE</code>, you can use the connection to create an App Runner service.</p>"
}
},
"CreatedAt": {
"target": "com.amazonaws.apprunner#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The App Runner connection creation time, expressed as a Unix time stamp.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides summary information about an App Runner connection resource.</p>"
}
},
"com.amazonaws.apprunner#ConnectionSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.apprunner#ConnectionSummary"
}
},
"com.amazonaws.apprunner#Cpu": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 4,
"max": 6
},
"smithy.api#pattern": "^1024|2048|(1|2) vCPU$"
}
},
"com.amazonaws.apprunner#CreateAutoScalingConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest"
},
"output": {
"target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.apprunner#InternalServiceErrorException"
},
{
"target": "com.amazonaws.apprunner#InvalidRequestException"
},
{
"target": "com.amazonaws.apprunner#ServiceQuotaExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create an App Runner automatic scaling configuration resource. App Runner requires this resource\n when you create App Runner services that require non-default auto scaling settings. You can share an\n auto scaling configuration across multiple services.</p>\n <p>Create multiple revisions of a configuration by using the same <code>AutoScalingConfigurationName</code> and different\n <code>AutoScalingConfigurationRevision</code> values. When you create a service, you can set it to use the latest active revision of an auto scaling\n configuration or a specific revision.</p>\n <p>Configure a higher <code>MinSize</code> to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is\n a higher minimal cost.</p>\n <p>Configure a lower <code>MaxSize</code> to control your cost. The tradeoff is lower responsiveness during peak demand.</p>"
}
},
"com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest": {
"type": "structure",
"members": {
"AutoScalingConfigurationName": {
"target": "com.amazonaws.apprunner#AutoScalingConfigurationName",
"traits": {
"smithy.api#documentation": "<p>A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number <code>1</code> of this\n name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.</p>",
"smithy.api#required": {}
}
},
"MaxConcurrency": {
"target": "com.amazonaws.apprunner#ASConfigMaxConcurrency",
"traits": {
"smithy.api#documentation": "<p>The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales\n up your service.</p>\n <p>Default: <code>100</code>\n </p>"
}
},
"MinSize": {
"target": "com.amazonaws.apprunner#ASConfigMinSize",
"traits": {
"smithy.api#documentation": "<p>The minimum number of instances that App Runner provisions for your service. The service always has at least <code>MinSize</code> provisioned instances.\n Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to\n be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.</p>\n <p>App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.</p>\n <p>Default: <code>1</code>\n </p>"
}
},
"MaxSize": {
"target": "com.amazonaws.apprunner#ASConfigMaxSize",
"traits": {
"smithy.api#documentation": "<p>The maximum number of instances that your service scales up to. At most <code>MaxSize</code> instances actively serve traffic for your service.</p>\n <p>Default: <code>25</code>\n </p>"
}
},
"Tags": {
"target": "com.amazonaws.apprunner#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.</p>"
}
}
}
},
"com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse": {
"type": "structure",
"members": {
"AutoScalingConfiguration": {
"target": "com.amazonaws.apprunner#AutoScalingConfiguration",
"traits": {
"smithy.api#documentation": "<p>A description of the App Runner auto scaling configuration that's created by this request.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.apprunner#CreateConnection": {
"type": "operation",
"input": {
"target": "com.amazonaws.apprunner#CreateConnectionRequest"
},
"output": {
"target": "com.amazonaws.apprunner#CreateConnectionResponse"
},
"errors": [
{
"target": "com.amazonaws.apprunner#InternalServiceErrorException"
},
{
"target": "com.amazonaws.apprunner#InvalidRequestException"
},
{
"target": "com.amazonaws.apprunner#ServiceQuotaExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from\n certain third-party providers. You can share a connection across multiple services.</p>\n <p>A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you\n can use the connection.</p>"
}
},
"com.amazonaws.apprunner#CreateConnectionRequest": {
"type": "structure",
"members": {
"ConnectionName": {
"target": "com.amazonaws.apprunner#ConnectionName",
"traits": {
"smithy.api#documentation": "<p>A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.</p>",
"smithy.api#required": {}
}
},
"ProviderType": {
"target": "com.amazonaws.apprunner#ProviderType",
"traits": {
"smithy.api#documentation": "<p>The source repository provider.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.apprunner#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.</p>"
}
}
}
},
"com.amazonaws.apprunner#CreateConnectionResponse": {
"type": "structure",
"members": {
"Connection": {
"target": "com.amazonaws.apprunner#Connection",
"traits": {
"smithy.api#documentation": "<p>A description of the App Runner connection that's created by this request.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.apprunner#CreateService": {
"type": "operation",
"input": {
"target": "com.amazonaws.apprunner#CreateServiceRequest"
},
"output": {
"target": "com.amazonaws.apprunner#CreateServiceResponse"
},
"errors": [
{
"target": "com.amazonaws.apprunner#InternalServiceErrorException"
},
{
"target": "com.amazonaws.apprunner#InvalidRequestException"
},
{
"target": "com.amazonaws.apprunner#ServiceQuotaExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create an App Runner service. After the service is created, the action also automatically starts a deployment.</p>\n <p>This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a href=\"https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html\">ListOperations</a> call to track the operation's progress.</p>"
}
},
"com.amazonaws.apprunner#CreateServiceRequest": {
"type": "structure",
"members": {
"ServiceName": {
"target": "com.amazonaws.apprunner#ServiceName",
"traits": {
"smithy.api#documentation": "<p>A name for the new service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.</p>",
"smithy.api#required": {}
}
},
"SourceConfiguration": {
"target": "com.amazonaws.apprunner#SourceConfiguration",
"traits": {
"smithy.api#documentation": "<p>The source to deploy to the App Runner service. It can be a code or an image repository.</p>",
"smithy.api#required": {}
}
},
"InstanceConfiguration": {
"target": "com.amazonaws.apprunner#InstanceConfiguration",
"traits": {
"smithy.api#documentation": "<p>The runtime configuration of instances (scaling units) of the App Runner service.</p>"
}
},
"Tags": {
"target": "com.amazonaws.apprunner#TagList",
"traits": {
"smithy.api#documentation": "<p>An optional list of metadata items that you can associate with your service resource. A tag is a key-value pair.</p>"
}
},
"EncryptionConfiguration": {
"target": "com.amazonaws.apprunner#EncryptionConfiguration",
"traits": {
"smithy.api#documentation": "<p>An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default,\n App Runner uses an Amazon Web Services managed CMK.</p>"
}
},
"HealthCheckConfiguration": {
"target": "com.amazonaws.apprunner#HealthCheckConfiguration",
"traits": {
"smithy.api#documentation": "<p>The settings for the health check that App Runner performs to monitor the health of your service.</p>"
}
},
"AutoScalingConfigurationArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner\n associates the latest revision of a default auto scaling configuration.</p>"
}
}
}
},
"com.amazonaws.apprunner#CreateServiceResponse": {
"type": "structure",
"members": {
"Service": {
"target": "com.amazonaws.apprunner#Service",
"traits": {
"smithy.api#documentation": "<p>A description of the App Runner service that's created by this request.</p>",
"smithy.api#required": {}
}
},
"OperationId": {
"target": "com.amazonaws.apprunner#UUID",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a href=\"https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html\">ListOperations</a> call to track the operation's progress.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.apprunner#CustomDomain": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.apprunner#DomainName",
"traits": {
"smithy.api#documentation": "<p>An associated custom domain endpoint. It can be a root domain (for example, <code>example.com</code>), a subdomain (for example,\n <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</p>",
"smithy.api#required": {}
}
},
"EnableWWWSubdomain": {
"target": "com.amazonaws.apprunner#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, the subdomain <code>www.<i>DomainName</i>\n </code> is associated with the App Runner service in addition to the base\n domain.</p>",
"smithy.api#required": {}
}
},
"CertificateValidationRecords": {
"target": "com.amazonaws.apprunner#CertificateValidationRecordList",
"traits": {
"smithy.api#documentation": "<p>A list of certificate CNAME records that's used for this domain name.</p>"
}
},
"Status": {
"target": "com.amazonaws.apprunner#CustomDomainAssociationStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the domain name association.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes a custom domain that's associated with an App Runner service.</p>"
}
},
"com.amazonaws.apprunner#CustomDomainAssociationStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CREATING",
"name": "CREATING"
},
{
"value": "CREATE_FAILED",
"name": "CREATE_FAILED"
},
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "DELETING",
"name": "DELETING"
},
{
"value": "DELETE_FAILED",
"name": "DELETE_FAILED"
},
{
"value": "PENDING_CERTIFICATE_DNS_VALIDATION",
"name": "PENDING_CERTIFICATE_DNS_VALIDATION"
},
{
"value": "BINDING_CERTIFICATE",
"name": "BINDING_CERTIFICATE"
}
]
}
},
"com.amazonaws.apprunner#CustomDomainList": {
"type": "list",
"member": {
"target": "com.amazonaws.apprunner#CustomDomain"
}
},
"com.amazonaws.apprunner#DeleteAutoScalingConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest"
},
"output": {
"target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.apprunner#InternalServiceErrorException"
},
{
"target": "com.amazonaws.apprunner#InvalidRequestException"
},
{
"target": "com.amazonaws.apprunner#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.</p>"
}
},
"com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest": {
"type": "structure",
"members": {
"AutoScalingConfigurationArn": {
"target": "com.amazonaws.apprunner#AppRunnerResourceArn",