@aws-sdk/client-apprunner 3.378.0 → 3.382.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.
@@ -5,15 +5,18 @@ import { AppRunnerServiceException as __BaseException } from "./AppRunnerService
5
5
  */
6
6
  export interface AssociateCustomDomainRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.</p>
9
10
  */
10
11
  ServiceArn: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>A custom domain endpoint to associate. Specify a root domain (for example, <code>example.com</code>), a subdomain (for example,
13
15
  * <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</p>
14
16
  */
15
17
  DomainName: string | undefined;
16
18
  /**
19
+ * @public
17
20
  * <p>Set to <code>true</code> to associate the subdomain <code>www.<i>DomainName</i>
18
21
  * </code> with the App Runner service in addition to the base
19
22
  * domain.</p>
@@ -41,18 +44,22 @@ export type CertificateValidationRecordStatus = (typeof CertificateValidationRec
41
44
  */
42
45
  export interface CertificateValidationRecord {
43
46
  /**
47
+ * @public
44
48
  * <p>The certificate CNAME record name.</p>
45
49
  */
46
50
  Name?: string;
47
51
  /**
52
+ * @public
48
53
  * <p>The record type, always <code>CNAME</code>.</p>
49
54
  */
50
55
  Type?: string;
51
56
  /**
57
+ * @public
52
58
  * <p>The certificate CNAME record value.</p>
53
59
  */
54
60
  Value?: string;
55
61
  /**
62
+ * @public
56
63
  * <p>The current state of the certificate CNAME record validation. It should change to <code>SUCCESS</code> after App Runner completes validation with your
57
64
  * DNS.</p>
58
65
  */
@@ -81,21 +88,25 @@ export type CustomDomainAssociationStatus = (typeof CustomDomainAssociationStatu
81
88
  */
82
89
  export interface CustomDomain {
83
90
  /**
91
+ * @public
84
92
  * <p>An associated custom domain endpoint. It can be a root domain (for example, <code>example.com</code>), a subdomain (for example,
85
93
  * <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</p>
86
94
  */
87
95
  DomainName: string | undefined;
88
96
  /**
97
+ * @public
89
98
  * <p>When <code>true</code>, the subdomain <code>www.<i>DomainName</i>
90
99
  * </code> is associated with the App Runner service in addition to the base
91
100
  * domain.</p>
92
101
  */
93
102
  EnableWWWSubdomain: boolean | undefined;
94
103
  /**
104
+ * @public
95
105
  * <p>A list of certificate CNAME records that's used for this domain name.</p>
96
106
  */
97
107
  CertificateValidationRecords?: CertificateValidationRecord[];
98
108
  /**
109
+ * @public
99
110
  * <p>The current state of the domain name association.</p>
100
111
  */
101
112
  Status: CustomDomainAssociationStatus | string | undefined;
@@ -106,14 +117,17 @@ export interface CustomDomain {
106
117
  */
107
118
  export interface VpcDNSTarget {
108
119
  /**
120
+ * @public
109
121
  * <p>The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.</p>
110
122
  */
111
123
  VpcIngressConnectionArn?: string;
112
124
  /**
125
+ * @public
113
126
  * <p>The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.</p>
114
127
  */
115
128
  VpcId?: string;
116
129
  /**
130
+ * @public
117
131
  * <p>The domain name of your target DNS that is associated with the Amazon VPC.</p>
118
132
  */
119
133
  DomainName?: string;
@@ -123,18 +137,22 @@ export interface VpcDNSTarget {
123
137
  */
124
138
  export interface AssociateCustomDomainResponse {
125
139
  /**
140
+ * @public
126
141
  * <p>The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.</p>
127
142
  */
128
143
  DNSTarget: string | undefined;
129
144
  /**
145
+ * @public
130
146
  * <p>The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.</p>
131
147
  */
132
148
  ServiceArn: string | undefined;
133
149
  /**
150
+ * @public
134
151
  * <p>A description of the domain name that's being associated.</p>
135
152
  */
136
153
  CustomDomain: CustomDomain | undefined;
137
154
  /**
155
+ * @public
138
156
  * <p>DNS Target records for the custom domains of this Amazon VPC.
139
157
  * </p>
140
158
  */
@@ -185,10 +203,12 @@ export declare class InvalidStateException extends __BaseException {
185
203
  */
186
204
  export interface Tag {
187
205
  /**
206
+ * @public
188
207
  * <p>The key of the tag.</p>
189
208
  */
190
209
  Key?: string;
191
210
  /**
211
+ * @public
192
212
  * <p>The value of the tag.</p>
193
213
  */
194
214
  Value?: string;
@@ -198,6 +218,7 @@ export interface Tag {
198
218
  */
199
219
  export interface CreateAutoScalingConfigurationRequest {
200
220
  /**
221
+ * @public
201
222
  * <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
202
223
  * name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.</p>
203
224
  * <note>
@@ -209,6 +230,7 @@ export interface CreateAutoScalingConfigurationRequest {
209
230
  */
210
231
  AutoScalingConfigurationName: string | undefined;
211
232
  /**
233
+ * @public
212
234
  * <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
213
235
  * up your service.</p>
214
236
  * <p>Default: <code>100</code>
@@ -216,6 +238,7 @@ export interface CreateAutoScalingConfigurationRequest {
216
238
  */
217
239
  MaxConcurrency?: number;
218
240
  /**
241
+ * @public
219
242
  * <p>The minimum number of instances that App Runner provisions for your service. The service always has at least <code>MinSize</code> provisioned instances.
220
243
  * 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
221
244
  * be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.</p>
@@ -225,12 +248,14 @@ export interface CreateAutoScalingConfigurationRequest {
225
248
  */
226
249
  MinSize?: number;
227
250
  /**
251
+ * @public
228
252
  * <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>
229
253
  * <p>Default: <code>25</code>
230
254
  * </p>
231
255
  */
232
256
  MaxSize?: number;
233
257
  /**
258
+ * @public
234
259
  * <p>A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.</p>
235
260
  */
236
261
  Tags?: Tag[];
@@ -258,34 +283,41 @@ export type AutoScalingConfigurationStatus = (typeof AutoScalingConfigurationSta
258
283
  */
259
284
  export interface AutoScalingConfiguration {
260
285
  /**
286
+ * @public
261
287
  * <p>The Amazon Resource Name (ARN) of this auto scaling configuration.</p>
262
288
  */
263
289
  AutoScalingConfigurationArn?: string;
264
290
  /**
291
+ * @public
265
292
  * <p>The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.</p>
266
293
  */
267
294
  AutoScalingConfigurationName?: string;
268
295
  /**
296
+ * @public
269
297
  * <p>The revision of this auto scaling configuration. It's unique among all the active configurations (<code>"Status": "ACTIVE"</code>) that share the same
270
298
  * <code>AutoScalingConfigurationName</code>.</p>
271
299
  */
272
300
  AutoScalingConfigurationRevision?: number;
273
301
  /**
302
+ * @public
274
303
  * <p>It's set to <code>true</code> for the configuration with the highest <code>Revision</code> among all configurations that share the same
275
304
  * <code>AutoScalingConfigurationName</code>. It's set to <code>false</code> otherwise.</p>
276
305
  */
277
306
  Latest?: boolean;
278
307
  /**
308
+ * @public
279
309
  * <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
280
310
  * used. Inactive configuration revisions are permanently removed some time after they are deleted.</p>
281
311
  */
282
312
  Status?: AutoScalingConfigurationStatus | string;
283
313
  /**
314
+ * @public
284
315
  * <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
285
316
  * up.</p>
286
317
  */
287
318
  MaxConcurrency?: number;
288
319
  /**
320
+ * @public
289
321
  * <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
290
322
  * 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
291
323
  * quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.</p>
@@ -293,14 +325,17 @@ export interface AutoScalingConfiguration {
293
325
  */
294
326
  MinSize?: number;
295
327
  /**
328
+ * @public
296
329
  * <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>
297
330
  */
298
331
  MaxSize?: number;
299
332
  /**
333
+ * @public
300
334
  * <p>The time when the auto scaling configuration was created. It's in Unix time stamp format.</p>
301
335
  */
302
336
  CreatedAt?: Date;
303
337
  /**
338
+ * @public
304
339
  * <p>The time when the auto scaling configuration was deleted. It's in Unix time stamp format.</p>
305
340
  */
306
341
  DeletedAt?: Date;
@@ -310,6 +345,7 @@ export interface AutoScalingConfiguration {
310
345
  */
311
346
  export interface CreateAutoScalingConfigurationResponse {
312
347
  /**
348
+ * @public
313
349
  * <p>A description of the App Runner auto scaling configuration that's created by this request.</p>
314
350
  */
315
351
  AutoScalingConfiguration: AutoScalingConfiguration | undefined;
@@ -345,14 +381,17 @@ export type ProviderType = (typeof ProviderType)[keyof typeof ProviderType];
345
381
  */
346
382
  export interface CreateConnectionRequest {
347
383
  /**
384
+ * @public
348
385
  * <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>
349
386
  */
350
387
  ConnectionName: string | undefined;
351
388
  /**
389
+ * @public
352
390
  * <p>The source repository provider.</p>
353
391
  */
354
392
  ProviderType: ProviderType | string | undefined;
355
393
  /**
394
+ * @public
356
395
  * <p>A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.</p>
357
396
  */
358
397
  Tags?: Tag[];
@@ -377,22 +416,27 @@ export type ConnectionStatus = (typeof ConnectionStatus)[keyof typeof Connection
377
416
  */
378
417
  export interface Connection {
379
418
  /**
419
+ * @public
380
420
  * <p>The customer-provided connection name.</p>
381
421
  */
382
422
  ConnectionName?: string;
383
423
  /**
424
+ * @public
384
425
  * <p>The Amazon Resource Name (ARN) of this connection.</p>
385
426
  */
386
427
  ConnectionArn?: string;
387
428
  /**
429
+ * @public
388
430
  * <p>The source repository provider.</p>
389
431
  */
390
432
  ProviderType?: ProviderType | string;
391
433
  /**
434
+ * @public
392
435
  * <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>
393
436
  */
394
437
  Status?: ConnectionStatus | string;
395
438
  /**
439
+ * @public
396
440
  * <p>The App Runner connection creation time, expressed as a Unix time stamp.</p>
397
441
  */
398
442
  CreatedAt?: Date;
@@ -402,6 +446,7 @@ export interface Connection {
402
446
  */
403
447
  export interface CreateConnectionResponse {
404
448
  /**
449
+ * @public
405
450
  * <p>A description of the App Runner connection that's created by this request.</p>
406
451
  */
407
452
  Connection: Connection | undefined;
@@ -423,6 +468,7 @@ export type TracingVendor = (typeof TracingVendor)[keyof typeof TracingVendor];
423
468
  */
424
469
  export interface TraceConfiguration {
425
470
  /**
471
+ * @public
426
472
  * <p>The implementation provider chosen for tracing App Runner services.</p>
427
473
  */
428
474
  Vendor: TracingVendor | string | undefined;
@@ -432,6 +478,7 @@ export interface TraceConfiguration {
432
478
  */
433
479
  export interface CreateObservabilityConfigurationRequest {
434
480
  /**
481
+ * @public
435
482
  * <p>A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number
436
483
  * <code>1</code> of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.</p>
437
484
  * <note>
@@ -443,10 +490,12 @@ export interface CreateObservabilityConfigurationRequest {
443
490
  */
444
491
  ObservabilityConfigurationName: string | undefined;
445
492
  /**
493
+ * @public
446
494
  * <p>The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.</p>
447
495
  */
448
496
  TraceConfiguration?: TraceConfiguration;
449
497
  /**
498
+ * @public
450
499
  * <p>A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.</p>
451
500
  */
452
501
  Tags?: Tag[];
@@ -473,37 +522,45 @@ export type ObservabilityConfigurationStatus = (typeof ObservabilityConfiguratio
473
522
  */
474
523
  export interface ObservabilityConfiguration {
475
524
  /**
525
+ * @public
476
526
  * <p>The Amazon Resource Name (ARN) of this observability configuration.</p>
477
527
  */
478
528
  ObservabilityConfigurationArn?: string;
479
529
  /**
530
+ * @public
480
531
  * <p>The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.</p>
481
532
  */
482
533
  ObservabilityConfigurationName?: string;
483
534
  /**
535
+ * @public
484
536
  * <p>The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.</p>
485
537
  */
486
538
  TraceConfiguration?: TraceConfiguration;
487
539
  /**
540
+ * @public
488
541
  * <p>The revision of this observability configuration. It's unique among all the active configurations (<code>"Status": "ACTIVE"</code>) that share the
489
542
  * same <code>ObservabilityConfigurationName</code>.</p>
490
543
  */
491
544
  ObservabilityConfigurationRevision?: number;
492
545
  /**
546
+ * @public
493
547
  * <p>It's set to <code>true</code> for the configuration with the highest <code>Revision</code> among all configurations that share the same
494
548
  * <code>ObservabilityConfigurationName</code>. It's set to <code>false</code> otherwise.</p>
495
549
  */
496
550
  Latest?: boolean;
497
551
  /**
552
+ * @public
498
553
  * <p>The current state of the observability configuration. If the status of a configuration revision is <code>INACTIVE</code>, it was deleted and can't be
499
554
  * used. Inactive configuration revisions are permanently removed some time after they are deleted.</p>
500
555
  */
501
556
  Status?: ObservabilityConfigurationStatus | string;
502
557
  /**
558
+ * @public
503
559
  * <p>The time when the observability configuration was created. It's in Unix time stamp format.</p>
504
560
  */
505
561
  CreatedAt?: Date;
506
562
  /**
563
+ * @public
507
564
  * <p>The time when the observability configuration was deleted. It's in Unix time stamp format.</p>
508
565
  */
509
566
  DeletedAt?: Date;
@@ -513,6 +570,7 @@ export interface ObservabilityConfiguration {
513
570
  */
514
571
  export interface CreateObservabilityConfigurationResponse {
515
572
  /**
573
+ * @public
516
574
  * <p>A description of the App Runner observability configuration that's created by this request.</p>
517
575
  */
518
576
  ObservabilityConfiguration: ObservabilityConfiguration | undefined;
@@ -523,6 +581,7 @@ export interface CreateObservabilityConfigurationResponse {
523
581
  */
524
582
  export interface EncryptionConfiguration {
525
583
  /**
584
+ * @public
526
585
  * <p>The ARN of the KMS key that's used for encryption.</p>
527
586
  */
528
587
  KmsKey: string | undefined;
@@ -545,6 +604,7 @@ export type HealthCheckProtocol = (typeof HealthCheckProtocol)[keyof typeof Heal
545
604
  */
546
605
  export interface HealthCheckConfiguration {
547
606
  /**
607
+ * @public
548
608
  * <p>The IP protocol that App Runner uses to perform health checks for your service.</p>
549
609
  * <p>If you set <code>Protocol</code> to <code>HTTP</code>, App Runner sends health check requests to the HTTP path specified by <code>Path</code>.</p>
550
610
  * <p>Default: <code>TCP</code>
@@ -552,6 +612,7 @@ export interface HealthCheckConfiguration {
552
612
  */
553
613
  Protocol?: HealthCheckProtocol | string;
554
614
  /**
615
+ * @public
555
616
  * <p>The URL that health check requests are sent to.</p>
556
617
  * <p>
557
618
  * <code>Path</code> is only applicable when you set <code>Protocol</code> to <code>HTTP</code>.</p>
@@ -560,24 +621,28 @@ export interface HealthCheckConfiguration {
560
621
  */
561
622
  Path?: string;
562
623
  /**
624
+ * @public
563
625
  * <p>The time interval, in seconds, between health checks.</p>
564
626
  * <p>Default: <code>5</code>
565
627
  * </p>
566
628
  */
567
629
  Interval?: number;
568
630
  /**
631
+ * @public
569
632
  * <p>The time, in seconds, to wait for a health check response before deciding it failed.</p>
570
633
  * <p>Default: <code>2</code>
571
634
  * </p>
572
635
  */
573
636
  Timeout?: number;
574
637
  /**
638
+ * @public
575
639
  * <p>The number of consecutive checks that must succeed before App Runner decides that the service is healthy.</p>
576
640
  * <p>Default: <code>1</code>
577
641
  * </p>
578
642
  */
579
643
  HealthyThreshold?: number;
580
644
  /**
645
+ * @public
581
646
  * <p>The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.</p>
582
647
  * <p>Default: <code>5</code>
583
648
  * </p>
@@ -590,18 +655,21 @@ export interface HealthCheckConfiguration {
590
655
  */
591
656
  export interface InstanceConfiguration {
592
657
  /**
658
+ * @public
593
659
  * <p>The number of CPU units reserved for each instance of your App Runner service.</p>
594
660
  * <p>Default: <code>1 vCPU</code>
595
661
  * </p>
596
662
  */
597
663
  Cpu?: string;
598
664
  /**
665
+ * @public
599
666
  * <p>The amount of memory, in MB or GB, reserved for each instance of your App Runner service.</p>
600
667
  * <p>Default: <code>2 GB</code>
601
668
  * </p>
602
669
  */
603
670
  Memory?: string;
604
671
  /**
672
+ * @public
605
673
  * <p>The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls
606
674
  * any Amazon Web Services APIs.</p>
607
675
  */
@@ -625,12 +693,14 @@ export type EgressType = (typeof EgressType)[keyof typeof EgressType];
625
693
  */
626
694
  export interface EgressConfiguration {
627
695
  /**
696
+ * @public
628
697
  * <p>The type of egress configuration.</p>
629
698
  * <p>Set to <code>DEFAULT</code> for access to resources hosted on public networks.</p>
630
699
  * <p>Set to <code>VPC</code> to associate your service to a custom VPC specified by <code>VpcConnectorArn</code>.</p>
631
700
  */
632
701
  EgressType?: EgressType | string;
633
702
  /**
703
+ * @public
634
704
  * <p>The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when <code>EgressType =
635
705
  * VPC</code>.</p>
636
706
  */
@@ -642,6 +712,7 @@ export interface EgressConfiguration {
642
712
  */
643
713
  export interface IngressConfiguration {
644
714
  /**
715
+ * @public
645
716
  * <p>Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to <code>True</code>. To make the service
646
717
  * privately accessible, from only within an Amazon VPC set it to <code>False</code>. </p>
647
718
  */
@@ -654,10 +725,12 @@ export interface IngressConfiguration {
654
725
  */
655
726
  export interface NetworkConfiguration {
656
727
  /**
728
+ * @public
657
729
  * <p>Network configuration settings for outbound message traffic.</p>
658
730
  */
659
731
  EgressConfiguration?: EgressConfiguration;
660
732
  /**
733
+ * @public
661
734
  * <p>Network configuration settings for inbound message traffic.</p>
662
735
  */
663
736
  IngressConfiguration?: IngressConfiguration;
@@ -669,11 +742,13 @@ export interface NetworkConfiguration {
669
742
  */
670
743
  export interface ServiceObservabilityConfiguration {
671
744
  /**
745
+ * @public
672
746
  * <p>When <code>true</code>, an observability configuration resource is associated with the service, and an <code>ObservabilityConfigurationArn</code> is
673
747
  * specified.</p>
674
748
  */
675
749
  ObservabilityEnabled: boolean | undefined;
676
750
  /**
751
+ * @public
677
752
  * <p>The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when
678
753
  * <code>ObservabilityEnabled</code> is <code>true</code>.</p>
679
754
  * <p>Specify an ARN with a name and a revision number to associate that revision. For example:
@@ -691,11 +766,13 @@ export interface ServiceObservabilityConfiguration {
691
766
  */
692
767
  export interface AuthenticationConfiguration {
693
768
  /**
769
+ * @public
694
770
  * <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
695
771
  * repositories.</p>
696
772
  */
697
773
  ConnectionArn?: string;
698
774
  /**
775
+ * @public
699
776
  * <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
700
777
  * (but not for ECR Public repositories).</p>
701
778
  */
@@ -728,30 +805,36 @@ export type Runtime = (typeof Runtime)[keyof typeof Runtime];
728
805
  */
729
806
  export interface CodeConfigurationValues {
730
807
  /**
808
+ * @public
731
809
  * <p>A runtime environment type for building and running an App Runner service.
732
810
  * It represents a
733
811
  * programming language runtime.</p>
734
812
  */
735
813
  Runtime: Runtime | string | undefined;
736
814
  /**
815
+ * @public
737
816
  * <p>The command App Runner runs to build your application.</p>
738
817
  */
739
818
  BuildCommand?: string;
740
819
  /**
820
+ * @public
741
821
  * <p>The command App Runner runs to start your application.</p>
742
822
  */
743
823
  StartCommand?: string;
744
824
  /**
825
+ * @public
745
826
  * <p>The port that your application listens to in the container.</p>
746
827
  * <p>Default: <code>8080</code>
747
828
  * </p>
748
829
  */
749
830
  Port?: string;
750
831
  /**
832
+ * @public
751
833
  * <p>The environment variables that are available to your running App Runner service. An array of key-value pairs.</p>
752
834
  */
753
835
  RuntimeEnvironmentVariables?: Record<string, string>;
754
836
  /**
837
+ * @public
755
838
  * <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
756
839
  * The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p>
757
840
  * <note>
@@ -790,6 +873,7 @@ export type ConfigurationSource = (typeof ConfigurationSource)[keyof typeof Conf
790
873
  */
791
874
  export interface CodeConfiguration {
792
875
  /**
876
+ * @public
793
877
  * <p>The source of the App Runner configuration. Values are interpreted as follows:</p>
794
878
  * <ul>
795
879
  * <li>
@@ -806,6 +890,7 @@ export interface CodeConfiguration {
806
890
  */
807
891
  ConfigurationSource: ConfigurationSource | string | undefined;
808
892
  /**
893
+ * @public
809
894
  * <p>The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a
810
895
  * <code>apprunner.yaml</code> file in the source code repository (or ignoring the file if it exists).</p>
811
896
  */
@@ -828,11 +913,13 @@ export type SourceCodeVersionType = (typeof SourceCodeVersionType)[keyof typeof
828
913
  */
829
914
  export interface SourceCodeVersion {
830
915
  /**
916
+ * @public
831
917
  * <p>The type of version identifier.</p>
832
918
  * <p>For a git-based repository, branches represent versions.</p>
833
919
  */
834
920
  Type: SourceCodeVersionType | string | undefined;
835
921
  /**
922
+ * @public
836
923
  * <p>A source code version.</p>
837
924
  * <p>For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.</p>
838
925
  */
@@ -844,14 +931,17 @@ export interface SourceCodeVersion {
844
931
  */
845
932
  export interface CodeRepository {
846
933
  /**
934
+ * @public
847
935
  * <p>The location of the repository that contains the source code.</p>
848
936
  */
849
937
  RepositoryUrl: string | undefined;
850
938
  /**
939
+ * @public
851
940
  * <p>The version that should be used within the source code repository.</p>
852
941
  */
853
942
  SourceCodeVersion: SourceCodeVersion | undefined;
854
943
  /**
944
+ * @public
855
945
  * <p>Configuration for building and running the service from a source code repository.</p>
856
946
  * <note>
857
947
  * <p>
@@ -866,21 +956,25 @@ export interface CodeRepository {
866
956
  */
867
957
  export interface ImageConfiguration {
868
958
  /**
959
+ * @public
869
960
  * <p>Environment variables that are available to your running App Runner service. An array of key-value pairs.</p>
870
961
  */
871
962
  RuntimeEnvironmentVariables?: Record<string, string>;
872
963
  /**
964
+ * @public
873
965
  * <p>An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start
874
966
  * command.</p>
875
967
  */
876
968
  StartCommand?: string;
877
969
  /**
970
+ * @public
878
971
  * <p>The port that your application listens to in the container.</p>
879
972
  * <p>Default: <code>8080</code>
880
973
  * </p>
881
974
  */
882
975
  Port?: string;
883
976
  /**
977
+ * @public
884
978
  * <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
885
979
  * The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p>
886
980
  * <note>
@@ -919,15 +1013,18 @@ export type ImageRepositoryType = (typeof ImageRepositoryType)[keyof typeof Imag
919
1013
  */
920
1014
  export interface ImageRepository {
921
1015
  /**
1016
+ * @public
922
1017
  * <p>The identifier of an image.</p>
923
1018
  * <p>For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an image</a> in the <i>Amazon ECR User Guide</i>.</p>
924
1019
  */
925
1020
  ImageIdentifier: string | undefined;
926
1021
  /**
1022
+ * @public
927
1023
  * <p>Configuration for running the identified image.</p>
928
1024
  */
929
1025
  ImageConfiguration?: ImageConfiguration;
930
1026
  /**
1027
+ * @public
931
1028
  * <p>The type of the image repository. This reflects the repository provider and whether the repository is private or public.</p>
932
1029
  */
933
1030
  ImageRepositoryType: ImageRepositoryType | string | undefined;
@@ -938,17 +1035,20 @@ export interface ImageRepository {
938
1035
  */
939
1036
  export interface SourceConfiguration {
940
1037
  /**
1038
+ * @public
941
1039
  * <p>The description of a source code repository.</p>
942
1040
  * <p>You must provide either this member or <code>ImageRepository</code> (but not both).</p>
943
1041
  */
944
1042
  CodeRepository?: CodeRepository;
945
1043
  /**
1044
+ * @public
946
1045
  * <p>The description of a source image
947
1046
  * repository.</p>
948
1047
  * <p>You must provide either this member or <code>CodeRepository</code> (but not both).</p>
949
1048
  */
950
1049
  ImageRepository?: ImageRepository;
951
1050
  /**
1051
+ * @public
952
1052
  * <p>If <code>true</code>, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source
953
1053
  * code commit or new image version) starts a deployment.</p>
954
1054
  * <p>Default: App Runner sets to <code>false</code> for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to <code>true</code> in all other cases (which currently include a source code
@@ -956,6 +1056,7 @@ export interface SourceConfiguration {
956
1056
  */
957
1057
  AutoDeploymentsEnabled?: boolean;
958
1058
  /**
1059
+ * @public
959
1060
  * <p>Describes the resources that are needed to authenticate access to some source repositories.</p>
960
1061
  */
961
1062
  AuthenticationConfiguration?: AuthenticationConfiguration;
@@ -965,31 +1066,38 @@ export interface SourceConfiguration {
965
1066
  */
966
1067
  export interface CreateServiceRequest {
967
1068
  /**
1069
+ * @public
968
1070
  * <p>A name for the App Runner 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>
969
1071
  */
970
1072
  ServiceName: string | undefined;
971
1073
  /**
1074
+ * @public
972
1075
  * <p>The source to deploy to the App Runner service. It can be a code or an image repository.</p>
973
1076
  */
974
1077
  SourceConfiguration: SourceConfiguration | undefined;
975
1078
  /**
1079
+ * @public
976
1080
  * <p>The runtime configuration of instances (scaling units) of your service.</p>
977
1081
  */
978
1082
  InstanceConfiguration?: InstanceConfiguration;
979
1083
  /**
1084
+ * @public
980
1085
  * <p>An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.</p>
981
1086
  */
982
1087
  Tags?: Tag[];
983
1088
  /**
1089
+ * @public
984
1090
  * <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,
985
1091
  * App Runner uses an Amazon Web Services managed key.</p>
986
1092
  */
987
1093
  EncryptionConfiguration?: EncryptionConfiguration;
988
1094
  /**
1095
+ * @public
989
1096
  * <p>The settings for the health check that App Runner performs to monitor the health of the App Runner service.</p>
990
1097
  */
991
1098
  HealthCheckConfiguration?: HealthCheckConfiguration;
992
1099
  /**
1100
+ * @public
993
1101
  * <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
994
1102
  * associates the latest revision of a default auto scaling configuration.</p>
995
1103
  * <p>Specify an ARN with a name and a revision number to associate that revision. For example:
@@ -1001,10 +1109,12 @@ export interface CreateServiceRequest {
1001
1109
  */
1002
1110
  AutoScalingConfigurationArn?: string;
1003
1111
  /**
1112
+ * @public
1004
1113
  * <p>Configuration settings related to network traffic of the web application that the App Runner service runs.</p>
1005
1114
  */
1006
1115
  NetworkConfiguration?: NetworkConfiguration;
1007
1116
  /**
1117
+ * @public
1008
1118
  * <p>The observability configuration of your service.</p>
1009
1119
  */
1010
1120
  ObservabilityConfiguration?: ServiceObservabilityConfiguration;
@@ -1018,14 +1128,17 @@ export interface CreateServiceRequest {
1018
1128
  */
1019
1129
  export interface AutoScalingConfigurationSummary {
1020
1130
  /**
1131
+ * @public
1021
1132
  * <p>The Amazon Resource Name (ARN) of this auto scaling configuration.</p>
1022
1133
  */
1023
1134
  AutoScalingConfigurationArn?: string;
1024
1135
  /**
1136
+ * @public
1025
1137
  * <p>The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.</p>
1026
1138
  */
1027
1139
  AutoScalingConfigurationName?: string;
1028
1140
  /**
1141
+ * @public
1029
1142
  * <p>The revision of this auto scaling configuration. It's unique among all the active configurations (<code>"Status": "ACTIVE"</code>) with the same
1030
1143
  * <code>AutoScalingConfigurationName</code>.</p>
1031
1144
  */
@@ -1055,34 +1168,42 @@ export type ServiceStatus = (typeof ServiceStatus)[keyof typeof ServiceStatus];
1055
1168
  */
1056
1169
  export interface Service {
1057
1170
  /**
1171
+ * @public
1058
1172
  * <p>The customer-provided service name.</p>
1059
1173
  */
1060
1174
  ServiceName: string | undefined;
1061
1175
  /**
1176
+ * @public
1062
1177
  * <p>An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.</p>
1063
1178
  */
1064
1179
  ServiceId: string | undefined;
1065
1180
  /**
1181
+ * @public
1066
1182
  * <p>The Amazon Resource Name (ARN) of this service.</p>
1067
1183
  */
1068
1184
  ServiceArn: string | undefined;
1069
1185
  /**
1186
+ * @public
1070
1187
  * <p>A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.</p>
1071
1188
  */
1072
1189
  ServiceUrl?: string;
1073
1190
  /**
1191
+ * @public
1074
1192
  * <p>The time when the App Runner service was created. It's in the Unix time stamp format.</p>
1075
1193
  */
1076
1194
  CreatedAt: Date | undefined;
1077
1195
  /**
1196
+ * @public
1078
1197
  * <p>The time when the App Runner service was last updated at. It's in the Unix time stamp format.</p>
1079
1198
  */
1080
1199
  UpdatedAt: Date | undefined;
1081
1200
  /**
1201
+ * @public
1082
1202
  * <p>The time when the App Runner service was deleted. It's in the Unix time stamp format.</p>
1083
1203
  */
1084
1204
  DeletedAt?: Date;
1085
1205
  /**
1206
+ * @public
1086
1207
  * <p>The current state of the App Runner service. These particular values mean the following.</p>
1087
1208
  * <ul>
1088
1209
  * <li>
@@ -1100,31 +1221,38 @@ export interface Service {
1100
1221
  */
1101
1222
  Status: ServiceStatus | string | undefined;
1102
1223
  /**
1224
+ * @public
1103
1225
  * <p>The source deployed to the App Runner service. It can be a code or an image repository.</p>
1104
1226
  */
1105
1227
  SourceConfiguration: SourceConfiguration | undefined;
1106
1228
  /**
1229
+ * @public
1107
1230
  * <p>The runtime configuration of instances (scaling units) of this service.</p>
1108
1231
  */
1109
1232
  InstanceConfiguration: InstanceConfiguration | undefined;
1110
1233
  /**
1234
+ * @public
1111
1235
  * <p>The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be
1112
1236
  * either a customer-provided encryption key or an Amazon Web Services managed key.</p>
1113
1237
  */
1114
1238
  EncryptionConfiguration?: EncryptionConfiguration;
1115
1239
  /**
1240
+ * @public
1116
1241
  * <p>The settings for the health check that App Runner performs to monitor the health of this service.</p>
1117
1242
  */
1118
1243
  HealthCheckConfiguration?: HealthCheckConfiguration;
1119
1244
  /**
1245
+ * @public
1120
1246
  * <p>Summary information for the App Runner automatic scaling configuration resource that's associated with this service.</p>
1121
1247
  */
1122
1248
  AutoScalingConfigurationSummary: AutoScalingConfigurationSummary | undefined;
1123
1249
  /**
1250
+ * @public
1124
1251
  * <p>Configuration settings related to network traffic of the web application that this service runs.</p>
1125
1252
  */
1126
1253
  NetworkConfiguration: NetworkConfiguration | undefined;
1127
1254
  /**
1255
+ * @public
1128
1256
  * <p>The observability configuration of this service.</p>
1129
1257
  */
1130
1258
  ObservabilityConfiguration?: ServiceObservabilityConfiguration;
@@ -1134,10 +1262,12 @@ export interface Service {
1134
1262
  */
1135
1263
  export interface CreateServiceResponse {
1136
1264
  /**
1265
+ * @public
1137
1266
  * <p>A description of the App Runner service that's created by this request.</p>
1138
1267
  */
1139
1268
  Service: Service | undefined;
1140
1269
  /**
1270
+ * @public
1141
1271
  * <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>
1142
1272
  */
1143
1273
  OperationId: string | undefined;
@@ -1147,10 +1277,12 @@ export interface CreateServiceResponse {
1147
1277
  */
1148
1278
  export interface CreateVpcConnectorRequest {
1149
1279
  /**
1280
+ * @public
1150
1281
  * <p>A name for the VPC connector.</p>
1151
1282
  */
1152
1283
  VpcConnectorName: string | undefined;
1153
1284
  /**
1285
+ * @public
1154
1286
  * <p>A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single
1155
1287
  * Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.</p>
1156
1288
  * <note>
@@ -1161,11 +1293,13 @@ export interface CreateVpcConnectorRequest {
1161
1293
  */
1162
1294
  Subnets: string[] | undefined;
1163
1295
  /**
1296
+ * @public
1164
1297
  * <p>A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the
1165
1298
  * default security group of the Amazon VPC. The default security group allows all outbound traffic.</p>
1166
1299
  */
1167
1300
  SecurityGroups?: string[];
1168
1301
  /**
1302
+ * @public
1169
1303
  * <p>A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.</p>
1170
1304
  */
1171
1305
  Tags?: Tag[];
@@ -1193,14 +1327,17 @@ export type VpcConnectorStatus = (typeof VpcConnectorStatus)[keyof typeof VpcCon
1193
1327
  */
1194
1328
  export interface VpcConnector {
1195
1329
  /**
1330
+ * @public
1196
1331
  * <p>The customer-provided VPC connector name.</p>
1197
1332
  */
1198
1333
  VpcConnectorName?: string;
1199
1334
  /**
1335
+ * @public
1200
1336
  * <p>The Amazon Resource Name (ARN) of this VPC connector.</p>
1201
1337
  */
1202
1338
  VpcConnectorArn?: string;
1203
1339
  /**
1340
+ * @public
1204
1341
  * <p>The revision of this VPC connector. It's unique among all the active connectors (<code>"Status": "ACTIVE"</code>) that share the same
1205
1342
  * <code>Name</code>.</p>
1206
1343
  * <note>
@@ -1209,24 +1346,29 @@ export interface VpcConnector {
1209
1346
  */
1210
1347
  VpcConnectorRevision?: number;
1211
1348
  /**
1349
+ * @public
1212
1350
  * <p>A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.</p>
1213
1351
  */
1214
1352
  Subnets?: string[];
1215
1353
  /**
1354
+ * @public
1216
1355
  * <p>A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default
1217
1356
  * security group of the Amazon VPC. The default security group allows all outbound traffic.</p>
1218
1357
  */
1219
1358
  SecurityGroups?: string[];
1220
1359
  /**
1360
+ * @public
1221
1361
  * <p>The current state of the VPC connector. If the status of a connector revision is <code>INACTIVE</code>, it was deleted and can't be
1222
1362
  * used. Inactive connector revisions are permanently removed some time after they are deleted.</p>
1223
1363
  */
1224
1364
  Status?: VpcConnectorStatus | string;
1225
1365
  /**
1366
+ * @public
1226
1367
  * <p>The time when the VPC connector was created. It's in Unix time stamp format.</p>
1227
1368
  */
1228
1369
  CreatedAt?: Date;
1229
1370
  /**
1371
+ * @public
1230
1372
  * <p>The time when the VPC connector was deleted. It's in Unix time stamp format.</p>
1231
1373
  */
1232
1374
  DeletedAt?: Date;
@@ -1236,6 +1378,7 @@ export interface VpcConnector {
1236
1378
  */
1237
1379
  export interface CreateVpcConnectorResponse {
1238
1380
  /**
1381
+ * @public
1239
1382
  * <p>A description of the App Runner VPC connector that's created by this request.</p>
1240
1383
  */
1241
1384
  VpcConnector: VpcConnector | undefined;
@@ -1247,10 +1390,12 @@ export interface CreateVpcConnectorResponse {
1247
1390
  */
1248
1391
  export interface IngressVpcConfiguration {
1249
1392
  /**
1393
+ * @public
1250
1394
  * <p>The ID of the VPC that is used for the VPC endpoint.</p>
1251
1395
  */
1252
1396
  VpcId?: string;
1253
1397
  /**
1398
+ * @public
1254
1399
  * <p>The ID of the VPC endpoint that your App Runner service connects to.
1255
1400
  * </p>
1256
1401
  */
@@ -1261,20 +1406,24 @@ export interface IngressVpcConfiguration {
1261
1406
  */
1262
1407
  export interface CreateVpcIngressConnectionRequest {
1263
1408
  /**
1409
+ * @public
1264
1410
  * <p>The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.</p>
1265
1411
  */
1266
1412
  ServiceArn: string | undefined;
1267
1413
  /**
1414
+ * @public
1268
1415
  * <p>A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.
1269
1416
  * </p>
1270
1417
  */
1271
1418
  VpcIngressConnectionName: string | undefined;
1272
1419
  /**
1420
+ * @public
1273
1421
  * <p>Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection
1274
1422
  * resource.</p>
1275
1423
  */
1276
1424
  IngressVpcConfiguration: IngressVpcConfiguration | undefined;
1277
1425
  /**
1426
+ * @public
1278
1427
  * <p>An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.</p>
1279
1428
  */
1280
1429
  Tags?: Tag[];
@@ -1304,38 +1453,46 @@ export type VpcIngressConnectionStatus = (typeof VpcIngressConnectionStatus)[key
1304
1453
  */
1305
1454
  export interface VpcIngressConnection {
1306
1455
  /**
1456
+ * @public
1307
1457
  * <p>The Amazon Resource Name (ARN) of the VPC Ingress Connection.
1308
1458
  * </p>
1309
1459
  */
1310
1460
  VpcIngressConnectionArn?: string;
1311
1461
  /**
1462
+ * @public
1312
1463
  * <p>The customer-provided VPC Ingress Connection name.</p>
1313
1464
  */
1314
1465
  VpcIngressConnectionName?: string;
1315
1466
  /**
1467
+ * @public
1316
1468
  * <p>The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
1317
1469
  * </p>
1318
1470
  */
1319
1471
  ServiceArn?: string;
1320
1472
  /**
1473
+ * @public
1321
1474
  * <p>The current status of the VPC Ingress Connection.
1322
1475
  * The VPC Ingress Connection displays one of the following statuses: <code>AVAILABLE</code>, <code>PENDING_CREATION</code>, <code>PENDING_UPDATE</code>, <code>PENDING_DELETION</code>,<code>FAILED_CREATION</code>, <code>FAILED_UPDATE</code>, <code>FAILED_DELETION</code>, and <code>DELETED</code>..
1323
1476
  * </p>
1324
1477
  */
1325
1478
  Status?: VpcIngressConnectionStatus | string;
1326
1479
  /**
1480
+ * @public
1327
1481
  * <p>The Account Id you use to create the VPC Ingress Connection resource.</p>
1328
1482
  */
1329
1483
  AccountId?: string;
1330
1484
  /**
1485
+ * @public
1331
1486
  * <p>The domain name associated with the VPC Ingress Connection resource.</p>
1332
1487
  */
1333
1488
  DomainName?: string;
1334
1489
  /**
1490
+ * @public
1335
1491
  * <p>Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.</p>
1336
1492
  */
1337
1493
  IngressVpcConfiguration?: IngressVpcConfiguration;
1338
1494
  /**
1495
+ * @public
1339
1496
  * <p>The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.</p>
1340
1497
  * <ul>
1341
1498
  * <li>
@@ -1352,6 +1509,7 @@ export interface VpcIngressConnection {
1352
1509
  */
1353
1510
  CreatedAt?: Date;
1354
1511
  /**
1512
+ * @public
1355
1513
  * <p>The time when the App Runner service was deleted. It's in the Unix time stamp format.</p>
1356
1514
  * <ul>
1357
1515
  * <li>
@@ -1373,6 +1531,7 @@ export interface VpcIngressConnection {
1373
1531
  */
1374
1532
  export interface CreateVpcIngressConnectionResponse {
1375
1533
  /**
1534
+ * @public
1376
1535
  * <p>A description of the App Runner VPC Ingress Connection resource that's created by this request. </p>
1377
1536
  */
1378
1537
  VpcIngressConnection: VpcIngressConnection | undefined;
@@ -1382,6 +1541,7 @@ export interface CreateVpcIngressConnectionResponse {
1382
1541
  */
1383
1542
  export interface DeleteAutoScalingConfigurationRequest {
1384
1543
  /**
1544
+ * @public
1385
1545
  * <p>The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.</p>
1386
1546
  * <p>The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either <code>.../<i>name</i>
1387
1547
  * </code> or
@@ -1395,6 +1555,7 @@ export interface DeleteAutoScalingConfigurationRequest {
1395
1555
  */
1396
1556
  export interface DeleteAutoScalingConfigurationResponse {
1397
1557
  /**
1558
+ * @public
1398
1559
  * <p>A description of the App Runner auto scaling configuration that this request just deleted.</p>
1399
1560
  */
1400
1561
  AutoScalingConfiguration: AutoScalingConfiguration | undefined;
@@ -1417,6 +1578,7 @@ export declare class ResourceNotFoundException extends __BaseException {
1417
1578
  */
1418
1579
  export interface DeleteConnectionRequest {
1419
1580
  /**
1581
+ * @public
1420
1582
  * <p>The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.</p>
1421
1583
  */
1422
1584
  ConnectionArn: string | undefined;
@@ -1426,6 +1588,7 @@ export interface DeleteConnectionRequest {
1426
1588
  */
1427
1589
  export interface DeleteConnectionResponse {
1428
1590
  /**
1591
+ * @public
1429
1592
  * <p>A description of the App Runner connection that this request just deleted.</p>
1430
1593
  */
1431
1594
  Connection?: Connection;
@@ -1435,6 +1598,7 @@ export interface DeleteConnectionResponse {
1435
1598
  */
1436
1599
  export interface DeleteObservabilityConfigurationRequest {
1437
1600
  /**
1601
+ * @public
1438
1602
  * <p>The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.</p>
1439
1603
  * <p>The ARN can be a full observability configuration ARN, or a partial ARN ending with either <code>.../<i>name</i>
1440
1604
  * </code> or
@@ -1448,6 +1612,7 @@ export interface DeleteObservabilityConfigurationRequest {
1448
1612
  */
1449
1613
  export interface DeleteObservabilityConfigurationResponse {
1450
1614
  /**
1615
+ * @public
1451
1616
  * <p>A description of the App Runner observability configuration that this request just deleted.</p>
1452
1617
  */
1453
1618
  ObservabilityConfiguration: ObservabilityConfiguration | undefined;
@@ -1457,6 +1622,7 @@ export interface DeleteObservabilityConfigurationResponse {
1457
1622
  */
1458
1623
  export interface DeleteServiceRequest {
1459
1624
  /**
1625
+ * @public
1460
1626
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to delete.</p>
1461
1627
  */
1462
1628
  ServiceArn: string | undefined;
@@ -1466,10 +1632,12 @@ export interface DeleteServiceRequest {
1466
1632
  */
1467
1633
  export interface DeleteServiceResponse {
1468
1634
  /**
1635
+ * @public
1469
1636
  * <p>A description of the App Runner service that this request just deleted.</p>
1470
1637
  */
1471
1638
  Service: Service | undefined;
1472
1639
  /**
1640
+ * @public
1473
1641
  * <p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a>ListOperations</a> call to track
1474
1642
  * the operation's progress.</p>
1475
1643
  */
@@ -1480,6 +1648,7 @@ export interface DeleteServiceResponse {
1480
1648
  */
1481
1649
  export interface DeleteVpcConnectorRequest {
1482
1650
  /**
1651
+ * @public
1483
1652
  * <p>The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.</p>
1484
1653
  * <p>The ARN must be a full VPC connector ARN.</p>
1485
1654
  */
@@ -1490,6 +1659,7 @@ export interface DeleteVpcConnectorRequest {
1490
1659
  */
1491
1660
  export interface DeleteVpcConnectorResponse {
1492
1661
  /**
1662
+ * @public
1493
1663
  * <p>A description of the App Runner VPC connector that this request just deleted.</p>
1494
1664
  */
1495
1665
  VpcConnector: VpcConnector | undefined;
@@ -1499,6 +1669,7 @@ export interface DeleteVpcConnectorResponse {
1499
1669
  */
1500
1670
  export interface DeleteVpcIngressConnectionRequest {
1501
1671
  /**
1672
+ * @public
1502
1673
  * <p>The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.</p>
1503
1674
  */
1504
1675
  VpcIngressConnectionArn: string | undefined;
@@ -1508,6 +1679,7 @@ export interface DeleteVpcIngressConnectionRequest {
1508
1679
  */
1509
1680
  export interface DeleteVpcIngressConnectionResponse {
1510
1681
  /**
1682
+ * @public
1511
1683
  * <p>A description of the App Runner VPC Ingress Connection that this request just deleted.</p>
1512
1684
  */
1513
1685
  VpcIngressConnection: VpcIngressConnection | undefined;
@@ -1517,6 +1689,7 @@ export interface DeleteVpcIngressConnectionResponse {
1517
1689
  */
1518
1690
  export interface DescribeAutoScalingConfigurationRequest {
1519
1691
  /**
1692
+ * @public
1520
1693
  * <p>The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.</p>
1521
1694
  * <p>The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either <code>.../<i>name</i>
1522
1695
  * </code> or
@@ -1531,6 +1704,7 @@ export interface DescribeAutoScalingConfigurationRequest {
1531
1704
  */
1532
1705
  export interface DescribeAutoScalingConfigurationResponse {
1533
1706
  /**
1707
+ * @public
1534
1708
  * <p>A full description of the App Runner auto scaling configuration that you specified in this request.</p>
1535
1709
  */
1536
1710
  AutoScalingConfiguration: AutoScalingConfiguration | undefined;
@@ -1540,16 +1714,19 @@ export interface DescribeAutoScalingConfigurationResponse {
1540
1714
  */
1541
1715
  export interface DescribeCustomDomainsRequest {
1542
1716
  /**
1717
+ * @public
1543
1718
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.</p>
1544
1719
  */
1545
1720
  ServiceArn: string | undefined;
1546
1721
  /**
1722
+ * @public
1547
1723
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
1548
1724
  * identical to the ones that are specified in the initial request.</p>
1549
1725
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
1550
1726
  */
1551
1727
  NextToken?: string;
1552
1728
  /**
1729
+ * @public
1553
1730
  * <p>The maximum number of results that each response (result page) can include. It's used for a paginated request.</p>
1554
1731
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1555
1732
  */
@@ -1560,24 +1737,29 @@ export interface DescribeCustomDomainsRequest {
1560
1737
  */
1561
1738
  export interface DescribeCustomDomainsResponse {
1562
1739
  /**
1740
+ * @public
1563
1741
  * <p>The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.</p>
1564
1742
  */
1565
1743
  DNSTarget: string | undefined;
1566
1744
  /**
1745
+ * @public
1567
1746
  * <p>The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.</p>
1568
1747
  */
1569
1748
  ServiceArn: string | undefined;
1570
1749
  /**
1750
+ * @public
1571
1751
  * <p>A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to
1572
1752
  * <code>MaxResults</code> records per call.</p>
1573
1753
  */
1574
1754
  CustomDomains: CustomDomain[] | undefined;
1575
1755
  /**
1756
+ * @public
1576
1757
  * <p>DNS Target records for the custom domains of this Amazon VPC.
1577
1758
  * </p>
1578
1759
  */
1579
1760
  VpcDNSTargets: VpcDNSTarget[] | undefined;
1580
1761
  /**
1762
+ * @public
1581
1763
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
1582
1764
  */
1583
1765
  NextToken?: string;
@@ -1587,6 +1769,7 @@ export interface DescribeCustomDomainsResponse {
1587
1769
  */
1588
1770
  export interface DescribeObservabilityConfigurationRequest {
1589
1771
  /**
1772
+ * @public
1590
1773
  * <p>The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.</p>
1591
1774
  * <p>The ARN can be a full observability configuration ARN, or a partial ARN ending with either <code>.../<i>name</i>
1592
1775
  * </code> or
@@ -1601,6 +1784,7 @@ export interface DescribeObservabilityConfigurationRequest {
1601
1784
  */
1602
1785
  export interface DescribeObservabilityConfigurationResponse {
1603
1786
  /**
1787
+ * @public
1604
1788
  * <p>A full description of the App Runner observability configuration that you specified in this request.</p>
1605
1789
  */
1606
1790
  ObservabilityConfiguration: ObservabilityConfiguration | undefined;
@@ -1610,6 +1794,7 @@ export interface DescribeObservabilityConfigurationResponse {
1610
1794
  */
1611
1795
  export interface DescribeServiceRequest {
1612
1796
  /**
1797
+ * @public
1613
1798
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want a description for.</p>
1614
1799
  */
1615
1800
  ServiceArn: string | undefined;
@@ -1619,6 +1804,7 @@ export interface DescribeServiceRequest {
1619
1804
  */
1620
1805
  export interface DescribeServiceResponse {
1621
1806
  /**
1807
+ * @public
1622
1808
  * <p>A full description of the App Runner service that you specified in this request.</p>
1623
1809
  */
1624
1810
  Service: Service | undefined;
@@ -1628,6 +1814,7 @@ export interface DescribeServiceResponse {
1628
1814
  */
1629
1815
  export interface DescribeVpcConnectorRequest {
1630
1816
  /**
1817
+ * @public
1631
1818
  * <p>The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.</p>
1632
1819
  * <p>The ARN must be a full VPC connector ARN.</p>
1633
1820
  */
@@ -1638,6 +1825,7 @@ export interface DescribeVpcConnectorRequest {
1638
1825
  */
1639
1826
  export interface DescribeVpcConnectorResponse {
1640
1827
  /**
1828
+ * @public
1641
1829
  * <p>A description of the App Runner VPC connector that you specified in this request.</p>
1642
1830
  */
1643
1831
  VpcConnector: VpcConnector | undefined;
@@ -1647,6 +1835,7 @@ export interface DescribeVpcConnectorResponse {
1647
1835
  */
1648
1836
  export interface DescribeVpcIngressConnectionRequest {
1649
1837
  /**
1838
+ * @public
1650
1839
  * <p>The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.</p>
1651
1840
  */
1652
1841
  VpcIngressConnectionArn: string | undefined;
@@ -1656,6 +1845,7 @@ export interface DescribeVpcIngressConnectionRequest {
1656
1845
  */
1657
1846
  export interface DescribeVpcIngressConnectionResponse {
1658
1847
  /**
1848
+ * @public
1659
1849
  * <p>A description of the App Runner VPC Ingress Connection that you specified in this request.</p>
1660
1850
  */
1661
1851
  VpcIngressConnection: VpcIngressConnection | undefined;
@@ -1665,10 +1855,12 @@ export interface DescribeVpcIngressConnectionResponse {
1665
1855
  */
1666
1856
  export interface DisassociateCustomDomainRequest {
1667
1857
  /**
1858
+ * @public
1668
1859
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.</p>
1669
1860
  */
1670
1861
  ServiceArn: string | undefined;
1671
1862
  /**
1863
+ * @public
1672
1864
  * <p>The domain name that you want to disassociate from the App Runner service.</p>
1673
1865
  */
1674
1866
  DomainName: string | undefined;
@@ -1678,18 +1870,22 @@ export interface DisassociateCustomDomainRequest {
1678
1870
  */
1679
1871
  export interface DisassociateCustomDomainResponse {
1680
1872
  /**
1873
+ * @public
1681
1874
  * <p>The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.</p>
1682
1875
  */
1683
1876
  DNSTarget: string | undefined;
1684
1877
  /**
1878
+ * @public
1685
1879
  * <p>The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.</p>
1686
1880
  */
1687
1881
  ServiceArn: string | undefined;
1688
1882
  /**
1883
+ * @public
1689
1884
  * <p>A description of the domain name that's being disassociated.</p>
1690
1885
  */
1691
1886
  CustomDomain: CustomDomain | undefined;
1692
1887
  /**
1888
+ * @public
1693
1889
  * <p>DNS Target records for the custom domains of this Amazon VPC.
1694
1890
  * </p>
1695
1891
  */
@@ -1700,11 +1896,13 @@ export interface DisassociateCustomDomainResponse {
1700
1896
  */
1701
1897
  export interface ListAutoScalingConfigurationsRequest {
1702
1898
  /**
1899
+ * @public
1703
1900
  * <p>The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner
1704
1901
  * returns revisions of all active configurations.</p>
1705
1902
  */
1706
1903
  AutoScalingConfigurationName?: string;
1707
1904
  /**
1905
+ * @public
1708
1906
  * <p>Set to <code>true</code> to list only the latest revision for each requested configuration name.</p>
1709
1907
  * <p>Set to <code>false</code> to list all revisions for each requested configuration name.</p>
1710
1908
  * <p>Default: <code>true</code>
@@ -1712,11 +1910,13 @@ export interface ListAutoScalingConfigurationsRequest {
1712
1910
  */
1713
1911
  LatestOnly?: boolean;
1714
1912
  /**
1913
+ * @public
1715
1914
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
1716
1915
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1717
1916
  */
1718
1917
  MaxResults?: number;
1719
1918
  /**
1919
+ * @public
1720
1920
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
1721
1921
  * identical to the ones that are specified in the initial request.</p>
1722
1922
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
@@ -1728,11 +1928,13 @@ export interface ListAutoScalingConfigurationsRequest {
1728
1928
  */
1729
1929
  export interface ListAutoScalingConfigurationsResponse {
1730
1930
  /**
1931
+ * @public
1731
1932
  * <p>A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to <code>MaxResults</code>
1732
1933
  * records for each call.</p>
1733
1934
  */
1734
1935
  AutoScalingConfigurationSummaryList: AutoScalingConfigurationSummary[] | undefined;
1735
1936
  /**
1937
+ * @public
1736
1938
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
1737
1939
  */
1738
1940
  NextToken?: string;
@@ -1742,15 +1944,18 @@ export interface ListAutoScalingConfigurationsResponse {
1742
1944
  */
1743
1945
  export interface ListConnectionsRequest {
1744
1946
  /**
1947
+ * @public
1745
1948
  * <p>If specified, only this connection is returned. If not specified, the result isn't filtered by name.</p>
1746
1949
  */
1747
1950
  ConnectionName?: string;
1748
1951
  /**
1952
+ * @public
1749
1953
  * <p>The maximum number of results to include in each response (result page). Used for a paginated request.</p>
1750
1954
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1751
1955
  */
1752
1956
  MaxResults?: number;
1753
1957
  /**
1958
+ * @public
1754
1959
  * <p>A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be
1755
1960
  * identical to the ones specified in the initial request.</p>
1756
1961
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
@@ -1763,22 +1968,27 @@ export interface ListConnectionsRequest {
1763
1968
  */
1764
1969
  export interface ConnectionSummary {
1765
1970
  /**
1971
+ * @public
1766
1972
  * <p>The customer-provided connection name.</p>
1767
1973
  */
1768
1974
  ConnectionName?: string;
1769
1975
  /**
1976
+ * @public
1770
1977
  * <p>The Amazon Resource Name (ARN) of this connection.</p>
1771
1978
  */
1772
1979
  ConnectionArn?: string;
1773
1980
  /**
1981
+ * @public
1774
1982
  * <p>The source repository provider.</p>
1775
1983
  */
1776
1984
  ProviderType?: ProviderType | string;
1777
1985
  /**
1986
+ * @public
1778
1987
  * <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>
1779
1988
  */
1780
1989
  Status?: ConnectionStatus | string;
1781
1990
  /**
1991
+ * @public
1782
1992
  * <p>The App Runner connection creation time, expressed as a Unix time stamp.</p>
1783
1993
  */
1784
1994
  CreatedAt?: Date;
@@ -1788,11 +1998,13 @@ export interface ConnectionSummary {
1788
1998
  */
1789
1999
  export interface ListConnectionsResponse {
1790
2000
  /**
2001
+ * @public
1791
2002
  * <p>A list of summary information records for connections. In a paginated request, the request returns up to <code>MaxResults</code> records for each
1792
2003
  * call.</p>
1793
2004
  */
1794
2005
  ConnectionSummaryList: ConnectionSummary[] | undefined;
1795
2006
  /**
2007
+ * @public
1796
2008
  * <p>The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.</p>
1797
2009
  */
1798
2010
  NextToken?: string;
@@ -1802,11 +2014,13 @@ export interface ListConnectionsResponse {
1802
2014
  */
1803
2015
  export interface ListObservabilityConfigurationsRequest {
1804
2016
  /**
2017
+ * @public
1805
2018
  * <p>The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified,
1806
2019
  * App Runner returns revisions of all active configurations.</p>
1807
2020
  */
1808
2021
  ObservabilityConfigurationName?: string;
1809
2022
  /**
2023
+ * @public
1810
2024
  * <p>Set to <code>true</code> to list only the latest revision for each requested configuration name.</p>
1811
2025
  * <p>Set to <code>false</code> to list all revisions for each requested configuration name.</p>
1812
2026
  * <p>Default: <code>true</code>
@@ -1814,11 +2028,13 @@ export interface ListObservabilityConfigurationsRequest {
1814
2028
  */
1815
2029
  LatestOnly?: boolean;
1816
2030
  /**
2031
+ * @public
1817
2032
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
1818
2033
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1819
2034
  */
1820
2035
  MaxResults?: number;
1821
2036
  /**
2037
+ * @public
1822
2038
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
1823
2039
  * identical to the ones that are specified in the initial request.</p>
1824
2040
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
@@ -1834,14 +2050,17 @@ export interface ListObservabilityConfigurationsRequest {
1834
2050
  */
1835
2051
  export interface ObservabilityConfigurationSummary {
1836
2052
  /**
2053
+ * @public
1837
2054
  * <p>The Amazon Resource Name (ARN) of this observability configuration.</p>
1838
2055
  */
1839
2056
  ObservabilityConfigurationArn?: string;
1840
2057
  /**
2058
+ * @public
1841
2059
  * <p>The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.</p>
1842
2060
  */
1843
2061
  ObservabilityConfigurationName?: string;
1844
2062
  /**
2063
+ * @public
1845
2064
  * <p>The revision of this observability configuration. It's unique among all the active configurations (<code>"Status": "ACTIVE"</code>) that share the
1846
2065
  * same <code>ObservabilityConfigurationName</code>.</p>
1847
2066
  */
@@ -1852,11 +2071,13 @@ export interface ObservabilityConfigurationSummary {
1852
2071
  */
1853
2072
  export interface ListObservabilityConfigurationsResponse {
1854
2073
  /**
2074
+ * @public
1855
2075
  * <p>A list of summary information records for observability configurations. In a paginated request, the request returns up to <code>MaxResults</code>
1856
2076
  * records for each call.</p>
1857
2077
  */
1858
2078
  ObservabilityConfigurationSummaryList: ObservabilityConfigurationSummary[] | undefined;
1859
2079
  /**
2080
+ * @public
1860
2081
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
1861
2082
  */
1862
2083
  NextToken?: string;
@@ -1866,16 +2087,19 @@ export interface ListObservabilityConfigurationsResponse {
1866
2087
  */
1867
2088
  export interface ListOperationsRequest {
1868
2089
  /**
2090
+ * @public
1869
2091
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.</p>
1870
2092
  */
1871
2093
  ServiceArn: string | undefined;
1872
2094
  /**
2095
+ * @public
1873
2096
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
1874
2097
  * identical to the ones specified in the initial request.</p>
1875
2098
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
1876
2099
  */
1877
2100
  NextToken?: string;
1878
2101
  /**
2102
+ * @public
1879
2103
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
1880
2104
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1881
2105
  */
@@ -1920,30 +2144,37 @@ export type OperationType = (typeof OperationType)[keyof typeof OperationType];
1920
2144
  */
1921
2145
  export interface OperationSummary {
1922
2146
  /**
2147
+ * @public
1923
2148
  * <p>A unique ID of this operation. It's unique in the scope of the App Runner service.</p>
1924
2149
  */
1925
2150
  Id?: string;
1926
2151
  /**
2152
+ * @public
1927
2153
  * <p>The type of operation. It indicates a specific action that occured.</p>
1928
2154
  */
1929
2155
  Type?: OperationType | string;
1930
2156
  /**
2157
+ * @public
1931
2158
  * <p>The current state of the operation.</p>
1932
2159
  */
1933
2160
  Status?: OperationStatus | string;
1934
2161
  /**
2162
+ * @public
1935
2163
  * <p>The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).</p>
1936
2164
  */
1937
2165
  TargetArn?: string;
1938
2166
  /**
2167
+ * @public
1939
2168
  * <p>The time when the operation started. It's in the Unix time stamp format.</p>
1940
2169
  */
1941
2170
  StartedAt?: Date;
1942
2171
  /**
2172
+ * @public
1943
2173
  * <p>The time when the operation ended. It's in the Unix time stamp format.</p>
1944
2174
  */
1945
2175
  EndedAt?: Date;
1946
2176
  /**
2177
+ * @public
1947
2178
  * <p>The time when the operation was last updated. It's in the Unix time stamp format.</p>
1948
2179
  */
1949
2180
  UpdatedAt?: Date;
@@ -1953,11 +2184,13 @@ export interface OperationSummary {
1953
2184
  */
1954
2185
  export interface ListOperationsResponse {
1955
2186
  /**
2187
+ * @public
1956
2188
  * <p>A list of operation summary information records. In a paginated request, the request returns up to <code>MaxResults</code> records for each
1957
2189
  * call.</p>
1958
2190
  */
1959
2191
  OperationSummaryList?: OperationSummary[];
1960
2192
  /**
2193
+ * @public
1961
2194
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
1962
2195
  */
1963
2196
  NextToken?: string;
@@ -1967,12 +2200,14 @@ export interface ListOperationsResponse {
1967
2200
  */
1968
2201
  export interface ListServicesRequest {
1969
2202
  /**
2203
+ * @public
1970
2204
  * <p>A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be
1971
2205
  * identical to the ones specified in the initial request.</p>
1972
2206
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
1973
2207
  */
1974
2208
  NextToken?: string;
1975
2209
  /**
2210
+ * @public
1976
2211
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
1977
2212
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
1978
2213
  */
@@ -1985,30 +2220,37 @@ export interface ListServicesRequest {
1985
2220
  */
1986
2221
  export interface ServiceSummary {
1987
2222
  /**
2223
+ * @public
1988
2224
  * <p>The customer-provided service name.</p>
1989
2225
  */
1990
2226
  ServiceName?: string;
1991
2227
  /**
2228
+ * @public
1992
2229
  * <p>An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.</p>
1993
2230
  */
1994
2231
  ServiceId?: string;
1995
2232
  /**
2233
+ * @public
1996
2234
  * <p>The Amazon Resource Name (ARN) of this service.</p>
1997
2235
  */
1998
2236
  ServiceArn?: string;
1999
2237
  /**
2238
+ * @public
2000
2239
  * <p>A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.</p>
2001
2240
  */
2002
2241
  ServiceUrl?: string;
2003
2242
  /**
2243
+ * @public
2004
2244
  * <p>The time when the App Runner service was created. It's in the Unix time stamp format.</p>
2005
2245
  */
2006
2246
  CreatedAt?: Date;
2007
2247
  /**
2248
+ * @public
2008
2249
  * <p>The time when the App Runner service was last updated. It's in theUnix time stamp format.</p>
2009
2250
  */
2010
2251
  UpdatedAt?: Date;
2011
2252
  /**
2253
+ * @public
2012
2254
  * <p>The current state of the App Runner service. These particular values mean the following.</p>
2013
2255
  * <ul>
2014
2256
  * <li>
@@ -2031,10 +2273,12 @@ export interface ServiceSummary {
2031
2273
  */
2032
2274
  export interface ListServicesResponse {
2033
2275
  /**
2276
+ * @public
2034
2277
  * <p>A list of service summary information records. In a paginated request, the request returns up to <code>MaxResults</code> records for each call.</p>
2035
2278
  */
2036
2279
  ServiceSummaryList: ServiceSummary[] | undefined;
2037
2280
  /**
2281
+ * @public
2038
2282
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
2039
2283
  */
2040
2284
  NextToken?: string;
@@ -2044,6 +2288,7 @@ export interface ListServicesResponse {
2044
2288
  */
2045
2289
  export interface ListTagsForResourceRequest {
2046
2290
  /**
2291
+ * @public
2047
2292
  * <p>The Amazon Resource Name (ARN) of the resource that a tag list is requested for.</p>
2048
2293
  * <p>It must be the ARN of an App Runner resource.</p>
2049
2294
  */
@@ -2054,6 +2299,7 @@ export interface ListTagsForResourceRequest {
2054
2299
  */
2055
2300
  export interface ListTagsForResourceResponse {
2056
2301
  /**
2302
+ * @public
2057
2303
  * <p>A list of the tag key-value pairs that are associated with the resource.</p>
2058
2304
  */
2059
2305
  Tags?: Tag[];
@@ -2063,11 +2309,13 @@ export interface ListTagsForResourceResponse {
2063
2309
  */
2064
2310
  export interface ListVpcConnectorsRequest {
2065
2311
  /**
2312
+ * @public
2066
2313
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
2067
2314
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
2068
2315
  */
2069
2316
  MaxResults?: number;
2070
2317
  /**
2318
+ * @public
2071
2319
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
2072
2320
  * identical to the ones that are specified in the initial request.</p>
2073
2321
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
@@ -2079,11 +2327,13 @@ export interface ListVpcConnectorsRequest {
2079
2327
  */
2080
2328
  export interface ListVpcConnectorsResponse {
2081
2329
  /**
2330
+ * @public
2082
2331
  * <p>A list of information records for VPC connectors. In a paginated request, the request returns up to <code>MaxResults</code> records for each
2083
2332
  * call.</p>
2084
2333
  */
2085
2334
  VpcConnectors: VpcConnector[] | undefined;
2086
2335
  /**
2336
+ * @public
2087
2337
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
2088
2338
  */
2089
2339
  NextToken?: string;
@@ -2094,11 +2344,13 @@ export interface ListVpcConnectorsResponse {
2094
2344
  */
2095
2345
  export interface ListVpcIngressConnectionsFilter {
2096
2346
  /**
2347
+ * @public
2097
2348
  * <p>The Amazon Resource Name (ARN) of a service to filter by.
2098
2349
  * </p>
2099
2350
  */
2100
2351
  ServiceArn?: string;
2101
2352
  /**
2353
+ * @public
2102
2354
  * <p>The ID of a VPC Endpoint to filter by.
2103
2355
  * </p>
2104
2356
  */
@@ -2109,15 +2361,18 @@ export interface ListVpcIngressConnectionsFilter {
2109
2361
  */
2110
2362
  export interface ListVpcIngressConnectionsRequest {
2111
2363
  /**
2364
+ * @public
2112
2365
  * <p>The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.</p>
2113
2366
  */
2114
2367
  Filter?: ListVpcIngressConnectionsFilter;
2115
2368
  /**
2369
+ * @public
2116
2370
  * <p>The maximum number of results to include in each response (result page). It's used for a paginated request.</p>
2117
2371
  * <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p>
2118
2372
  */
2119
2373
  MaxResults?: number;
2120
2374
  /**
2375
+ * @public
2121
2376
  * <p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be
2122
2377
  * identical to the ones that are specified in the initial request.</p>
2123
2378
  * <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p>
@@ -2130,11 +2385,13 @@ export interface ListVpcIngressConnectionsRequest {
2130
2385
  */
2131
2386
  export interface VpcIngressConnectionSummary {
2132
2387
  /**
2388
+ * @public
2133
2389
  * <p>The Amazon Resource Name (ARN) of the VPC Ingress Connection.
2134
2390
  * </p>
2135
2391
  */
2136
2392
  VpcIngressConnectionArn?: string;
2137
2393
  /**
2394
+ * @public
2138
2395
  * <p>The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
2139
2396
  * </p>
2140
2397
  */
@@ -2145,10 +2402,12 @@ export interface VpcIngressConnectionSummary {
2145
2402
  */
2146
2403
  export interface ListVpcIngressConnectionsResponse {
2147
2404
  /**
2405
+ * @public
2148
2406
  * <p>A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to <code>MaxResults</code> records for each call.</p>
2149
2407
  */
2150
2408
  VpcIngressConnectionSummaryList: VpcIngressConnectionSummary[] | undefined;
2151
2409
  /**
2410
+ * @public
2152
2411
  * <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
2153
2412
  */
2154
2413
  NextToken?: string;
@@ -2158,6 +2417,7 @@ export interface ListVpcIngressConnectionsResponse {
2158
2417
  */
2159
2418
  export interface PauseServiceRequest {
2160
2419
  /**
2420
+ * @public
2161
2421
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to pause.</p>
2162
2422
  */
2163
2423
  ServiceArn: string | undefined;
@@ -2167,10 +2427,12 @@ export interface PauseServiceRequest {
2167
2427
  */
2168
2428
  export interface PauseServiceResponse {
2169
2429
  /**
2430
+ * @public
2170
2431
  * <p>A description of the App Runner service that this request just paused.</p>
2171
2432
  */
2172
2433
  Service: Service | undefined;
2173
2434
  /**
2435
+ * @public
2174
2436
  * <p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a>ListOperations</a> call to track
2175
2437
  * the operation's progress.</p>
2176
2438
  */
@@ -2181,6 +2443,7 @@ export interface PauseServiceResponse {
2181
2443
  */
2182
2444
  export interface ResumeServiceRequest {
2183
2445
  /**
2446
+ * @public
2184
2447
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to resume.</p>
2185
2448
  */
2186
2449
  ServiceArn: string | undefined;
@@ -2190,10 +2453,12 @@ export interface ResumeServiceRequest {
2190
2453
  */
2191
2454
  export interface ResumeServiceResponse {
2192
2455
  /**
2456
+ * @public
2193
2457
  * <p>A description of the App Runner service that this request just resumed.</p>
2194
2458
  */
2195
2459
  Service: Service | undefined;
2196
2460
  /**
2461
+ * @public
2197
2462
  * <p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a>ListOperations</a> call to track
2198
2463
  * the operation's progress.</p>
2199
2464
  */
@@ -2204,6 +2469,7 @@ export interface ResumeServiceResponse {
2204
2469
  */
2205
2470
  export interface StartDeploymentRequest {
2206
2471
  /**
2472
+ * @public
2207
2473
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.</p>
2208
2474
  */
2209
2475
  ServiceArn: string | undefined;
@@ -2213,6 +2479,7 @@ export interface StartDeploymentRequest {
2213
2479
  */
2214
2480
  export interface StartDeploymentResponse {
2215
2481
  /**
2482
+ * @public
2216
2483
  * <p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a>ListOperations</a> call to track
2217
2484
  * the operation's progress.</p>
2218
2485
  */
@@ -2223,11 +2490,13 @@ export interface StartDeploymentResponse {
2223
2490
  */
2224
2491
  export interface TagResourceRequest {
2225
2492
  /**
2493
+ * @public
2226
2494
  * <p>The Amazon Resource Name (ARN) of the resource that you want to update tags for.</p>
2227
2495
  * <p>It must be the ARN of an App Runner resource.</p>
2228
2496
  */
2229
2497
  ResourceArn: string | undefined;
2230
2498
  /**
2499
+ * @public
2231
2500
  * <p>A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already
2232
2501
  * associated with the resource, the value of the tag is updated.</p>
2233
2502
  */
@@ -2243,11 +2512,13 @@ export interface TagResourceResponse {
2243
2512
  */
2244
2513
  export interface UntagResourceRequest {
2245
2514
  /**
2515
+ * @public
2246
2516
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
2247
2517
  * <p>It must be the ARN of an App Runner resource.</p>
2248
2518
  */
2249
2519
  ResourceArn: string | undefined;
2250
2520
  /**
2521
+ * @public
2251
2522
  * <p>A list of tag keys that you want to remove.</p>
2252
2523
  */
2253
2524
  TagKeys: string[] | undefined;
@@ -2262,10 +2533,12 @@ export interface UntagResourceResponse {
2262
2533
  */
2263
2534
  export interface UpdateServiceRequest {
2264
2535
  /**
2536
+ * @public
2265
2537
  * <p>The Amazon Resource Name (ARN) of the App Runner service that you want to update.</p>
2266
2538
  */
2267
2539
  ServiceArn: string | undefined;
2268
2540
  /**
2541
+ * @public
2269
2542
  * <p>The source configuration to apply to the App Runner service.</p>
2270
2543
  * <p>You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way
2271
2544
  * around. This means that you must provide the same structure member of <code>SourceConfiguration</code> that you originally included when you created the
@@ -2274,22 +2547,27 @@ export interface UpdateServiceRequest {
2274
2547
  */
2275
2548
  SourceConfiguration?: SourceConfiguration;
2276
2549
  /**
2550
+ * @public
2277
2551
  * <p>The runtime configuration to apply to instances (scaling units) of your service.</p>
2278
2552
  */
2279
2553
  InstanceConfiguration?: InstanceConfiguration;
2280
2554
  /**
2555
+ * @public
2281
2556
  * <p>The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.</p>
2282
2557
  */
2283
2558
  AutoScalingConfigurationArn?: string;
2284
2559
  /**
2560
+ * @public
2285
2561
  * <p>The settings for the health check that App Runner performs to monitor the health of the App Runner service.</p>
2286
2562
  */
2287
2563
  HealthCheckConfiguration?: HealthCheckConfiguration;
2288
2564
  /**
2565
+ * @public
2289
2566
  * <p>Configuration settings related to network traffic of the web application that the App Runner service runs.</p>
2290
2567
  */
2291
2568
  NetworkConfiguration?: NetworkConfiguration;
2292
2569
  /**
2570
+ * @public
2293
2571
  * <p>The observability configuration of your service.</p>
2294
2572
  */
2295
2573
  ObservabilityConfiguration?: ServiceObservabilityConfiguration;
@@ -2299,11 +2577,13 @@ export interface UpdateServiceRequest {
2299
2577
  */
2300
2578
  export interface UpdateServiceResponse {
2301
2579
  /**
2580
+ * @public
2302
2581
  * <p>A description of the App Runner service updated by this request. All configuration values in the returned <code>Service</code> structure reflect
2303
2582
  * configuration changes that are being applied by this request.</p>
2304
2583
  */
2305
2584
  Service: Service | undefined;
2306
2585
  /**
2586
+ * @public
2307
2587
  * <p>The unique ID of the asynchronous operation that this request started. You can use it combined with the <a>ListOperations</a> call to track
2308
2588
  * the operation's progress.</p>
2309
2589
  */
@@ -2314,10 +2594,12 @@ export interface UpdateServiceResponse {
2314
2594
  */
2315
2595
  export interface UpdateVpcIngressConnectionRequest {
2316
2596
  /**
2597
+ * @public
2317
2598
  * <p>The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.</p>
2318
2599
  */
2319
2600
  VpcIngressConnectionArn: string | undefined;
2320
2601
  /**
2602
+ * @public
2321
2603
  * <p>Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection
2322
2604
  * resource.</p>
2323
2605
  */
@@ -2328,6 +2610,7 @@ export interface UpdateVpcIngressConnectionRequest {
2328
2610
  */
2329
2611
  export interface UpdateVpcIngressConnectionResponse {
2330
2612
  /**
2613
+ * @public
2331
2614
  * <p>A description of the App Runner VPC Ingress Connection resource that's updated by this request.</p>
2332
2615
  */
2333
2616
  VpcIngressConnection: VpcIngressConnection | undefined;