@aws-sdk/client-lightsail 3.379.1 → 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.
@@ -4,10 +4,12 @@ import { AccessDirection, AccessRules, AddOn, AlarmState, AvailabilityZone, Buck
4
4
  */
5
5
  export interface GetCostEstimateRequest {
6
6
  /**
7
+ * @public
7
8
  * <p>The resource name.</p>
8
9
  */
9
10
  resourceName: string | undefined;
10
11
  /**
12
+ * @public
11
13
  * <p>The cost estimate start time.</p>
12
14
  * <p>Constraints:</p>
13
15
  * <ul>
@@ -24,6 +26,7 @@ export interface GetCostEstimateRequest {
24
26
  */
25
27
  startTime: Date | undefined;
26
28
  /**
29
+ * @public
27
30
  * <p>The cost estimate end time.</p>
28
31
  * <p>Constraints:</p>
29
32
  * <ul>
@@ -46,22 +49,27 @@ export interface GetCostEstimateRequest {
46
49
  */
47
50
  export interface ResourceBudgetEstimate {
48
51
  /**
52
+ * @public
49
53
  * <p>The resource name.</p>
50
54
  */
51
55
  resourceName?: string;
52
56
  /**
57
+ * @public
53
58
  * <p>The type of resource the budget will track.</p>
54
59
  */
55
60
  resourceType?: ResourceType | string;
56
61
  /**
62
+ * @public
57
63
  * <p>The cost estimate for the specified budget.</p>
58
64
  */
59
65
  costEstimates?: CostEstimate[];
60
66
  /**
67
+ * @public
61
68
  * <p>The estimate start time.</p>
62
69
  */
63
70
  startTime?: Date;
64
71
  /**
72
+ * @public
65
73
  * <p>The estimate end time.</p>
66
74
  */
67
75
  endTime?: Date;
@@ -71,6 +79,7 @@ export interface ResourceBudgetEstimate {
71
79
  */
72
80
  export interface GetCostEstimateResult {
73
81
  /**
82
+ * @public
74
83
  * <p>Returns the estimate's forecasted cost or usage.</p>
75
84
  */
76
85
  resourcesBudgetEstimate?: ResourceBudgetEstimate[];
@@ -80,6 +89,7 @@ export interface GetCostEstimateResult {
80
89
  */
81
90
  export interface GetDiskRequest {
82
91
  /**
92
+ * @public
83
93
  * <p>The name of the disk (e.g., <code>my-disk</code>).</p>
84
94
  */
85
95
  diskName: string | undefined;
@@ -89,6 +99,7 @@ export interface GetDiskRequest {
89
99
  */
90
100
  export interface GetDiskResult {
91
101
  /**
102
+ * @public
92
103
  * <p>An object containing information about the disk.</p>
93
104
  */
94
105
  disk?: Disk;
@@ -98,6 +109,7 @@ export interface GetDiskResult {
98
109
  */
99
110
  export interface GetDisksRequest {
100
111
  /**
112
+ * @public
101
113
  * <p>The token to advance to the next page of results from your request.</p>
102
114
  * <p>To get a page token, perform an initial <code>GetDisks</code> request. If your results are
103
115
  * paginated, the response will return a next page token that you can specify as the page token
@@ -110,10 +122,12 @@ export interface GetDisksRequest {
110
122
  */
111
123
  export interface GetDisksResult {
112
124
  /**
125
+ * @public
113
126
  * <p>An array of objects containing information about all block storage disks.</p>
114
127
  */
115
128
  disks?: Disk[];
116
129
  /**
130
+ * @public
117
131
  * <p>The token to advance to the next page of results from your request.</p>
118
132
  * <p>A next page token is not returned if there are no more results to display.</p>
119
133
  * <p>To get the next page of results, perform another <code>GetDisks</code> request and specify
@@ -126,6 +140,7 @@ export interface GetDisksResult {
126
140
  */
127
141
  export interface GetDiskSnapshotRequest {
128
142
  /**
143
+ * @public
129
144
  * <p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>
130
145
  */
131
146
  diskSnapshotName: string | undefined;
@@ -135,6 +150,7 @@ export interface GetDiskSnapshotRequest {
135
150
  */
136
151
  export interface GetDiskSnapshotResult {
137
152
  /**
153
+ * @public
138
154
  * <p>An object containing information about the disk snapshot.</p>
139
155
  */
140
156
  diskSnapshot?: DiskSnapshot;
@@ -144,6 +160,7 @@ export interface GetDiskSnapshotResult {
144
160
  */
145
161
  export interface GetDiskSnapshotsRequest {
146
162
  /**
163
+ * @public
147
164
  * <p>The token to advance to the next page of results from your request.</p>
148
165
  * <p>To get a page token, perform an initial <code>GetDiskSnapshots</code> request. If your
149
166
  * results are paginated, the response will return a next page token that you can specify as the
@@ -156,10 +173,12 @@ export interface GetDiskSnapshotsRequest {
156
173
  */
157
174
  export interface GetDiskSnapshotsResult {
158
175
  /**
176
+ * @public
159
177
  * <p>An array of objects containing information about all block storage disk snapshots.</p>
160
178
  */
161
179
  diskSnapshots?: DiskSnapshot[];
162
180
  /**
181
+ * @public
163
182
  * <p>The token to advance to the next page of results from your request.</p>
164
183
  * <p>A next page token is not returned if there are no more results to display.</p>
165
184
  * <p>To get the next page of results, perform another <code>GetDiskSnapshots</code> request and
@@ -177,6 +196,7 @@ export interface GetDistributionBundlesRequest {
177
196
  */
178
197
  export interface GetDistributionBundlesResult {
179
198
  /**
199
+ * @public
180
200
  * <p>An object that describes a distribution bundle.</p>
181
201
  */
182
202
  bundles?: DistributionBundle[];
@@ -186,6 +206,7 @@ export interface GetDistributionBundlesResult {
186
206
  */
187
207
  export interface GetDistributionLatestCacheResetRequest {
188
208
  /**
209
+ * @public
189
210
  * <p>The name of the distribution for which to return the timestamp of the last cache
190
211
  * reset.</p>
191
212
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
@@ -200,10 +221,12 @@ export interface GetDistributionLatestCacheResetRequest {
200
221
  */
201
222
  export interface GetDistributionLatestCacheResetResult {
202
223
  /**
224
+ * @public
203
225
  * <p>The status of the last cache reset.</p>
204
226
  */
205
227
  status?: string;
206
228
  /**
229
+ * @public
207
230
  * <p>The timestamp of the last cache reset (e.g., <code>1479734909.17</code>) in Unix time
208
231
  * format.</p>
209
232
  */
@@ -214,12 +237,14 @@ export interface GetDistributionLatestCacheResetResult {
214
237
  */
215
238
  export interface GetDistributionMetricDataRequest {
216
239
  /**
240
+ * @public
217
241
  * <p>The name of the distribution for which to get metric data.</p>
218
242
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
219
243
  * can specify.</p>
220
244
  */
221
245
  distributionName: string | undefined;
222
246
  /**
247
+ * @public
223
248
  * <p>The metric for which you want to return information.</p>
224
249
  * <p>Valid distribution metric names are listed below, along with the most useful
225
250
  * <code>statistics</code> to include in your request, and the published <code>unit</code>
@@ -301,6 +326,7 @@ export interface GetDistributionMetricDataRequest {
301
326
  */
302
327
  metricName: DistributionMetricName | string | undefined;
303
328
  /**
329
+ * @public
304
330
  * <p>The start of the time interval for which to get metric data.</p>
305
331
  * <p>Constraints:</p>
306
332
  * <ul>
@@ -317,6 +343,7 @@ export interface GetDistributionMetricDataRequest {
317
343
  */
318
344
  startTime: Date | undefined;
319
345
  /**
346
+ * @public
320
347
  * <p>The end of the time interval for which to get metric data.</p>
321
348
  * <p>Constraints:</p>
322
349
  * <ul>
@@ -333,16 +360,19 @@ export interface GetDistributionMetricDataRequest {
333
360
  */
334
361
  endTime: Date | undefined;
335
362
  /**
363
+ * @public
336
364
  * <p>The granularity, in seconds, for the metric data points that will be returned.</p>
337
365
  */
338
366
  period: number | undefined;
339
367
  /**
368
+ * @public
340
369
  * <p>The unit for the metric data request.</p>
341
370
  * <p>Valid units depend on the metric data being requested. For the valid units with each
342
371
  * available metric, see the <code>metricName</code> parameter.</p>
343
372
  */
344
373
  unit: MetricUnit | string | undefined;
345
374
  /**
375
+ * @public
346
376
  * <p>The statistic for the metric.</p>
347
377
  * <p>The following statistics are available:</p>
348
378
  * <ul>
@@ -382,10 +412,12 @@ export interface GetDistributionMetricDataRequest {
382
412
  */
383
413
  export interface GetDistributionMetricDataResult {
384
414
  /**
415
+ * @public
385
416
  * <p>The name of the metric returned.</p>
386
417
  */
387
418
  metricName?: DistributionMetricName | string;
388
419
  /**
420
+ * @public
389
421
  * <p>An array of objects that describe the metric data returned.</p>
390
422
  */
391
423
  metricData?: MetricDatapoint[];
@@ -395,12 +427,14 @@ export interface GetDistributionMetricDataResult {
395
427
  */
396
428
  export interface GetDistributionsRequest {
397
429
  /**
430
+ * @public
398
431
  * <p>The name of the distribution for which to return information.</p>
399
432
  * <p>When omitted, the response includes all of your distributions in the Amazon Web Services
400
433
  * Region where the request is made.</p>
401
434
  */
402
435
  distributionName?: string;
403
436
  /**
437
+ * @public
404
438
  * <p>The token to advance to the next page of results from your request.</p>
405
439
  * <p>To get a page token, perform an initial <code>GetDistributions</code> request. If your
406
440
  * results are paginated, the response will return a next page token that you can specify as the
@@ -413,10 +447,12 @@ export interface GetDistributionsRequest {
413
447
  */
414
448
  export interface GetDistributionsResult {
415
449
  /**
450
+ * @public
416
451
  * <p>An array of objects that describe your distributions.</p>
417
452
  */
418
453
  distributions?: LightsailDistribution[];
419
454
  /**
455
+ * @public
420
456
  * <p>The token to advance to the next page of results from your request.</p>
421
457
  * <p>A next page token is not returned if there are no more results to display.</p>
422
458
  * <p>To get the next page of results, perform another <code>GetDistributions</code> request and
@@ -429,6 +465,7 @@ export interface GetDistributionsResult {
429
465
  */
430
466
  export interface GetDomainRequest {
431
467
  /**
468
+ * @public
432
469
  * <p>The domain name for which your want to return information about.</p>
433
470
  */
434
471
  domainName: string | undefined;
@@ -438,6 +475,7 @@ export interface GetDomainRequest {
438
475
  */
439
476
  export interface GetDomainResult {
440
477
  /**
478
+ * @public
441
479
  * <p>An array of key-value pairs containing information about your get domain request.</p>
442
480
  */
443
481
  domain?: Domain;
@@ -447,6 +485,7 @@ export interface GetDomainResult {
447
485
  */
448
486
  export interface GetDomainsRequest {
449
487
  /**
488
+ * @public
450
489
  * <p>The token to advance to the next page of results from your request.</p>
451
490
  * <p>To get a page token, perform an initial <code>GetDomains</code> request. If your results
452
491
  * are paginated, the response will return a next page token that you can specify as the page
@@ -459,11 +498,13 @@ export interface GetDomainsRequest {
459
498
  */
460
499
  export interface GetDomainsResult {
461
500
  /**
501
+ * @public
462
502
  * <p>An array of key-value pairs containing information about each of the domain entries in the
463
503
  * user's account.</p>
464
504
  */
465
505
  domains?: Domain[];
466
506
  /**
507
+ * @public
467
508
  * <p>The token to advance to the next page of results from your request.</p>
468
509
  * <p>A next page token is not returned if there are no more results to display.</p>
469
510
  * <p>To get the next page of results, perform another <code>GetDomains</code> request and
@@ -476,6 +517,7 @@ export interface GetDomainsResult {
476
517
  */
477
518
  export interface GetExportSnapshotRecordsRequest {
478
519
  /**
520
+ * @public
479
521
  * <p>The token to advance to the next page of results from your request.</p>
480
522
  * <p>To get a page token, perform an initial <code>GetExportSnapshotRecords</code> request. If
481
523
  * your results are paginated, the response will return a next page token that you can specify as
@@ -488,10 +530,12 @@ export interface GetExportSnapshotRecordsRequest {
488
530
  */
489
531
  export interface GetExportSnapshotRecordsResult {
490
532
  /**
533
+ * @public
491
534
  * <p>A list of objects describing the export snapshot records.</p>
492
535
  */
493
536
  exportSnapshotRecords?: ExportSnapshotRecord[];
494
537
  /**
538
+ * @public
495
539
  * <p>The token to advance to the next page of results from your request.</p>
496
540
  * <p>A next page token is not returned if there are no more results to display.</p>
497
541
  * <p>To get the next page of results, perform another <code>GetExportSnapshotRecords</code>
@@ -504,6 +548,7 @@ export interface GetExportSnapshotRecordsResult {
504
548
  */
505
549
  export interface GetInstanceRequest {
506
550
  /**
551
+ * @public
507
552
  * <p>The name of the instance.</p>
508
553
  */
509
554
  instanceName: string | undefined;
@@ -514,14 +559,17 @@ export interface GetInstanceRequest {
514
559
  */
515
560
  export interface InstanceHardware {
516
561
  /**
562
+ * @public
517
563
  * <p>The number of vCPUs the instance has.</p>
518
564
  */
519
565
  cpuCount?: number;
520
566
  /**
567
+ * @public
521
568
  * <p>The disks attached to the instance.</p>
522
569
  */
523
570
  disks?: Disk[];
524
571
  /**
572
+ * @public
525
573
  * <p>The amount of RAM in GB on the instance (e.g., <code>1.0</code>).</p>
526
574
  */
527
575
  ramSizeInGb?: number;
@@ -580,6 +628,7 @@ export type InstanceMetadataState = (typeof InstanceMetadataState)[keyof typeof
580
628
  */
581
629
  export interface InstanceMetadataOptions {
582
630
  /**
631
+ * @public
583
632
  * <p>The state of the metadata option changes.</p>
584
633
  * <p>The following states are possible:</p>
585
634
  * <ul>
@@ -597,6 +646,7 @@ export interface InstanceMetadataOptions {
597
646
  */
598
647
  state?: InstanceMetadataState | string;
599
648
  /**
649
+ * @public
600
650
  * <p>The state of token usage for your instance metadata requests.</p>
601
651
  * <p>If the state is <code>optional</code>, you can choose whether to retrieve instance
602
652
  * metadata with a signed token header on your request. If you retrieve the IAM role credentials
@@ -615,17 +665,20 @@ export interface InstanceMetadataOptions {
615
665
  */
616
666
  httpTokens?: HttpTokens | string;
617
667
  /**
668
+ * @public
618
669
  * <p>Indicates whether the HTTP metadata endpoint on your instances is enabled or
619
670
  * disabled.</p>
620
671
  * <p>If the value is <code>disabled</code>, you cannot access your instance metadata.</p>
621
672
  */
622
673
  httpEndpoint?: HttpEndpoint | string;
623
674
  /**
675
+ * @public
624
676
  * <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number
625
677
  * means that the instance metadata requests can travel farther.</p>
626
678
  */
627
679
  httpPutResponseHopLimit?: number;
628
680
  /**
681
+ * @public
629
682
  * <p>Indicates whether the IPv6 endpoint for the instance metadata service is enabled or
630
683
  * disabled.</p>
631
684
  */
@@ -638,6 +691,7 @@ export interface InstanceMetadataOptions {
638
691
  */
639
692
  export interface MonthlyTransfer {
640
693
  /**
694
+ * @public
641
695
  * <p>The amount allocated per month (in GB).</p>
642
696
  */
643
697
  gbPerMonthAllocated?: number;
@@ -660,6 +714,7 @@ export type PortAccessType = (typeof PortAccessType)[keyof typeof PortAccessType
660
714
  */
661
715
  export interface InstancePortInfo {
662
716
  /**
717
+ * @public
663
718
  * <p>The first port in a range of open ports on an instance.</p>
664
719
  * <p>Allowed ports:</p>
665
720
  * <ul>
@@ -682,6 +737,7 @@ export interface InstancePortInfo {
682
737
  */
683
738
  fromPort?: number;
684
739
  /**
740
+ * @public
685
741
  * <p>The last port in a range of open ports on an instance.</p>
686
742
  * <p>Allowed ports:</p>
687
743
  * <ul>
@@ -704,6 +760,7 @@ export interface InstancePortInfo {
704
760
  */
705
761
  toPort?: number;
706
762
  /**
763
+ * @public
707
764
  * <p>The IP protocol name.</p>
708
765
  * <p>The name can be one of the following:</p>
709
766
  * <ul>
@@ -742,19 +799,23 @@ export interface InstancePortInfo {
742
799
  */
743
800
  protocol?: NetworkProtocol | string;
744
801
  /**
802
+ * @public
745
803
  * <p>The location from which access is allowed. For example, <code>Anywhere (0.0.0.0/0)</code>,
746
804
  * or <code>Custom</code> if a specific IP address or range of IP addresses is allowed.</p>
747
805
  */
748
806
  accessFrom?: string;
749
807
  /**
808
+ * @public
750
809
  * <p>The type of access (<code>Public</code> or <code>Private</code>).</p>
751
810
  */
752
811
  accessType?: PortAccessType | string;
753
812
  /**
813
+ * @public
754
814
  * <p>The common name of the port information.</p>
755
815
  */
756
816
  commonName?: string;
757
817
  /**
818
+ * @public
758
819
  * <p>The access direction (<code>inbound</code> or <code>outbound</code>).</p>
759
820
  * <note>
760
821
  * <p>Lightsail currently supports only <code>inbound</code> access direction.</p>
@@ -762,6 +823,7 @@ export interface InstancePortInfo {
762
823
  */
763
824
  accessDirection?: AccessDirection | string;
764
825
  /**
826
+ * @public
765
827
  * <p>The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to
766
828
  * connect to an instance through the ports, and the protocol.</p>
767
829
  * <note>
@@ -773,6 +835,7 @@ export interface InstancePortInfo {
773
835
  */
774
836
  cidrs?: string[];
775
837
  /**
838
+ * @public
776
839
  * <p>The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to
777
840
  * connect to an instance through the ports, and the protocol. Only devices with an IPv6 address
778
841
  * can connect to an instance through IPv6; otherwise, IPv4 should be used.</p>
@@ -785,6 +848,7 @@ export interface InstancePortInfo {
785
848
  */
786
849
  ipv6Cidrs?: string[];
787
850
  /**
851
+ * @public
788
852
  * <p>An alias that defines access for a preconfigured range of IP addresses.</p>
789
853
  * <p>The only alias currently supported is <code>lightsail-connect</code>, which allows IP
790
854
  * addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
@@ -798,10 +862,12 @@ export interface InstancePortInfo {
798
862
  */
799
863
  export interface InstanceNetworking {
800
864
  /**
865
+ * @public
801
866
  * <p>The amount of data in GB allocated for monthly data transfers.</p>
802
867
  */
803
868
  monthlyTransfer?: MonthlyTransfer;
804
869
  /**
870
+ * @public
805
871
  * <p>An array of key-value pairs containing information about the ports on the instance.</p>
806
872
  */
807
873
  ports?: InstancePortInfo[];
@@ -812,10 +878,12 @@ export interface InstanceNetworking {
812
878
  */
813
879
  export interface InstanceState {
814
880
  /**
881
+ * @public
815
882
  * <p>The status code for the instance.</p>
816
883
  */
817
884
  code?: number;
818
885
  /**
886
+ * @public
819
887
  * <p>The state of the instance (e.g., <code>running</code> or <code>pending</code>).</p>
820
888
  */
821
889
  name?: string;
@@ -826,99 +894,121 @@ export interface InstanceState {
826
894
  */
827
895
  export interface Instance {
828
896
  /**
897
+ * @public
829
898
  * <p>The name the user gave the instance (e.g., <code>Amazon_Linux-1GB-Ohio-1</code>).</p>
830
899
  */
831
900
  name?: string;
832
901
  /**
902
+ * @public
833
903
  * <p>The Amazon Resource Name (ARN) of the instance (e.g.,
834
904
  * <code>arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE</code>).</p>
835
905
  */
836
906
  arn?: string;
837
907
  /**
908
+ * @public
838
909
  * <p>The support code. Include this code in your email to support when you have questions about
839
910
  * an instance or another resource in Lightsail. This code enables our support team to look up
840
911
  * your Lightsail information more easily.</p>
841
912
  */
842
913
  supportCode?: string;
843
914
  /**
915
+ * @public
844
916
  * <p>The timestamp when the instance was created (e.g., <code>1479734909.17</code>) in Unix
845
917
  * time format.</p>
846
918
  */
847
919
  createdAt?: Date;
848
920
  /**
921
+ * @public
849
922
  * <p>The region name and Availability Zone where the instance is located.</p>
850
923
  */
851
924
  location?: ResourceLocation;
852
925
  /**
926
+ * @public
853
927
  * <p>The type of resource (usually <code>Instance</code>).</p>
854
928
  */
855
929
  resourceType?: ResourceType | string;
856
930
  /**
931
+ * @public
857
932
  * <p>The tag keys and optional values for the resource. For more information about tags in
858
933
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
859
934
  */
860
935
  tags?: Tag[];
861
936
  /**
937
+ * @public
862
938
  * <p>The blueprint ID (e.g., <code>os_amlinux_2016_03</code>).</p>
863
939
  */
864
940
  blueprintId?: string;
865
941
  /**
942
+ * @public
866
943
  * <p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>
867
944
  */
868
945
  blueprintName?: string;
869
946
  /**
947
+ * @public
870
948
  * <p>The bundle for the instance (e.g., <code>micro_1_0</code>).</p>
871
949
  */
872
950
  bundleId?: string;
873
951
  /**
952
+ * @public
874
953
  * <p>An array of objects representing the add-ons enabled on the instance.</p>
875
954
  */
876
955
  addOns?: AddOn[];
877
956
  /**
957
+ * @public
878
958
  * <p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>
879
959
  */
880
960
  isStaticIp?: boolean;
881
961
  /**
962
+ * @public
882
963
  * <p>The private IP address of the instance.</p>
883
964
  */
884
965
  privateIpAddress?: string;
885
966
  /**
967
+ * @public
886
968
  * <p>The public IP address of the instance.</p>
887
969
  */
888
970
  publicIpAddress?: string;
889
971
  /**
972
+ * @public
890
973
  * <p>The IPv6 addresses of the instance.</p>
891
974
  */
892
975
  ipv6Addresses?: string[];
893
976
  /**
977
+ * @public
894
978
  * <p>The IP address type of the instance.</p>
895
979
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
896
980
  * IPv4 and IPv6.</p>
897
981
  */
898
982
  ipAddressType?: IpAddressType | string;
899
983
  /**
984
+ * @public
900
985
  * <p>The size of the vCPU and the amount of RAM for the instance.</p>
901
986
  */
902
987
  hardware?: InstanceHardware;
903
988
  /**
989
+ * @public
904
990
  * <p>Information about the public ports and monthly data transfer rates for the
905
991
  * instance.</p>
906
992
  */
907
993
  networking?: InstanceNetworking;
908
994
  /**
995
+ * @public
909
996
  * <p>The status code and the state (e.g., <code>running</code>) for the instance.</p>
910
997
  */
911
998
  state?: InstanceState;
912
999
  /**
1000
+ * @public
913
1001
  * <p>The user name for connecting to the instance (e.g., <code>ec2-user</code>).</p>
914
1002
  */
915
1003
  username?: string;
916
1004
  /**
1005
+ * @public
917
1006
  * <p>The name of the SSH key being used to connect to the instance (e.g.,
918
1007
  * <code>LightsailDefaultKeyPair</code>).</p>
919
1008
  */
920
1009
  sshKeyName?: string;
921
1010
  /**
1011
+ * @public
922
1012
  * <p>The metadata options for the Amazon Lightsail instance.</p>
923
1013
  */
924
1014
  metadataOptions?: InstanceMetadataOptions;
@@ -928,6 +1018,7 @@ export interface Instance {
928
1018
  */
929
1019
  export interface GetInstanceResult {
930
1020
  /**
1021
+ * @public
931
1022
  * <p>An array of key-value pairs containing information about the specified instance.</p>
932
1023
  */
933
1024
  instance?: Instance;
@@ -949,10 +1040,12 @@ export type InstanceAccessProtocol = (typeof InstanceAccessProtocol)[keyof typeo
949
1040
  */
950
1041
  export interface GetInstanceAccessDetailsRequest {
951
1042
  /**
1043
+ * @public
952
1044
  * <p>The name of the instance to access.</p>
953
1045
  */
954
1046
  instanceName: string | undefined;
955
1047
  /**
1048
+ * @public
956
1049
  * <p>The protocol to use to connect to your instance. Defaults to <code>ssh</code>.</p>
957
1050
  */
958
1051
  protocol?: InstanceAccessProtocol | string;
@@ -963,6 +1056,7 @@ export interface GetInstanceAccessDetailsRequest {
963
1056
  */
964
1057
  export interface HostKeyAttributes {
965
1058
  /**
1059
+ * @public
966
1060
  * <p>The SSH host key algorithm or the RDP certificate format.</p>
967
1061
  * <p>For SSH host keys, the algorithm may be <code>ssh-rsa</code>,
968
1062
  * <code>ecdsa-sha2-nistp256</code>, <code>ssh-ed25519</code>, etc. For RDP certificates, the
@@ -970,14 +1064,17 @@ export interface HostKeyAttributes {
970
1064
  */
971
1065
  algorithm?: string;
972
1066
  /**
1067
+ * @public
973
1068
  * <p>The public SSH host key or the RDP certificate.</p>
974
1069
  */
975
1070
  publicKey?: string;
976
1071
  /**
1072
+ * @public
977
1073
  * <p>The time that the SSH host key or RDP certificate was recorded by Lightsail.</p>
978
1074
  */
979
1075
  witnessedAt?: Date;
980
1076
  /**
1077
+ * @public
981
1078
  * <p>The SHA-1 fingerprint of the returned SSH host key or RDP certificate.</p>
982
1079
  * <ul>
983
1080
  * <li>
@@ -996,6 +1093,7 @@ export interface HostKeyAttributes {
996
1093
  */
997
1094
  fingerprintSHA1?: string;
998
1095
  /**
1096
+ * @public
999
1097
  * <p>The SHA-256 fingerprint of the returned SSH host key or RDP certificate.</p>
1000
1098
  * <ul>
1001
1099
  * <li>
@@ -1014,11 +1112,13 @@ export interface HostKeyAttributes {
1014
1112
  */
1015
1113
  fingerprintSHA256?: string;
1016
1114
  /**
1115
+ * @public
1017
1116
  * <p>The returned RDP certificate is valid after this point in time.</p>
1018
1117
  * <p>This value is listed only for RDP certificates.</p>
1019
1118
  */
1020
1119
  notValidBefore?: Date;
1021
1120
  /**
1121
+ * @public
1022
1122
  * <p>The returned RDP certificate is not valid after this point in time.</p>
1023
1123
  * <p>This value is listed only for RDP certificates.</p>
1024
1124
  */
@@ -1031,6 +1131,7 @@ export interface HostKeyAttributes {
1031
1131
  */
1032
1132
  export interface PasswordData {
1033
1133
  /**
1134
+ * @public
1034
1135
  * <p>The encrypted password. Ciphertext will be an empty string if access to your new instance
1035
1136
  * is not ready yet. When you create an instance, it can take up to 15 minutes for the instance
1036
1137
  * to be ready.</p>
@@ -1045,6 +1146,7 @@ export interface PasswordData {
1045
1146
  */
1046
1147
  ciphertext?: string;
1047
1148
  /**
1149
+ * @public
1048
1150
  * <p>The name of the key pair that you used when creating your instance. If no key pair name
1049
1151
  * was specified when creating the instance, Lightsail uses the default key pair
1050
1152
  * (<code>LightsailDefaultKeyPair</code>).</p>
@@ -1061,19 +1163,23 @@ export interface PasswordData {
1061
1163
  */
1062
1164
  export interface InstanceAccessDetails {
1063
1165
  /**
1166
+ * @public
1064
1167
  * <p>For SSH access, the public key to use when accessing your instance For OpenSSH clients
1065
1168
  * (e.g., command line SSH), you should save this value to <code>tempkey-cert.pub</code>.</p>
1066
1169
  */
1067
1170
  certKey?: string;
1068
1171
  /**
1172
+ * @public
1069
1173
  * <p>For SSH access, the date on which the temporary keys expire.</p>
1070
1174
  */
1071
1175
  expiresAt?: Date;
1072
1176
  /**
1177
+ * @public
1073
1178
  * <p>The public IP address of the Amazon Lightsail instance.</p>
1074
1179
  */
1075
1180
  ipAddress?: string;
1076
1181
  /**
1182
+ * @public
1077
1183
  * <p>For RDP access, the password for your Amazon Lightsail instance. Password will be an empty
1078
1184
  * string if the password for your new instance is not ready yet. When you create an instance, it
1079
1185
  * can take up to 15 minutes for the instance to be ready.</p>
@@ -1088,6 +1194,7 @@ export interface InstanceAccessDetails {
1088
1194
  */
1089
1195
  password?: string;
1090
1196
  /**
1197
+ * @public
1091
1198
  * <p>For a Windows Server-based instance, an object with the data you can use to retrieve your
1092
1199
  * password. This is only needed if <code>password</code> is empty and the instance is not new
1093
1200
  * (and therefore the password is not ready yet). When you create an instance, it can take up to
@@ -1095,23 +1202,28 @@ export interface InstanceAccessDetails {
1095
1202
  */
1096
1203
  passwordData?: PasswordData;
1097
1204
  /**
1205
+ * @public
1098
1206
  * <p>For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),
1099
1207
  * you should save this value to <code>tempkey</code>).</p>
1100
1208
  */
1101
1209
  privateKey?: string;
1102
1210
  /**
1211
+ * @public
1103
1212
  * <p>The protocol for these Amazon Lightsail instance access details.</p>
1104
1213
  */
1105
1214
  protocol?: InstanceAccessProtocol | string;
1106
1215
  /**
1216
+ * @public
1107
1217
  * <p>The name of this Amazon Lightsail instance.</p>
1108
1218
  */
1109
1219
  instanceName?: string;
1110
1220
  /**
1221
+ * @public
1111
1222
  * <p>The user name to use when logging in to the Amazon Lightsail instance.</p>
1112
1223
  */
1113
1224
  username?: string;
1114
1225
  /**
1226
+ * @public
1115
1227
  * <p>Describes the public SSH host keys or the RDP certificate.</p>
1116
1228
  */
1117
1229
  hostKeys?: HostKeyAttributes[];
@@ -1121,6 +1233,7 @@ export interface InstanceAccessDetails {
1121
1233
  */
1122
1234
  export interface GetInstanceAccessDetailsResult {
1123
1235
  /**
1236
+ * @public
1124
1237
  * <p>An array of key-value pairs containing information about a get instance access
1125
1238
  * request.</p>
1126
1239
  */
@@ -1150,10 +1263,12 @@ export type InstanceMetricName = (typeof InstanceMetricName)[keyof typeof Instan
1150
1263
  */
1151
1264
  export interface GetInstanceMetricDataRequest {
1152
1265
  /**
1266
+ * @public
1153
1267
  * <p>The name of the instance for which you want to get metrics data.</p>
1154
1268
  */
1155
1269
  instanceName: string | undefined;
1156
1270
  /**
1271
+ * @public
1157
1272
  * <p>The metric for which you want to return information.</p>
1158
1273
  * <p>Valid instance metric names are listed below, along with the most useful
1159
1274
  * <code>statistics</code> to include in your request, and the published <code>unit</code>
@@ -1293,6 +1408,7 @@ export interface GetInstanceMetricDataRequest {
1293
1408
  */
1294
1409
  metricName: InstanceMetricName | string | undefined;
1295
1410
  /**
1411
+ * @public
1296
1412
  * <p>The granularity, in seconds, of the returned data points.</p>
1297
1413
  * <p>The <code>StatusCheckFailed</code>, <code>StatusCheckFailed_Instance</code>, and
1298
1414
  * <code>StatusCheckFailed_System</code> instance metric data is available in 1-minute (60
@@ -1301,20 +1417,24 @@ export interface GetInstanceMetricDataRequest {
1301
1417
  */
1302
1418
  period: number | undefined;
1303
1419
  /**
1420
+ * @public
1304
1421
  * <p>The start time of the time period.</p>
1305
1422
  */
1306
1423
  startTime: Date | undefined;
1307
1424
  /**
1425
+ * @public
1308
1426
  * <p>The end time of the time period.</p>
1309
1427
  */
1310
1428
  endTime: Date | undefined;
1311
1429
  /**
1430
+ * @public
1312
1431
  * <p>The unit for the metric data request. Valid units depend on the metric data being
1313
1432
  * requested. For the valid units to specify with each available metric, see the
1314
1433
  * <code>metricName</code> parameter.</p>
1315
1434
  */
1316
1435
  unit: MetricUnit | string | undefined;
1317
1436
  /**
1437
+ * @public
1318
1438
  * <p>The statistic for the metric.</p>
1319
1439
  * <p>The following statistics are available:</p>
1320
1440
  * <ul>
@@ -1354,10 +1474,12 @@ export interface GetInstanceMetricDataRequest {
1354
1474
  */
1355
1475
  export interface GetInstanceMetricDataResult {
1356
1476
  /**
1477
+ * @public
1357
1478
  * <p>The name of the metric returned.</p>
1358
1479
  */
1359
1480
  metricName?: InstanceMetricName | string;
1360
1481
  /**
1482
+ * @public
1361
1483
  * <p>An array of objects that describe the metric data returned.</p>
1362
1484
  */
1363
1485
  metricData?: MetricDatapoint[];
@@ -1367,6 +1489,7 @@ export interface GetInstanceMetricDataResult {
1367
1489
  */
1368
1490
  export interface GetInstancePortStatesRequest {
1369
1491
  /**
1492
+ * @public
1370
1493
  * <p>The name of the instance for which to return firewall port states.</p>
1371
1494
  */
1372
1495
  instanceName: string | undefined;
@@ -1390,6 +1513,7 @@ export type PortState = (typeof PortState)[keyof typeof PortState];
1390
1513
  */
1391
1514
  export interface InstancePortState {
1392
1515
  /**
1516
+ * @public
1393
1517
  * <p>The first port in a range of open ports on an instance.</p>
1394
1518
  * <p>Allowed ports:</p>
1395
1519
  * <ul>
@@ -1412,6 +1536,7 @@ export interface InstancePortState {
1412
1536
  */
1413
1537
  fromPort?: number;
1414
1538
  /**
1539
+ * @public
1415
1540
  * <p>The last port in a range of open ports on an instance.</p>
1416
1541
  * <p>Allowed ports:</p>
1417
1542
  * <ul>
@@ -1434,6 +1559,7 @@ export interface InstancePortState {
1434
1559
  */
1435
1560
  toPort?: number;
1436
1561
  /**
1562
+ * @public
1437
1563
  * <p>The IP protocol name.</p>
1438
1564
  * <p>The name can be one of the following:</p>
1439
1565
  * <ul>
@@ -1472,6 +1598,7 @@ export interface InstancePortState {
1472
1598
  */
1473
1599
  protocol?: NetworkProtocol | string;
1474
1600
  /**
1601
+ * @public
1475
1602
  * <p>Specifies whether the instance port is <code>open</code> or <code>closed</code>.</p>
1476
1603
  * <note>
1477
1604
  * <p>The port state for Lightsail instances is always <code>open</code>.</p>
@@ -1479,6 +1606,7 @@ export interface InstancePortState {
1479
1606
  */
1480
1607
  state?: PortState | string;
1481
1608
  /**
1609
+ * @public
1482
1610
  * <p>The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to
1483
1611
  * connect to an instance through the ports, and the protocol.</p>
1484
1612
  * <note>
@@ -1490,6 +1618,7 @@ export interface InstancePortState {
1490
1618
  */
1491
1619
  cidrs?: string[];
1492
1620
  /**
1621
+ * @public
1493
1622
  * <p>The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to
1494
1623
  * connect to an instance through the ports, and the protocol. Only devices with an IPv6 address
1495
1624
  * can connect to an instance through IPv6; otherwise, IPv4 should be used.</p>
@@ -1502,6 +1631,7 @@ export interface InstancePortState {
1502
1631
  */
1503
1632
  ipv6Cidrs?: string[];
1504
1633
  /**
1634
+ * @public
1505
1635
  * <p>An alias that defines access for a preconfigured range of IP addresses.</p>
1506
1636
  * <p>The only alias currently supported is <code>lightsail-connect</code>, which allows IP
1507
1637
  * addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
@@ -1514,6 +1644,7 @@ export interface InstancePortState {
1514
1644
  */
1515
1645
  export interface GetInstancePortStatesResult {
1516
1646
  /**
1647
+ * @public
1517
1648
  * <p>An array of objects that describe the firewall port states for the specified
1518
1649
  * instance.</p>
1519
1650
  */
@@ -1524,6 +1655,7 @@ export interface GetInstancePortStatesResult {
1524
1655
  */
1525
1656
  export interface GetInstancesRequest {
1526
1657
  /**
1658
+ * @public
1527
1659
  * <p>The token to advance to the next page of results from your request.</p>
1528
1660
  * <p>To get a page token, perform an initial <code>GetInstances</code> request. If your results
1529
1661
  * are paginated, the response will return a next page token that you can specify as the page
@@ -1536,10 +1668,12 @@ export interface GetInstancesRequest {
1536
1668
  */
1537
1669
  export interface GetInstancesResult {
1538
1670
  /**
1671
+ * @public
1539
1672
  * <p>An array of key-value pairs containing information about your instances.</p>
1540
1673
  */
1541
1674
  instances?: Instance[];
1542
1675
  /**
1676
+ * @public
1543
1677
  * <p>The token to advance to the next page of results from your request.</p>
1544
1678
  * <p>A next page token is not returned if there are no more results to display.</p>
1545
1679
  * <p>To get the next page of results, perform another <code>GetInstances</code> request and
@@ -1552,6 +1686,7 @@ export interface GetInstancesResult {
1552
1686
  */
1553
1687
  export interface GetInstanceSnapshotRequest {
1554
1688
  /**
1689
+ * @public
1555
1690
  * <p>The name of the snapshot for which you are requesting information.</p>
1556
1691
  */
1557
1692
  instanceSnapshotName: string | undefined;
@@ -1575,42 +1710,51 @@ export type InstanceSnapshotState = (typeof InstanceSnapshotState)[keyof typeof
1575
1710
  */
1576
1711
  export interface InstanceSnapshot {
1577
1712
  /**
1713
+ * @public
1578
1714
  * <p>The name of the snapshot.</p>
1579
1715
  */
1580
1716
  name?: string;
1581
1717
  /**
1718
+ * @public
1582
1719
  * <p>The Amazon Resource Name (ARN) of the snapshot (e.g.,
1583
1720
  * <code>arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE</code>).</p>
1584
1721
  */
1585
1722
  arn?: string;
1586
1723
  /**
1724
+ * @public
1587
1725
  * <p>The support code. Include this code in your email to support when you have questions about
1588
1726
  * an instance or another resource in Lightsail. This code enables our support team to look up
1589
1727
  * your Lightsail information more easily.</p>
1590
1728
  */
1591
1729
  supportCode?: string;
1592
1730
  /**
1731
+ * @public
1593
1732
  * <p>The timestamp when the snapshot was created (e.g., <code>1479907467.024</code>).</p>
1594
1733
  */
1595
1734
  createdAt?: Date;
1596
1735
  /**
1736
+ * @public
1597
1737
  * <p>The region name and Availability Zone where you created the snapshot.</p>
1598
1738
  */
1599
1739
  location?: ResourceLocation;
1600
1740
  /**
1741
+ * @public
1601
1742
  * <p>The type of resource (usually <code>InstanceSnapshot</code>).</p>
1602
1743
  */
1603
1744
  resourceType?: ResourceType | string;
1604
1745
  /**
1746
+ * @public
1605
1747
  * <p>The tag keys and optional values for the resource. For more information about tags in
1606
1748
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
1607
1749
  */
1608
1750
  tags?: Tag[];
1609
1751
  /**
1752
+ * @public
1610
1753
  * <p>The state the snapshot is in.</p>
1611
1754
  */
1612
1755
  state?: InstanceSnapshotState | string;
1613
1756
  /**
1757
+ * @public
1614
1758
  * <p>The progress of the snapshot.</p>
1615
1759
  * <note>
1616
1760
  * <p>This is populated only for disk snapshots, and is <code>null</code> for instance
@@ -1619,34 +1763,41 @@ export interface InstanceSnapshot {
1619
1763
  */
1620
1764
  progress?: string;
1621
1765
  /**
1766
+ * @public
1622
1767
  * <p>An array of disk objects containing information about all block storage disks.</p>
1623
1768
  */
1624
1769
  fromAttachedDisks?: Disk[];
1625
1770
  /**
1771
+ * @public
1626
1772
  * <p>The instance from which the snapshot was created.</p>
1627
1773
  */
1628
1774
  fromInstanceName?: string;
1629
1775
  /**
1776
+ * @public
1630
1777
  * <p>The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
1631
1778
  * <code>arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE</code>).</p>
1632
1779
  */
1633
1780
  fromInstanceArn?: string;
1634
1781
  /**
1782
+ * @public
1635
1783
  * <p>The blueprint ID from which you created the snapshot (e.g., <code>os_debian_8_3</code>). A
1636
1784
  * blueprint is a virtual private server (or <i>instance</i>) image used to create
1637
1785
  * instances quickly.</p>
1638
1786
  */
1639
1787
  fromBlueprintId?: string;
1640
1788
  /**
1789
+ * @public
1641
1790
  * <p>The bundle ID from which you created the snapshot (e.g., <code>micro_1_0</code>).</p>
1642
1791
  */
1643
1792
  fromBundleId?: string;
1644
1793
  /**
1794
+ * @public
1645
1795
  * <p>A Boolean value indicating whether the snapshot was created from an automatic
1646
1796
  * snapshot.</p>
1647
1797
  */
1648
1798
  isFromAutoSnapshot?: boolean;
1649
1799
  /**
1800
+ * @public
1650
1801
  * <p>The size in GB of the SSD.</p>
1651
1802
  */
1652
1803
  sizeInGb?: number;
@@ -1656,6 +1807,7 @@ export interface InstanceSnapshot {
1656
1807
  */
1657
1808
  export interface GetInstanceSnapshotResult {
1658
1809
  /**
1810
+ * @public
1659
1811
  * <p>An array of key-value pairs containing information about the results of your get instance
1660
1812
  * snapshot request.</p>
1661
1813
  */
@@ -1666,6 +1818,7 @@ export interface GetInstanceSnapshotResult {
1666
1818
  */
1667
1819
  export interface GetInstanceSnapshotsRequest {
1668
1820
  /**
1821
+ * @public
1669
1822
  * <p>The token to advance to the next page of results from your request.</p>
1670
1823
  * <p>To get a page token, perform an initial <code>GetInstanceSnapshots</code> request. If your
1671
1824
  * results are paginated, the response will return a next page token that you can specify as the
@@ -1678,11 +1831,13 @@ export interface GetInstanceSnapshotsRequest {
1678
1831
  */
1679
1832
  export interface GetInstanceSnapshotsResult {
1680
1833
  /**
1834
+ * @public
1681
1835
  * <p>An array of key-value pairs containing information about the results of your get instance
1682
1836
  * snapshots request.</p>
1683
1837
  */
1684
1838
  instanceSnapshots?: InstanceSnapshot[];
1685
1839
  /**
1840
+ * @public
1686
1841
  * <p>The token to advance to the next page of results from your request.</p>
1687
1842
  * <p>A next page token is not returned if there are no more results to display.</p>
1688
1843
  * <p>To get the next page of results, perform another <code>GetInstanceSnapshots</code> request
@@ -1695,6 +1850,7 @@ export interface GetInstanceSnapshotsResult {
1695
1850
  */
1696
1851
  export interface GetInstanceStateRequest {
1697
1852
  /**
1853
+ * @public
1698
1854
  * <p>The name of the instance to get state information about.</p>
1699
1855
  */
1700
1856
  instanceName: string | undefined;
@@ -1704,6 +1860,7 @@ export interface GetInstanceStateRequest {
1704
1860
  */
1705
1861
  export interface GetInstanceStateResult {
1706
1862
  /**
1863
+ * @public
1707
1864
  * <p>The state of the instance.</p>
1708
1865
  */
1709
1866
  state?: InstanceState;
@@ -1713,6 +1870,7 @@ export interface GetInstanceStateResult {
1713
1870
  */
1714
1871
  export interface GetKeyPairRequest {
1715
1872
  /**
1873
+ * @public
1716
1874
  * <p>The name of the key pair for which you are requesting information.</p>
1717
1875
  */
1718
1876
  keyPairName: string | undefined;
@@ -1722,6 +1880,7 @@ export interface GetKeyPairRequest {
1722
1880
  */
1723
1881
  export interface GetKeyPairResult {
1724
1882
  /**
1883
+ * @public
1725
1884
  * <p>An array of key-value pairs containing information about the key pair.</p>
1726
1885
  */
1727
1886
  keyPair?: KeyPair;
@@ -1731,6 +1890,7 @@ export interface GetKeyPairResult {
1731
1890
  */
1732
1891
  export interface GetKeyPairsRequest {
1733
1892
  /**
1893
+ * @public
1734
1894
  * <p>The token to advance to the next page of results from your request.</p>
1735
1895
  * <p>To get a page token, perform an initial <code>GetKeyPairs</code> request. If your results
1736
1896
  * are paginated, the response will return a next page token that you can specify as the page
@@ -1738,6 +1898,7 @@ export interface GetKeyPairsRequest {
1738
1898
  */
1739
1899
  pageToken?: string;
1740
1900
  /**
1901
+ * @public
1741
1902
  * <p>A Boolean value that indicates whether to include the default key pair in the response of
1742
1903
  * your request.</p>
1743
1904
  */
@@ -1748,10 +1909,12 @@ export interface GetKeyPairsRequest {
1748
1909
  */
1749
1910
  export interface GetKeyPairsResult {
1750
1911
  /**
1912
+ * @public
1751
1913
  * <p>An array of key-value pairs containing information about the key pairs.</p>
1752
1914
  */
1753
1915
  keyPairs?: KeyPair[];
1754
1916
  /**
1917
+ * @public
1755
1918
  * <p>The token to advance to the next page of results from your request.</p>
1756
1919
  * <p>A next page token is not returned if there are no more results to display.</p>
1757
1920
  * <p>To get the next page of results, perform another <code>GetKeyPairs</code> request and
@@ -1764,6 +1927,7 @@ export interface GetKeyPairsResult {
1764
1927
  */
1765
1928
  export interface GetLoadBalancerRequest {
1766
1929
  /**
1930
+ * @public
1767
1931
  * <p>The name of the load balancer.</p>
1768
1932
  */
1769
1933
  loadBalancerName: string | undefined;
@@ -1826,15 +1990,18 @@ export type InstanceHealthReason = (typeof InstanceHealthReason)[keyof typeof In
1826
1990
  */
1827
1991
  export interface InstanceHealthSummary {
1828
1992
  /**
1993
+ * @public
1829
1994
  * <p>The name of the Lightsail instance for which you are requesting health check
1830
1995
  * data.</p>
1831
1996
  */
1832
1997
  instanceName?: string;
1833
1998
  /**
1999
+ * @public
1834
2000
  * <p>Describes the overall instance health. Valid values are below.</p>
1835
2001
  */
1836
2002
  instanceHealth?: InstanceHealthState | string;
1837
2003
  /**
2004
+ * @public
1838
2005
  * <p>More information about the instance health. If the <code>instanceHealth</code> is
1839
2006
  * <code>healthy</code>, then an <code>instanceHealthReason</code> value is not
1840
2007
  * provided.</p>
@@ -1992,10 +2159,12 @@ export type LoadBalancerState = (typeof LoadBalancerState)[keyof typeof LoadBala
1992
2159
  */
1993
2160
  export interface LoadBalancerTlsCertificateSummary {
1994
2161
  /**
2162
+ * @public
1995
2163
  * <p>The name of the SSL/TLS certificate.</p>
1996
2164
  */
1997
2165
  name?: string;
1998
2166
  /**
2167
+ * @public
1999
2168
  * <p>When <code>true</code>, the SSL/TLS certificate is attached to the Lightsail load
2000
2169
  * balancer.</p>
2001
2170
  */
@@ -2007,94 +2176,113 @@ export interface LoadBalancerTlsCertificateSummary {
2007
2176
  */
2008
2177
  export interface LoadBalancer {
2009
2178
  /**
2179
+ * @public
2010
2180
  * <p>The name of the load balancer (e.g., <code>my-load-balancer</code>).</p>
2011
2181
  */
2012
2182
  name?: string;
2013
2183
  /**
2184
+ * @public
2014
2185
  * <p>The Amazon Resource Name (ARN) of the load balancer.</p>
2015
2186
  */
2016
2187
  arn?: string;
2017
2188
  /**
2189
+ * @public
2018
2190
  * <p>The support code. Include this code in your email to support when you have questions about
2019
2191
  * your Lightsail load balancer. This code enables our support team to look up your Lightsail
2020
2192
  * information more easily.</p>
2021
2193
  */
2022
2194
  supportCode?: string;
2023
2195
  /**
2196
+ * @public
2024
2197
  * <p>The date when your load balancer was created.</p>
2025
2198
  */
2026
2199
  createdAt?: Date;
2027
2200
  /**
2201
+ * @public
2028
2202
  * <p>The AWS Region where your load balancer was created (e.g., <code>us-east-2a</code>).
2029
2203
  * Lightsail automatically creates your load balancer across Availability Zones.</p>
2030
2204
  */
2031
2205
  location?: ResourceLocation;
2032
2206
  /**
2207
+ * @public
2033
2208
  * <p>The resource type (e.g., <code>LoadBalancer</code>.</p>
2034
2209
  */
2035
2210
  resourceType?: ResourceType | string;
2036
2211
  /**
2212
+ * @public
2037
2213
  * <p>The tag keys and optional values for the resource. For more information about tags in
2038
2214
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
2039
2215
  */
2040
2216
  tags?: Tag[];
2041
2217
  /**
2218
+ * @public
2042
2219
  * <p>The DNS name of your Lightsail load balancer.</p>
2043
2220
  */
2044
2221
  dnsName?: string;
2045
2222
  /**
2223
+ * @public
2046
2224
  * <p>The status of your load balancer. Valid values are below.</p>
2047
2225
  */
2048
2226
  state?: LoadBalancerState | string;
2049
2227
  /**
2228
+ * @public
2050
2229
  * <p>The protocol you have enabled for your load balancer. Valid values are below.</p>
2051
2230
  * <p>You can't just have <code>HTTP_HTTPS</code>, but you can have just
2052
2231
  * <code>HTTP</code>.</p>
2053
2232
  */
2054
2233
  protocol?: LoadBalancerProtocol | string;
2055
2234
  /**
2235
+ * @public
2056
2236
  * <p>An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,
2057
2237
  * use port 443.</p>
2058
2238
  */
2059
2239
  publicPorts?: number[];
2060
2240
  /**
2241
+ * @public
2061
2242
  * <p>The path you specified to perform your health checks. If no path is specified, the load
2062
2243
  * balancer tries to make a request to the default (root) page.</p>
2063
2244
  */
2064
2245
  healthCheckPath?: string;
2065
2246
  /**
2247
+ * @public
2066
2248
  * <p>The port where the load balancer will direct traffic to your Lightsail instances. For
2067
2249
  * HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.</p>
2068
2250
  */
2069
2251
  instancePort?: number;
2070
2252
  /**
2253
+ * @public
2071
2254
  * <p>An array of InstanceHealthSummary objects describing the health of the load
2072
2255
  * balancer.</p>
2073
2256
  */
2074
2257
  instanceHealthSummary?: InstanceHealthSummary[];
2075
2258
  /**
2259
+ * @public
2076
2260
  * <p>An array of LoadBalancerTlsCertificateSummary objects that provide additional information
2077
2261
  * about the SSL/TLS certificates. For example, if <code>true</code>, the certificate is attached
2078
2262
  * to the load balancer.</p>
2079
2263
  */
2080
2264
  tlsCertificateSummaries?: LoadBalancerTlsCertificateSummary[];
2081
2265
  /**
2266
+ * @public
2082
2267
  * <p>A string to string map of the configuration options for your load balancer. Valid values
2083
2268
  * are listed below.</p>
2084
2269
  */
2085
2270
  configurationOptions?: Record<string, string>;
2086
2271
  /**
2272
+ * @public
2087
2273
  * <p>The IP address type of the load balancer.</p>
2088
2274
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
2089
2275
  * IPv4 and IPv6.</p>
2090
2276
  */
2091
2277
  ipAddressType?: IpAddressType | string;
2092
2278
  /**
2279
+ * @public
2093
2280
  * <p>A Boolean value that indicates whether HTTPS redirection is enabled for the load
2094
2281
  * balancer.</p>
2095
2282
  */
2096
2283
  httpsRedirectionEnabled?: boolean;
2097
2284
  /**
2285
+ * @public
2098
2286
  * <p>The name of the TLS security policy for the load balancer.</p>
2099
2287
  */
2100
2288
  tlsPolicyName?: string;
@@ -2104,6 +2292,7 @@ export interface LoadBalancer {
2104
2292
  */
2105
2293
  export interface GetLoadBalancerResult {
2106
2294
  /**
2295
+ * @public
2107
2296
  * <p>An object containing information about your load balancer.</p>
2108
2297
  */
2109
2298
  loadBalancer?: LoadBalancer;
@@ -2135,10 +2324,12 @@ export type LoadBalancerMetricName = (typeof LoadBalancerMetricName)[keyof typeo
2135
2324
  */
2136
2325
  export interface GetLoadBalancerMetricDataRequest {
2137
2326
  /**
2327
+ * @public
2138
2328
  * <p>The name of the load balancer.</p>
2139
2329
  */
2140
2330
  loadBalancerName: string | undefined;
2141
2331
  /**
2332
+ * @public
2142
2333
  * <p>The metric for which you want to return information.</p>
2143
2334
  * <p>Valid load balancer metric names are listed below, along with the most useful
2144
2335
  * <code>statistics</code> to include in your request, and the published <code>unit</code>
@@ -2311,24 +2502,29 @@ export interface GetLoadBalancerMetricDataRequest {
2311
2502
  */
2312
2503
  metricName: LoadBalancerMetricName | string | undefined;
2313
2504
  /**
2505
+ * @public
2314
2506
  * <p>The granularity, in seconds, of the returned data points.</p>
2315
2507
  */
2316
2508
  period: number | undefined;
2317
2509
  /**
2510
+ * @public
2318
2511
  * <p>The start time of the period.</p>
2319
2512
  */
2320
2513
  startTime: Date | undefined;
2321
2514
  /**
2515
+ * @public
2322
2516
  * <p>The end time of the period.</p>
2323
2517
  */
2324
2518
  endTime: Date | undefined;
2325
2519
  /**
2520
+ * @public
2326
2521
  * <p>The unit for the metric data request. Valid units depend on the metric data being
2327
2522
  * requested. For the valid units with each available metric, see the <code>metricName</code>
2328
2523
  * parameter.</p>
2329
2524
  */
2330
2525
  unit: MetricUnit | string | undefined;
2331
2526
  /**
2527
+ * @public
2332
2528
  * <p>The statistic for the metric.</p>
2333
2529
  * <p>The following statistics are available:</p>
2334
2530
  * <ul>
@@ -2368,10 +2564,12 @@ export interface GetLoadBalancerMetricDataRequest {
2368
2564
  */
2369
2565
  export interface GetLoadBalancerMetricDataResult {
2370
2566
  /**
2567
+ * @public
2371
2568
  * <p>The name of the metric returned.</p>
2372
2569
  */
2373
2570
  metricName?: LoadBalancerMetricName | string;
2374
2571
  /**
2572
+ * @public
2375
2573
  * <p>An array of objects that describe the metric data returned.</p>
2376
2574
  */
2377
2575
  metricData?: MetricDatapoint[];
@@ -2381,6 +2579,7 @@ export interface GetLoadBalancerMetricDataResult {
2381
2579
  */
2382
2580
  export interface GetLoadBalancersRequest {
2383
2581
  /**
2582
+ * @public
2384
2583
  * <p>The token to advance to the next page of results from your request.</p>
2385
2584
  * <p>To get a page token, perform an initial <code>GetLoadBalancers</code> request. If your
2386
2585
  * results are paginated, the response will return a next page token that you can specify as the
@@ -2393,10 +2592,12 @@ export interface GetLoadBalancersRequest {
2393
2592
  */
2394
2593
  export interface GetLoadBalancersResult {
2395
2594
  /**
2595
+ * @public
2396
2596
  * <p>An array of LoadBalancer objects describing your load balancers.</p>
2397
2597
  */
2398
2598
  loadBalancers?: LoadBalancer[];
2399
2599
  /**
2600
+ * @public
2400
2601
  * <p>The token to advance to the next page of results from your request.</p>
2401
2602
  * <p>A next page token is not returned if there are no more results to display.</p>
2402
2603
  * <p>To get the next page of results, perform another <code>GetLoadBalancers</code> request and
@@ -2409,6 +2610,7 @@ export interface GetLoadBalancersResult {
2409
2610
  */
2410
2611
  export interface GetLoadBalancerTlsCertificatesRequest {
2411
2612
  /**
2613
+ * @public
2412
2614
  * <p>The name of the load balancer you associated with your SSL/TLS certificate.</p>
2413
2615
  */
2414
2616
  loadBalancerName: string | undefined;
@@ -2434,6 +2636,7 @@ export type LoadBalancerTlsCertificateDnsRecordCreationStateCode = (typeof LoadB
2434
2636
  */
2435
2637
  export interface LoadBalancerTlsCertificateDnsRecordCreationState {
2436
2638
  /**
2639
+ * @public
2437
2640
  * <p>The status code for the automated DNS record creation.</p>
2438
2641
  * <p>Following are the possible values:</p>
2439
2642
  * <ul>
@@ -2453,6 +2656,7 @@ export interface LoadBalancerTlsCertificateDnsRecordCreationState {
2453
2656
  */
2454
2657
  code?: LoadBalancerTlsCertificateDnsRecordCreationStateCode | string;
2455
2658
  /**
2659
+ * @public
2456
2660
  * <p>The message that describes the reason for the status code.</p>
2457
2661
  */
2458
2662
  message?: string;
@@ -2476,28 +2680,34 @@ export type LoadBalancerTlsCertificateDomainStatus = (typeof LoadBalancerTlsCert
2476
2680
  */
2477
2681
  export interface LoadBalancerTlsCertificateDomainValidationRecord {
2478
2682
  /**
2683
+ * @public
2479
2684
  * <p>A fully qualified domain name in the certificate. For example,
2480
2685
  * <code>example.com</code>.</p>
2481
2686
  */
2482
2687
  name?: string;
2483
2688
  /**
2689
+ * @public
2484
2690
  * <p>The type of validation record. For example, <code>CNAME</code> for domain
2485
2691
  * validation.</p>
2486
2692
  */
2487
2693
  type?: string;
2488
2694
  /**
2695
+ * @public
2489
2696
  * <p>The value for that type.</p>
2490
2697
  */
2491
2698
  value?: string;
2492
2699
  /**
2700
+ * @public
2493
2701
  * <p>The validation status. Valid values are listed below.</p>
2494
2702
  */
2495
2703
  validationStatus?: LoadBalancerTlsCertificateDomainStatus | string;
2496
2704
  /**
2705
+ * @public
2497
2706
  * <p>The domain name against which your SSL/TLS certificate was validated.</p>
2498
2707
  */
2499
2708
  domainName?: string;
2500
2709
  /**
2710
+ * @public
2501
2711
  * <p>An object that describes the state of the canonical name (CNAME) records that are
2502
2712
  * automatically added by Lightsail to the DNS of a domain to validate domain
2503
2713
  * ownership.</p>
@@ -2526,10 +2736,12 @@ export type LoadBalancerTlsCertificateFailureReason = (typeof LoadBalancerTlsCer
2526
2736
  */
2527
2737
  export interface LoadBalancerTlsCertificateDomainValidationOption {
2528
2738
  /**
2739
+ * @public
2529
2740
  * <p>The fully qualified domain name in the certificate request.</p>
2530
2741
  */
2531
2742
  domainName?: string;
2532
2743
  /**
2744
+ * @public
2533
2745
  * <p>The status of the domain validation. Valid values are listed below.</p>
2534
2746
  */
2535
2747
  validationStatus?: LoadBalancerTlsCertificateDomainStatus | string;
@@ -2594,6 +2806,7 @@ export type LoadBalancerTlsCertificateRenewalStatus = (typeof LoadBalancerTlsCer
2594
2806
  */
2595
2807
  export interface LoadBalancerTlsCertificateRenewalSummary {
2596
2808
  /**
2809
+ * @public
2597
2810
  * <p>The renewal status of the certificate.</p>
2598
2811
  * <p>The following renewal status are possible:</p>
2599
2812
  * <ul>
@@ -2636,6 +2849,7 @@ export interface LoadBalancerTlsCertificateRenewalSummary {
2636
2849
  */
2637
2850
  renewalStatus?: LoadBalancerTlsCertificateRenewalStatus | string;
2638
2851
  /**
2852
+ * @public
2639
2853
  * <p>Contains information about the validation of each domain name in the certificate, as it
2640
2854
  * pertains to Lightsail's managed renewal. This is different from the initial validation that
2641
2855
  * occurs as a result of the RequestCertificate request.</p>
@@ -2687,29 +2901,35 @@ export type LoadBalancerTlsCertificateStatus = (typeof LoadBalancerTlsCertificat
2687
2901
  */
2688
2902
  export interface LoadBalancerTlsCertificate {
2689
2903
  /**
2904
+ * @public
2690
2905
  * <p>The name of the SSL/TLS certificate (e.g., <code>my-certificate</code>).</p>
2691
2906
  */
2692
2907
  name?: string;
2693
2908
  /**
2909
+ * @public
2694
2910
  * <p>The Amazon Resource Name (ARN) of the SSL/TLS certificate.</p>
2695
2911
  */
2696
2912
  arn?: string;
2697
2913
  /**
2914
+ * @public
2698
2915
  * <p>The support code. Include this code in your email to support when you have questions about
2699
2916
  * your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to
2700
2917
  * look up your Lightsail information more easily.</p>
2701
2918
  */
2702
2919
  supportCode?: string;
2703
2920
  /**
2921
+ * @public
2704
2922
  * <p>The time when you created your SSL/TLS certificate.</p>
2705
2923
  */
2706
2924
  createdAt?: Date;
2707
2925
  /**
2926
+ * @public
2708
2927
  * <p>The Amazon Web Services Region and Availability Zone where you created your
2709
2928
  * certificate.</p>
2710
2929
  */
2711
2930
  location?: ResourceLocation;
2712
2931
  /**
2932
+ * @public
2713
2933
  * <p>The resource type (e.g., <code>LoadBalancerTlsCertificate</code>).</p>
2714
2934
  * <ul>
2715
2935
  * <li>
@@ -2783,33 +3003,40 @@ export interface LoadBalancerTlsCertificate {
2783
3003
  */
2784
3004
  resourceType?: ResourceType | string;
2785
3005
  /**
3006
+ * @public
2786
3007
  * <p>The tag keys and optional values for the resource. For more information about tags in
2787
3008
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
2788
3009
  */
2789
3010
  tags?: Tag[];
2790
3011
  /**
3012
+ * @public
2791
3013
  * <p>The load balancer name where your SSL/TLS certificate is attached.</p>
2792
3014
  */
2793
3015
  loadBalancerName?: string;
2794
3016
  /**
3017
+ * @public
2795
3018
  * <p>When <code>true</code>, the SSL/TLS certificate is attached to the Lightsail load
2796
3019
  * balancer.</p>
2797
3020
  */
2798
3021
  isAttached?: boolean;
2799
3022
  /**
3023
+ * @public
2800
3024
  * <p>The validation status of the SSL/TLS certificate. Valid values are below.</p>
2801
3025
  */
2802
3026
  status?: LoadBalancerTlsCertificateStatus | string;
2803
3027
  /**
3028
+ * @public
2804
3029
  * <p>The domain name for your SSL/TLS certificate.</p>
2805
3030
  */
2806
3031
  domainName?: string;
2807
3032
  /**
3033
+ * @public
2808
3034
  * <p>An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the
2809
3035
  * records.</p>
2810
3036
  */
2811
3037
  domainValidationRecords?: LoadBalancerTlsCertificateDomainValidationRecord[];
2812
3038
  /**
3039
+ * @public
2813
3040
  * <p>The validation failure reason, if any, of the certificate.</p>
2814
3041
  * <p>The following failure reasons are possible:</p>
2815
3042
  * <ul>
@@ -2876,54 +3103,66 @@ export interface LoadBalancerTlsCertificate {
2876
3103
  */
2877
3104
  failureReason?: LoadBalancerTlsCertificateFailureReason | string;
2878
3105
  /**
3106
+ * @public
2879
3107
  * <p>The time when the SSL/TLS certificate was issued.</p>
2880
3108
  */
2881
3109
  issuedAt?: Date;
2882
3110
  /**
3111
+ * @public
2883
3112
  * <p>The issuer of the certificate.</p>
2884
3113
  */
2885
3114
  issuer?: string;
2886
3115
  /**
3116
+ * @public
2887
3117
  * <p>The algorithm used to generate the key pair (the public and private key).</p>
2888
3118
  */
2889
3119
  keyAlgorithm?: string;
2890
3120
  /**
3121
+ * @public
2891
3122
  * <p>The timestamp when the SSL/TLS certificate expires.</p>
2892
3123
  */
2893
3124
  notAfter?: Date;
2894
3125
  /**
3126
+ * @public
2895
3127
  * <p>The timestamp when the SSL/TLS certificate is first valid.</p>
2896
3128
  */
2897
3129
  notBefore?: Date;
2898
3130
  /**
3131
+ * @public
2899
3132
  * <p>An object that describes the status of the certificate renewal managed by
2900
3133
  * Lightsail.</p>
2901
3134
  */
2902
3135
  renewalSummary?: LoadBalancerTlsCertificateRenewalSummary;
2903
3136
  /**
3137
+ * @public
2904
3138
  * <p>The reason the certificate was revoked. This value is present only when the certificate
2905
3139
  * status is <code>REVOKED</code>.</p>
2906
3140
  */
2907
3141
  revocationReason?: LoadBalancerTlsCertificateRevocationReason | string;
2908
3142
  /**
3143
+ * @public
2909
3144
  * <p>The timestamp when the certificate was revoked. This value is present only when the
2910
3145
  * certificate status is <code>REVOKED</code>.</p>
2911
3146
  */
2912
3147
  revokedAt?: Date;
2913
3148
  /**
3149
+ * @public
2914
3150
  * <p>The serial number of the certificate.</p>
2915
3151
  */
2916
3152
  serial?: string;
2917
3153
  /**
3154
+ * @public
2918
3155
  * <p>The algorithm that was used to sign the certificate.</p>
2919
3156
  */
2920
3157
  signatureAlgorithm?: string;
2921
3158
  /**
3159
+ * @public
2922
3160
  * <p>The name of the entity that is associated with the public key contained in the
2923
3161
  * certificate.</p>
2924
3162
  */
2925
3163
  subject?: string;
2926
3164
  /**
3165
+ * @public
2927
3166
  * <p>An array of strings that specify the alternate domains (e.g., <code>example2.com</code>)
2928
3167
  * and subdomains (e.g., <code>blog.example.com</code>) for the certificate.</p>
2929
3168
  */
@@ -2934,6 +3173,7 @@ export interface LoadBalancerTlsCertificate {
2934
3173
  */
2935
3174
  export interface GetLoadBalancerTlsCertificatesResult {
2936
3175
  /**
3176
+ * @public
2937
3177
  * <p>An array of LoadBalancerTlsCertificate objects describing your SSL/TLS
2938
3178
  * certificates.</p>
2939
3179
  */
@@ -2944,6 +3184,7 @@ export interface GetLoadBalancerTlsCertificatesResult {
2944
3184
  */
2945
3185
  export interface GetLoadBalancerTlsPoliciesRequest {
2946
3186
  /**
3187
+ * @public
2947
3188
  * <p>The token to advance to the next page of results from your request.</p>
2948
3189
  * <p>To get a page token, perform an initial <code>GetLoadBalancerTlsPolicies</code> request.
2949
3190
  * If your results are paginated, the response will return a next page token that you can specify
@@ -2961,22 +3202,27 @@ export interface GetLoadBalancerTlsPoliciesRequest {
2961
3202
  */
2962
3203
  export interface LoadBalancerTlsPolicy {
2963
3204
  /**
3205
+ * @public
2964
3206
  * <p>The name of the TLS security policy.</p>
2965
3207
  */
2966
3208
  name?: string;
2967
3209
  /**
3210
+ * @public
2968
3211
  * <p>A Boolean value that indicates whether the TLS security policy is the default.</p>
2969
3212
  */
2970
3213
  isDefault?: boolean;
2971
3214
  /**
3215
+ * @public
2972
3216
  * <p>The description of the TLS security policy.</p>
2973
3217
  */
2974
3218
  description?: string;
2975
3219
  /**
3220
+ * @public
2976
3221
  * <p>The protocols used in a given TLS security policy.</p>
2977
3222
  */
2978
3223
  protocols?: string[];
2979
3224
  /**
3225
+ * @public
2980
3226
  * <p>The ciphers used by the TLS security policy.</p>
2981
3227
  * <p>The ciphers are listed in order of preference.</p>
2982
3228
  */
@@ -2987,10 +3233,12 @@ export interface LoadBalancerTlsPolicy {
2987
3233
  */
2988
3234
  export interface GetLoadBalancerTlsPoliciesResult {
2989
3235
  /**
3236
+ * @public
2990
3237
  * <p>An array of objects that describe the TLS security policies that are available.</p>
2991
3238
  */
2992
3239
  tlsPolicies?: LoadBalancerTlsPolicy[];
2993
3240
  /**
3241
+ * @public
2994
3242
  * <p>The token to advance to the next page of results from your request.</p>
2995
3243
  * <p>A next page token is not returned if there are no more results to display.</p>
2996
3244
  * <p>To get the next page of results, perform another <code>GetLoadBalancerTlsPolicies</code>
@@ -3003,6 +3251,7 @@ export interface GetLoadBalancerTlsPoliciesResult {
3003
3251
  */
3004
3252
  export interface GetOperationRequest {
3005
3253
  /**
3254
+ * @public
3006
3255
  * <p>A GUID used to identify the operation.</p>
3007
3256
  */
3008
3257
  operationId: string | undefined;
@@ -3012,6 +3261,7 @@ export interface GetOperationRequest {
3012
3261
  */
3013
3262
  export interface GetOperationResult {
3014
3263
  /**
3264
+ * @public
3015
3265
  * <p>An array of objects that describe the result of the action, such as the status of the
3016
3266
  * request, the timestamp of the request, and the resources affected by the request.</p>
3017
3267
  */
@@ -3022,6 +3272,7 @@ export interface GetOperationResult {
3022
3272
  */
3023
3273
  export interface GetOperationsRequest {
3024
3274
  /**
3275
+ * @public
3025
3276
  * <p>The token to advance to the next page of results from your request.</p>
3026
3277
  * <p>To get a page token, perform an initial <code>GetOperations</code> request. If your
3027
3278
  * results are paginated, the response will return a next page token that you can specify as the
@@ -3034,11 +3285,13 @@ export interface GetOperationsRequest {
3034
3285
  */
3035
3286
  export interface GetOperationsResult {
3036
3287
  /**
3288
+ * @public
3037
3289
  * <p>An array of objects that describe the result of the action, such as the status of the
3038
3290
  * request, the timestamp of the request, and the resources affected by the request.</p>
3039
3291
  */
3040
3292
  operations?: Operation[];
3041
3293
  /**
3294
+ * @public
3042
3295
  * <p>The token to advance to the next page of results from your request.</p>
3043
3296
  * <p>A next page token is not returned if there are no more results to display.</p>
3044
3297
  * <p>To get the next page of results, perform another <code>GetOperations</code> request and
@@ -3051,10 +3304,12 @@ export interface GetOperationsResult {
3051
3304
  */
3052
3305
  export interface GetOperationsForResourceRequest {
3053
3306
  /**
3307
+ * @public
3054
3308
  * <p>The name of the resource for which you are requesting information.</p>
3055
3309
  */
3056
3310
  resourceName: string | undefined;
3057
3311
  /**
3312
+ * @public
3058
3313
  * <p>The token to advance to the next page of results from your request.</p>
3059
3314
  * <p>To get a page token, perform an initial <code>GetOperationsForResource</code> request. If
3060
3315
  * your results are paginated, the response will return a next page token that you can specify as
@@ -3067,11 +3322,13 @@ export interface GetOperationsForResourceRequest {
3067
3322
  */
3068
3323
  export interface GetOperationsForResourceResult {
3069
3324
  /**
3325
+ * @public
3070
3326
  * <p>An array of objects that describe the result of the action, such as the status of the
3071
3327
  * request, the timestamp of the request, and the resources affected by the request.</p>
3072
3328
  */
3073
3329
  operations?: Operation[];
3074
3330
  /**
3331
+ * @public
3075
3332
  * @deprecated
3076
3333
  *
3077
3334
  * <p>(Deprecated) Returns the number of pages of results that remain.</p>
@@ -3083,6 +3340,7 @@ export interface GetOperationsForResourceResult {
3083
3340
  */
3084
3341
  nextPageCount?: string;
3085
3342
  /**
3343
+ * @public
3086
3344
  * <p>The token to advance to the next page of results from your request.</p>
3087
3345
  * <p>A next page token is not returned if there are no more results to display.</p>
3088
3346
  * <p>To get the next page of results, perform another <code>GetOperationsForResource</code>
@@ -3095,11 +3353,13 @@ export interface GetOperationsForResourceResult {
3095
3353
  */
3096
3354
  export interface GetRegionsRequest {
3097
3355
  /**
3356
+ * @public
3098
3357
  * <p>A Boolean value indicating whether to also include Availability Zones in your get regions
3099
3358
  * request. Availability Zones are indicated with a letter: e.g., <code>us-east-2a</code>.</p>
3100
3359
  */
3101
3360
  includeAvailabilityZones?: boolean;
3102
3361
  /**
3362
+ * @public
3103
3363
  * <p>A Boolean value indicating whether to also include Availability Zones for databases in
3104
3364
  * your get regions request. Availability Zones are indicated with a letter (e.g.,
3105
3365
  * <code>us-east-2a</code>).</p>
@@ -3112,28 +3372,34 @@ export interface GetRegionsRequest {
3112
3372
  */
3113
3373
  export interface Region {
3114
3374
  /**
3375
+ * @public
3115
3376
  * <p>The continent code (e.g., <code>NA</code>, meaning North America).</p>
3116
3377
  */
3117
3378
  continentCode?: string;
3118
3379
  /**
3380
+ * @public
3119
3381
  * <p>The description of the Amazon Web Services Region (e.g., <code>This region is recommended
3120
3382
  * to serve users in the eastern United States and eastern Canada</code>).</p>
3121
3383
  */
3122
3384
  description?: string;
3123
3385
  /**
3386
+ * @public
3124
3387
  * <p>The display name (e.g., <code>Ohio</code>).</p>
3125
3388
  */
3126
3389
  displayName?: string;
3127
3390
  /**
3391
+ * @public
3128
3392
  * <p>The region name (e.g., <code>us-east-2</code>).</p>
3129
3393
  */
3130
3394
  name?: RegionName | string;
3131
3395
  /**
3396
+ * @public
3132
3397
  * <p>The Availability Zones. Follows the format <code>us-east-2a</code>
3133
3398
  * (case-sensitive).</p>
3134
3399
  */
3135
3400
  availabilityZones?: AvailabilityZone[];
3136
3401
  /**
3402
+ * @public
3137
3403
  * <p>The Availability Zones for databases. Follows the format <code>us-east-2a</code>
3138
3404
  * (case-sensitive).</p>
3139
3405
  */
@@ -3144,6 +3410,7 @@ export interface Region {
3144
3410
  */
3145
3411
  export interface GetRegionsResult {
3146
3412
  /**
3413
+ * @public
3147
3414
  * <p>An array of key-value pairs containing information about your get regions request.</p>
3148
3415
  */
3149
3416
  regions?: Region[];
@@ -3153,6 +3420,7 @@ export interface GetRegionsResult {
3153
3420
  */
3154
3421
  export interface GetRelationalDatabaseRequest {
3155
3422
  /**
3423
+ * @public
3156
3424
  * <p>The name of the database that you are looking up.</p>
3157
3425
  */
3158
3426
  relationalDatabaseName: string | undefined;
@@ -3163,14 +3431,17 @@ export interface GetRelationalDatabaseRequest {
3163
3431
  */
3164
3432
  export interface RelationalDatabaseHardware {
3165
3433
  /**
3434
+ * @public
3166
3435
  * <p>The number of vCPUs for the database.</p>
3167
3436
  */
3168
3437
  cpuCount?: number;
3169
3438
  /**
3439
+ * @public
3170
3440
  * <p>The size of the disk for the database.</p>
3171
3441
  */
3172
3442
  diskSizeInGb?: number;
3173
3443
  /**
3444
+ * @public
3174
3445
  * <p>The amount of RAM in GB for the database.</p>
3175
3446
  */
3176
3447
  ramSizeInGb?: number;
@@ -3181,10 +3452,12 @@ export interface RelationalDatabaseHardware {
3181
3452
  */
3182
3453
  export interface RelationalDatabaseEndpoint {
3183
3454
  /**
3455
+ * @public
3184
3456
  * <p>Specifies the port that the database is listening on.</p>
3185
3457
  */
3186
3458
  port?: number;
3187
3459
  /**
3460
+ * @public
3188
3461
  * <p>Specifies the DNS address of the database.</p>
3189
3462
  */
3190
3463
  address?: string;
@@ -3195,14 +3468,17 @@ export interface RelationalDatabaseEndpoint {
3195
3468
  */
3196
3469
  export interface PendingMaintenanceAction {
3197
3470
  /**
3471
+ * @public
3198
3472
  * <p>The type of pending database maintenance action.</p>
3199
3473
  */
3200
3474
  action?: string;
3201
3475
  /**
3476
+ * @public
3202
3477
  * <p>Additional detail about the pending database maintenance action.</p>
3203
3478
  */
3204
3479
  description?: string;
3205
3480
  /**
3481
+ * @public
3206
3482
  * <p>The effective date of the pending database maintenance action.</p>
3207
3483
  */
3208
3484
  currentApplyDate?: Date;
@@ -3213,14 +3489,17 @@ export interface PendingMaintenanceAction {
3213
3489
  */
3214
3490
  export interface PendingModifiedRelationalDatabaseValues {
3215
3491
  /**
3492
+ * @public
3216
3493
  * <p>The password for the master user of the database.</p>
3217
3494
  */
3218
3495
  masterUserPassword?: string;
3219
3496
  /**
3497
+ * @public
3220
3498
  * <p>The database engine version.</p>
3221
3499
  */
3222
3500
  engineVersion?: string;
3223
3501
  /**
3502
+ * @public
3224
3503
  * <p>A Boolean value indicating whether automated backup retention is enabled.</p>
3225
3504
  */
3226
3505
  backupRetentionEnabled?: boolean;
@@ -3231,120 +3510,146 @@ export interface PendingModifiedRelationalDatabaseValues {
3231
3510
  */
3232
3511
  export interface RelationalDatabase {
3233
3512
  /**
3513
+ * @public
3234
3514
  * <p>The unique name of the database resource in Lightsail.</p>
3235
3515
  */
3236
3516
  name?: string;
3237
3517
  /**
3518
+ * @public
3238
3519
  * <p>The Amazon Resource Name (ARN) of the database.</p>
3239
3520
  */
3240
3521
  arn?: string;
3241
3522
  /**
3523
+ * @public
3242
3524
  * <p>The support code for the database. Include this code in your email to support when you
3243
3525
  * have questions about a database in Lightsail. This code enables our support team to look up
3244
3526
  * your Lightsail information more easily.</p>
3245
3527
  */
3246
3528
  supportCode?: string;
3247
3529
  /**
3530
+ * @public
3248
3531
  * <p>The timestamp when the database was created. Formatted in Unix time.</p>
3249
3532
  */
3250
3533
  createdAt?: Date;
3251
3534
  /**
3535
+ * @public
3252
3536
  * <p>The Region name and Availability Zone where the database is located.</p>
3253
3537
  */
3254
3538
  location?: ResourceLocation;
3255
3539
  /**
3540
+ * @public
3256
3541
  * <p>The Lightsail resource type for the database (for example,
3257
3542
  * <code>RelationalDatabase</code>).</p>
3258
3543
  */
3259
3544
  resourceType?: ResourceType | string;
3260
3545
  /**
3546
+ * @public
3261
3547
  * <p>The tag keys and optional values for the resource. For more information about tags in
3262
3548
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
3263
3549
  */
3264
3550
  tags?: Tag[];
3265
3551
  /**
3552
+ * @public
3266
3553
  * <p>The blueprint ID for the database. A blueprint describes the major engine version of a
3267
3554
  * database.</p>
3268
3555
  */
3269
3556
  relationalDatabaseBlueprintId?: string;
3270
3557
  /**
3558
+ * @public
3271
3559
  * <p>The bundle ID for the database. A bundle describes the performance specifications for your
3272
3560
  * database.</p>
3273
3561
  */
3274
3562
  relationalDatabaseBundleId?: string;
3275
3563
  /**
3564
+ * @public
3276
3565
  * <p>The name of the master database created when the Lightsail database resource is
3277
3566
  * created.</p>
3278
3567
  */
3279
3568
  masterDatabaseName?: string;
3280
3569
  /**
3570
+ * @public
3281
3571
  * <p>Describes the hardware of the database.</p>
3282
3572
  */
3283
3573
  hardware?: RelationalDatabaseHardware;
3284
3574
  /**
3575
+ * @public
3285
3576
  * <p>Describes the current state of the database.</p>
3286
3577
  */
3287
3578
  state?: string;
3288
3579
  /**
3580
+ * @public
3289
3581
  * <p>Describes the secondary Availability Zone of a high availability database.</p>
3290
3582
  * <p>The secondary database is used for failover support of a high availability
3291
3583
  * database.</p>
3292
3584
  */
3293
3585
  secondaryAvailabilityZone?: string;
3294
3586
  /**
3587
+ * @public
3295
3588
  * <p>A Boolean value indicating whether automated backup retention is enabled for the
3296
3589
  * database.</p>
3297
3590
  */
3298
3591
  backupRetentionEnabled?: boolean;
3299
3592
  /**
3593
+ * @public
3300
3594
  * <p>Describes pending database value modifications.</p>
3301
3595
  */
3302
3596
  pendingModifiedValues?: PendingModifiedRelationalDatabaseValues;
3303
3597
  /**
3598
+ * @public
3304
3599
  * <p>The database software (for example, <code>MySQL</code>).</p>
3305
3600
  */
3306
3601
  engine?: string;
3307
3602
  /**
3603
+ * @public
3308
3604
  * <p>The database engine version (for example, <code>5.7.23</code>).</p>
3309
3605
  */
3310
3606
  engineVersion?: string;
3311
3607
  /**
3608
+ * @public
3312
3609
  * <p>The latest point in time to which the database can be restored. Formatted in Unix
3313
3610
  * time.</p>
3314
3611
  */
3315
3612
  latestRestorableTime?: Date;
3316
3613
  /**
3614
+ * @public
3317
3615
  * <p>The master user name of the database.</p>
3318
3616
  */
3319
3617
  masterUsername?: string;
3320
3618
  /**
3619
+ * @public
3321
3620
  * <p>The status of parameter updates for the database.</p>
3322
3621
  */
3323
3622
  parameterApplyStatus?: string;
3324
3623
  /**
3624
+ * @public
3325
3625
  * <p>The daily time range during which automated backups are created for the database (for
3326
3626
  * example, <code>16:00-16:30</code>).</p>
3327
3627
  */
3328
3628
  preferredBackupWindow?: string;
3329
3629
  /**
3630
+ * @public
3330
3631
  * <p>The weekly time range during which system maintenance can occur on the database.</p>
3331
3632
  * <p>In the format <code>ddd:hh24:mi-ddd:hh24:mi</code>. For example,
3332
3633
  * <code>Tue:17:00-Tue:17:30</code>.</p>
3333
3634
  */
3334
3635
  preferredMaintenanceWindow?: string;
3335
3636
  /**
3637
+ * @public
3336
3638
  * <p>A Boolean value indicating whether the database is publicly accessible.</p>
3337
3639
  */
3338
3640
  publiclyAccessible?: boolean;
3339
3641
  /**
3642
+ * @public
3340
3643
  * <p>The master endpoint for the database.</p>
3341
3644
  */
3342
3645
  masterEndpoint?: RelationalDatabaseEndpoint;
3343
3646
  /**
3647
+ * @public
3344
3648
  * <p>Describes the pending maintenance actions for the database.</p>
3345
3649
  */
3346
3650
  pendingMaintenanceActions?: PendingMaintenanceAction[];
3347
3651
  /**
3652
+ * @public
3348
3653
  * <p>The certificate associated with the database.</p>
3349
3654
  */
3350
3655
  caCertificateIdentifier?: string;
@@ -3354,6 +3659,7 @@ export interface RelationalDatabase {
3354
3659
  */
3355
3660
  export interface GetRelationalDatabaseResult {
3356
3661
  /**
3662
+ * @public
3357
3663
  * <p>An object describing the specified database.</p>
3358
3664
  */
3359
3665
  relationalDatabase?: RelationalDatabase;
@@ -3363,6 +3669,7 @@ export interface GetRelationalDatabaseResult {
3363
3669
  */
3364
3670
  export interface GetRelationalDatabaseBlueprintsRequest {
3365
3671
  /**
3672
+ * @public
3366
3673
  * <p>The token to advance to the next page of results from your request.</p>
3367
3674
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseBlueprints</code>
3368
3675
  * request. If your results are paginated, the response will return a next page token that you
@@ -3388,27 +3695,33 @@ export type RelationalDatabaseEngine = (typeof RelationalDatabaseEngine)[keyof t
3388
3695
  */
3389
3696
  export interface RelationalDatabaseBlueprint {
3390
3697
  /**
3698
+ * @public
3391
3699
  * <p>The ID for the database blueprint.</p>
3392
3700
  */
3393
3701
  blueprintId?: string;
3394
3702
  /**
3703
+ * @public
3395
3704
  * <p>The database software of the database blueprint (for example, <code>MySQL</code>).</p>
3396
3705
  */
3397
3706
  engine?: RelationalDatabaseEngine | string;
3398
3707
  /**
3708
+ * @public
3399
3709
  * <p>The database engine version for the database blueprint (for example,
3400
3710
  * <code>5.7.23</code>).</p>
3401
3711
  */
3402
3712
  engineVersion?: string;
3403
3713
  /**
3714
+ * @public
3404
3715
  * <p>The description of the database engine for the database blueprint.</p>
3405
3716
  */
3406
3717
  engineDescription?: string;
3407
3718
  /**
3719
+ * @public
3408
3720
  * <p>The description of the database engine version for the database blueprint.</p>
3409
3721
  */
3410
3722
  engineVersionDescription?: string;
3411
3723
  /**
3724
+ * @public
3412
3725
  * <p>A Boolean value indicating whether the engine version is the default for the database
3413
3726
  * blueprint.</p>
3414
3727
  */
@@ -3419,10 +3732,12 @@ export interface RelationalDatabaseBlueprint {
3419
3732
  */
3420
3733
  export interface GetRelationalDatabaseBlueprintsResult {
3421
3734
  /**
3735
+ * @public
3422
3736
  * <p>An object describing the result of your get relational database blueprints request.</p>
3423
3737
  */
3424
3738
  blueprints?: RelationalDatabaseBlueprint[];
3425
3739
  /**
3740
+ * @public
3426
3741
  * <p>The token to advance to the next page of results from your request.</p>
3427
3742
  * <p>A next page token is not returned if there are no more results to display.</p>
3428
3743
  * <p>To get the next page of results, perform another
@@ -3436,6 +3751,7 @@ export interface GetRelationalDatabaseBlueprintsResult {
3436
3751
  */
3437
3752
  export interface GetRelationalDatabaseBundlesRequest {
3438
3753
  /**
3754
+ * @public
3439
3755
  * <p>The token to advance to the next page of results from your request.</p>
3440
3756
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseBundles</code> request.
3441
3757
  * If your results are paginated, the response will return a next page token that you can specify
@@ -3443,6 +3759,7 @@ export interface GetRelationalDatabaseBundlesRequest {
3443
3759
  */
3444
3760
  pageToken?: string;
3445
3761
  /**
3762
+ * @public
3446
3763
  * <p>A Boolean value that indicates whether to include inactive (unavailable) bundles in the
3447
3764
  * response of your request.</p>
3448
3765
  */
@@ -3455,38 +3772,47 @@ export interface GetRelationalDatabaseBundlesRequest {
3455
3772
  */
3456
3773
  export interface RelationalDatabaseBundle {
3457
3774
  /**
3775
+ * @public
3458
3776
  * <p>The ID for the database bundle.</p>
3459
3777
  */
3460
3778
  bundleId?: string;
3461
3779
  /**
3780
+ * @public
3462
3781
  * <p>The name for the database bundle.</p>
3463
3782
  */
3464
3783
  name?: string;
3465
3784
  /**
3785
+ * @public
3466
3786
  * <p>The cost of the database bundle in US currency.</p>
3467
3787
  */
3468
3788
  price?: number;
3469
3789
  /**
3790
+ * @public
3470
3791
  * <p>The amount of RAM in GB (for example, <code>2.0</code>) for the database bundle.</p>
3471
3792
  */
3472
3793
  ramSizeInGb?: number;
3473
3794
  /**
3795
+ * @public
3474
3796
  * <p>The size of the disk for the database bundle.</p>
3475
3797
  */
3476
3798
  diskSizeInGb?: number;
3477
3799
  /**
3800
+ * @public
3478
3801
  * <p>The data transfer rate per month in GB for the database bundle.</p>
3479
3802
  */
3480
3803
  transferPerMonthInGb?: number;
3481
3804
  /**
3805
+ * @public
3482
3806
  * <p>The number of virtual CPUs (vCPUs) for the database bundle.</p>
3483
3807
  */
3484
3808
  cpuCount?: number;
3485
3809
  /**
3810
+ * @public
3486
3811
  * <p>A Boolean value indicating whether the database bundle is encrypted.</p>
3487
3812
  */
3488
3813
  isEncrypted?: boolean;
3489
3814
  /**
3815
+ * @public
3490
3816
  * <p>A Boolean value indicating whether the database bundle is active.</p>
3491
3817
  */
3492
3818
  isActive?: boolean;
@@ -3496,10 +3822,12 @@ export interface RelationalDatabaseBundle {
3496
3822
  */
3497
3823
  export interface GetRelationalDatabaseBundlesResult {
3498
3824
  /**
3825
+ * @public
3499
3826
  * <p>An object describing the result of your get relational database bundles request.</p>
3500
3827
  */
3501
3828
  bundles?: RelationalDatabaseBundle[];
3502
3829
  /**
3830
+ * @public
3503
3831
  * <p>The token to advance to the next page of results from your request.</p>
3504
3832
  * <p>A next page token is not returned if there are no more results to display.</p>
3505
3833
  * <p>To get the next page of results, perform another <code>GetRelationalDatabaseBundles</code>
@@ -3512,10 +3840,12 @@ export interface GetRelationalDatabaseBundlesResult {
3512
3840
  */
3513
3841
  export interface GetRelationalDatabaseEventsRequest {
3514
3842
  /**
3843
+ * @public
3515
3844
  * <p>The name of the database from which to get events.</p>
3516
3845
  */
3517
3846
  relationalDatabaseName: string | undefined;
3518
3847
  /**
3848
+ * @public
3519
3849
  * <p>The number of minutes in the past from which to retrieve events. For example, to get all
3520
3850
  * events from the past 2 hours, enter 120.</p>
3521
3851
  * <p>Default: <code>60</code>
@@ -3524,6 +3854,7 @@ export interface GetRelationalDatabaseEventsRequest {
3524
3854
  */
3525
3855
  durationInMinutes?: number;
3526
3856
  /**
3857
+ * @public
3527
3858
  * <p>The token to advance to the next page of results from your request.</p>
3528
3859
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseEvents</code> request.
3529
3860
  * If your results are paginated, the response will return a next page token that you can specify
@@ -3537,18 +3868,22 @@ export interface GetRelationalDatabaseEventsRequest {
3537
3868
  */
3538
3869
  export interface RelationalDatabaseEvent {
3539
3870
  /**
3871
+ * @public
3540
3872
  * <p>The database that the database event relates to.</p>
3541
3873
  */
3542
3874
  resource?: string;
3543
3875
  /**
3876
+ * @public
3544
3877
  * <p>The timestamp when the database event was created.</p>
3545
3878
  */
3546
3879
  createdAt?: Date;
3547
3880
  /**
3881
+ * @public
3548
3882
  * <p>The message of the database event.</p>
3549
3883
  */
3550
3884
  message?: string;
3551
3885
  /**
3886
+ * @public
3552
3887
  * <p>The category that the database event belongs to.</p>
3553
3888
  */
3554
3889
  eventCategories?: string[];
@@ -3558,10 +3893,12 @@ export interface RelationalDatabaseEvent {
3558
3893
  */
3559
3894
  export interface GetRelationalDatabaseEventsResult {
3560
3895
  /**
3896
+ * @public
3561
3897
  * <p>An object describing the result of your get relational database events request.</p>
3562
3898
  */
3563
3899
  relationalDatabaseEvents?: RelationalDatabaseEvent[];
3564
3900
  /**
3901
+ * @public
3565
3902
  * <p>The token to advance to the next page of results from your request.</p>
3566
3903
  * <p>A next page token is not returned if there are no more results to display.</p>
3567
3904
  * <p>To get the next page of results, perform another <code>GetRelationalDatabaseEvents</code>
@@ -3574,16 +3911,19 @@ export interface GetRelationalDatabaseEventsResult {
3574
3911
  */
3575
3912
  export interface GetRelationalDatabaseLogEventsRequest {
3576
3913
  /**
3914
+ * @public
3577
3915
  * <p>The name of your database for which to get log events.</p>
3578
3916
  */
3579
3917
  relationalDatabaseName: string | undefined;
3580
3918
  /**
3919
+ * @public
3581
3920
  * <p>The name of the log stream.</p>
3582
3921
  * <p>Use the <code>get relational database log streams</code> operation to get a list of
3583
3922
  * available log streams.</p>
3584
3923
  */
3585
3924
  logStreamName: string | undefined;
3586
3925
  /**
3926
+ * @public
3587
3927
  * <p>The start of the time interval from which to get log events.</p>
3588
3928
  * <p>Constraints:</p>
3589
3929
  * <ul>
@@ -3599,6 +3939,7 @@ export interface GetRelationalDatabaseLogEventsRequest {
3599
3939
  */
3600
3940
  startTime?: Date;
3601
3941
  /**
3942
+ * @public
3602
3943
  * <p>The end of the time interval from which to get log events.</p>
3603
3944
  * <p>Constraints:</p>
3604
3945
  * <ul>
@@ -3614,6 +3955,7 @@ export interface GetRelationalDatabaseLogEventsRequest {
3614
3955
  */
3615
3956
  endTime?: Date;
3616
3957
  /**
3958
+ * @public
3617
3959
  * <p>Parameter to specify if the log should start from head or tail. If <code>true</code> is
3618
3960
  * specified, the log event starts from the head of the log. If <code>false</code> is specified,
3619
3961
  * the log event starts from the tail of the log.</p>
@@ -3624,6 +3966,7 @@ export interface GetRelationalDatabaseLogEventsRequest {
3624
3966
  */
3625
3967
  startFromHead?: boolean;
3626
3968
  /**
3969
+ * @public
3627
3970
  * <p>The token to advance to the next or previous page of results from your request.</p>
3628
3971
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseLogEvents</code>
3629
3972
  * request. If your results are paginated, the response will return a next forward token and/or
@@ -3637,10 +3980,12 @@ export interface GetRelationalDatabaseLogEventsRequest {
3637
3980
  */
3638
3981
  export interface LogEvent {
3639
3982
  /**
3983
+ * @public
3640
3984
  * <p>The timestamp when the database log event was created.</p>
3641
3985
  */
3642
3986
  createdAt?: Date;
3643
3987
  /**
3988
+ * @public
3644
3989
  * <p>The message of the database log event.</p>
3645
3990
  */
3646
3991
  message?: string;
@@ -3650,15 +3995,18 @@ export interface LogEvent {
3650
3995
  */
3651
3996
  export interface GetRelationalDatabaseLogEventsResult {
3652
3997
  /**
3998
+ * @public
3653
3999
  * <p>An object describing the result of your get relational database log events request.</p>
3654
4000
  */
3655
4001
  resourceLogEvents?: LogEvent[];
3656
4002
  /**
4003
+ * @public
3657
4004
  * <p>A token used for advancing to the previous page of results from your get relational
3658
4005
  * database log events request.</p>
3659
4006
  */
3660
4007
  nextBackwardToken?: string;
3661
4008
  /**
4009
+ * @public
3662
4010
  * <p>A token used for advancing to the next page of results from your get relational database
3663
4011
  * log events request.</p>
3664
4012
  */
@@ -3669,6 +4017,7 @@ export interface GetRelationalDatabaseLogEventsResult {
3669
4017
  */
3670
4018
  export interface GetRelationalDatabaseLogStreamsRequest {
3671
4019
  /**
4020
+ * @public
3672
4021
  * <p>The name of your database for which to get log streams.</p>
3673
4022
  */
3674
4023
  relationalDatabaseName: string | undefined;
@@ -3678,6 +4027,7 @@ export interface GetRelationalDatabaseLogStreamsRequest {
3678
4027
  */
3679
4028
  export interface GetRelationalDatabaseLogStreamsResult {
3680
4029
  /**
4030
+ * @public
3681
4031
  * <p>An object describing the result of your get relational database log streams
3682
4032
  * request.</p>
3683
4033
  */
@@ -3701,10 +4051,12 @@ export type RelationalDatabasePasswordVersion = (typeof RelationalDatabasePasswo
3701
4051
  */
3702
4052
  export interface GetRelationalDatabaseMasterUserPasswordRequest {
3703
4053
  /**
4054
+ * @public
3704
4055
  * <p>The name of your database for which to get the master user password.</p>
3705
4056
  */
3706
4057
  relationalDatabaseName: string | undefined;
3707
4058
  /**
4059
+ * @public
3708
4060
  * <p>The password version to return.</p>
3709
4061
  * <p>Specifying <code>CURRENT</code> or <code>PREVIOUS</code> returns the current or previous
3710
4062
  * passwords respectively. Specifying <code>PENDING</code> returns the newest version of the
@@ -3721,10 +4073,12 @@ export interface GetRelationalDatabaseMasterUserPasswordRequest {
3721
4073
  */
3722
4074
  export interface GetRelationalDatabaseMasterUserPasswordResult {
3723
4075
  /**
4076
+ * @public
3724
4077
  * <p>The master user password for the <code>password version</code> specified.</p>
3725
4078
  */
3726
4079
  masterUserPassword?: string;
3727
4080
  /**
4081
+ * @public
3728
4082
  * <p>The timestamp when the specified version of the master user password was created.</p>
3729
4083
  */
3730
4084
  createdAt?: Date;
@@ -3750,10 +4104,12 @@ export type RelationalDatabaseMetricName = (typeof RelationalDatabaseMetricName)
3750
4104
  */
3751
4105
  export interface GetRelationalDatabaseMetricDataRequest {
3752
4106
  /**
4107
+ * @public
3753
4108
  * <p>The name of your database from which to get metric data.</p>
3754
4109
  */
3755
4110
  relationalDatabaseName: string | undefined;
3756
4111
  /**
4112
+ * @public
3757
4113
  * <p>The metric for which you want to return information.</p>
3758
4114
  * <p>Valid relational database metric names are listed below, along with the most useful
3759
4115
  * <code>statistics</code> to include in your request, and the published <code>unit</code>
@@ -3834,12 +4190,14 @@ export interface GetRelationalDatabaseMetricDataRequest {
3834
4190
  */
3835
4191
  metricName: RelationalDatabaseMetricName | string | undefined;
3836
4192
  /**
4193
+ * @public
3837
4194
  * <p>The granularity, in seconds, of the returned data points.</p>
3838
4195
  * <p>All relational database metric data is available in 1-minute (60 seconds)
3839
4196
  * granularity.</p>
3840
4197
  */
3841
4198
  period: number | undefined;
3842
4199
  /**
4200
+ * @public
3843
4201
  * <p>The start of the time interval from which to get metric data.</p>
3844
4202
  * <p>Constraints:</p>
3845
4203
  * <ul>
@@ -3855,6 +4213,7 @@ export interface GetRelationalDatabaseMetricDataRequest {
3855
4213
  */
3856
4214
  startTime: Date | undefined;
3857
4215
  /**
4216
+ * @public
3858
4217
  * <p>The end of the time interval from which to get metric data.</p>
3859
4218
  * <p>Constraints:</p>
3860
4219
  * <ul>
@@ -3870,12 +4229,14 @@ export interface GetRelationalDatabaseMetricDataRequest {
3870
4229
  */
3871
4230
  endTime: Date | undefined;
3872
4231
  /**
4232
+ * @public
3873
4233
  * <p>The unit for the metric data request. Valid units depend on the metric data being
3874
4234
  * requested. For the valid units with each available metric, see the <code>metricName</code>
3875
4235
  * parameter.</p>
3876
4236
  */
3877
4237
  unit: MetricUnit | string | undefined;
3878
4238
  /**
4239
+ * @public
3879
4240
  * <p>The statistic for the metric.</p>
3880
4241
  * <p>The following statistics are available:</p>
3881
4242
  * <ul>
@@ -3915,10 +4276,12 @@ export interface GetRelationalDatabaseMetricDataRequest {
3915
4276
  */
3916
4277
  export interface GetRelationalDatabaseMetricDataResult {
3917
4278
  /**
4279
+ * @public
3918
4280
  * <p>The name of the metric returned.</p>
3919
4281
  */
3920
4282
  metricName?: RelationalDatabaseMetricName | string;
3921
4283
  /**
4284
+ * @public
3922
4285
  * <p>An array of objects that describe the metric data returned.</p>
3923
4286
  */
3924
4287
  metricData?: MetricDatapoint[];
@@ -3928,10 +4291,12 @@ export interface GetRelationalDatabaseMetricDataResult {
3928
4291
  */
3929
4292
  export interface GetRelationalDatabaseParametersRequest {
3930
4293
  /**
4294
+ * @public
3931
4295
  * <p>The name of your database for which to get parameters.</p>
3932
4296
  */
3933
4297
  relationalDatabaseName: string | undefined;
3934
4298
  /**
4299
+ * @public
3935
4300
  * <p>The token to advance to the next page of results from your request.</p>
3936
4301
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseParameters</code>
3937
4302
  * request. If your results are paginated, the response will return a next page token that you
@@ -3945,35 +4310,43 @@ export interface GetRelationalDatabaseParametersRequest {
3945
4310
  */
3946
4311
  export interface RelationalDatabaseParameter {
3947
4312
  /**
4313
+ * @public
3948
4314
  * <p>Specifies the valid range of values for the parameter.</p>
3949
4315
  */
3950
4316
  allowedValues?: string;
3951
4317
  /**
4318
+ * @public
3952
4319
  * <p>Indicates when parameter updates are applied.</p>
3953
4320
  * <p>Can be <code>immediate</code> or <code>pending-reboot</code>.</p>
3954
4321
  */
3955
4322
  applyMethod?: string;
3956
4323
  /**
4324
+ * @public
3957
4325
  * <p>Specifies the engine-specific parameter type.</p>
3958
4326
  */
3959
4327
  applyType?: string;
3960
4328
  /**
4329
+ * @public
3961
4330
  * <p>Specifies the valid data type for the parameter.</p>
3962
4331
  */
3963
4332
  dataType?: string;
3964
4333
  /**
4334
+ * @public
3965
4335
  * <p>Provides a description of the parameter.</p>
3966
4336
  */
3967
4337
  description?: string;
3968
4338
  /**
4339
+ * @public
3969
4340
  * <p>A Boolean value indicating whether the parameter can be modified.</p>
3970
4341
  */
3971
4342
  isModifiable?: boolean;
3972
4343
  /**
4344
+ * @public
3973
4345
  * <p>Specifies the name of the parameter.</p>
3974
4346
  */
3975
4347
  parameterName?: string;
3976
4348
  /**
4349
+ * @public
3977
4350
  * <p>Specifies the value of the parameter.</p>
3978
4351
  */
3979
4352
  parameterValue?: string;
@@ -3983,10 +4356,12 @@ export interface RelationalDatabaseParameter {
3983
4356
  */
3984
4357
  export interface GetRelationalDatabaseParametersResult {
3985
4358
  /**
4359
+ * @public
3986
4360
  * <p>An object describing the result of your get relational database parameters request.</p>
3987
4361
  */
3988
4362
  parameters?: RelationalDatabaseParameter[];
3989
4363
  /**
4364
+ * @public
3990
4365
  * <p>The token to advance to the next page of results from your request.</p>
3991
4366
  * <p>A next page token is not returned if there are no more results to display.</p>
3992
4367
  * <p>To get the next page of results, perform another
@@ -4000,6 +4375,7 @@ export interface GetRelationalDatabaseParametersResult {
4000
4375
  */
4001
4376
  export interface GetRelationalDatabasesRequest {
4002
4377
  /**
4378
+ * @public
4003
4379
  * <p>The token to advance to the next page of results from your request.</p>
4004
4380
  * <p>To get a page token, perform an initial <code>GetRelationalDatabases</code> request. If
4005
4381
  * your results are paginated, the response will return a next page token that you can specify as
@@ -4012,10 +4388,12 @@ export interface GetRelationalDatabasesRequest {
4012
4388
  */
4013
4389
  export interface GetRelationalDatabasesResult {
4014
4390
  /**
4391
+ * @public
4015
4392
  * <p>An object describing the result of your get relational databases request.</p>
4016
4393
  */
4017
4394
  relationalDatabases?: RelationalDatabase[];
4018
4395
  /**
4396
+ * @public
4019
4397
  * <p>The token to advance to the next page of results from your request.</p>
4020
4398
  * <p>A next page token is not returned if there are no more results to display.</p>
4021
4399
  * <p>To get the next page of results, perform another <code>GetRelationalDatabases</code>
@@ -4028,6 +4406,7 @@ export interface GetRelationalDatabasesResult {
4028
4406
  */
4029
4407
  export interface GetRelationalDatabaseSnapshotRequest {
4030
4408
  /**
4409
+ * @public
4031
4410
  * <p>The name of the database snapshot for which to get information.</p>
4032
4411
  */
4033
4412
  relationalDatabaseSnapshotName: string | undefined;
@@ -4038,68 +4417,83 @@ export interface GetRelationalDatabaseSnapshotRequest {
4038
4417
  */
4039
4418
  export interface RelationalDatabaseSnapshot {
4040
4419
  /**
4420
+ * @public
4041
4421
  * <p>The name of the database snapshot.</p>
4042
4422
  */
4043
4423
  name?: string;
4044
4424
  /**
4425
+ * @public
4045
4426
  * <p>The Amazon Resource Name (ARN) of the database snapshot.</p>
4046
4427
  */
4047
4428
  arn?: string;
4048
4429
  /**
4430
+ * @public
4049
4431
  * <p>The support code for the database snapshot. Include this code in your email to support
4050
4432
  * when you have questions about a database snapshot in Lightsail. This code enables our
4051
4433
  * support team to look up your Lightsail information more easily.</p>
4052
4434
  */
4053
4435
  supportCode?: string;
4054
4436
  /**
4437
+ * @public
4055
4438
  * <p>The timestamp when the database snapshot was created.</p>
4056
4439
  */
4057
4440
  createdAt?: Date;
4058
4441
  /**
4442
+ * @public
4059
4443
  * <p>The Region name and Availability Zone where the database snapshot is located.</p>
4060
4444
  */
4061
4445
  location?: ResourceLocation;
4062
4446
  /**
4447
+ * @public
4063
4448
  * <p>The Lightsail resource type.</p>
4064
4449
  */
4065
4450
  resourceType?: ResourceType | string;
4066
4451
  /**
4452
+ * @public
4067
4453
  * <p>The tag keys and optional values for the resource. For more information about tags in
4068
4454
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
4069
4455
  */
4070
4456
  tags?: Tag[];
4071
4457
  /**
4458
+ * @public
4072
4459
  * <p>The software of the database snapshot (for example, <code>MySQL</code>)</p>
4073
4460
  */
4074
4461
  engine?: string;
4075
4462
  /**
4463
+ * @public
4076
4464
  * <p>The database engine version for the database snapshot (for example,
4077
4465
  * <code>5.7.23</code>).</p>
4078
4466
  */
4079
4467
  engineVersion?: string;
4080
4468
  /**
4469
+ * @public
4081
4470
  * <p>The size of the disk in GB (for example, <code>32</code>) for the database
4082
4471
  * snapshot.</p>
4083
4472
  */
4084
4473
  sizeInGb?: number;
4085
4474
  /**
4475
+ * @public
4086
4476
  * <p>The state of the database snapshot.</p>
4087
4477
  */
4088
4478
  state?: string;
4089
4479
  /**
4480
+ * @public
4090
4481
  * <p>The name of the source database from which the database snapshot was created.</p>
4091
4482
  */
4092
4483
  fromRelationalDatabaseName?: string;
4093
4484
  /**
4485
+ * @public
4094
4486
  * <p>The Amazon Resource Name (ARN) of the database from which the database snapshot was
4095
4487
  * created.</p>
4096
4488
  */
4097
4489
  fromRelationalDatabaseArn?: string;
4098
4490
  /**
4491
+ * @public
4099
4492
  * <p>The bundle ID of the database from which the database snapshot was created.</p>
4100
4493
  */
4101
4494
  fromRelationalDatabaseBundleId?: string;
4102
4495
  /**
4496
+ * @public
4103
4497
  * <p>The blueprint ID of the database from which the database snapshot was created. A blueprint
4104
4498
  * describes the major engine version of a database.</p>
4105
4499
  */
@@ -4110,6 +4504,7 @@ export interface RelationalDatabaseSnapshot {
4110
4504
  */
4111
4505
  export interface GetRelationalDatabaseSnapshotResult {
4112
4506
  /**
4507
+ * @public
4113
4508
  * <p>An object describing the specified database snapshot.</p>
4114
4509
  */
4115
4510
  relationalDatabaseSnapshot?: RelationalDatabaseSnapshot;
@@ -4119,6 +4514,7 @@ export interface GetRelationalDatabaseSnapshotResult {
4119
4514
  */
4120
4515
  export interface GetRelationalDatabaseSnapshotsRequest {
4121
4516
  /**
4517
+ * @public
4122
4518
  * <p>The token to advance to the next page of results from your request.</p>
4123
4519
  * <p>To get a page token, perform an initial <code>GetRelationalDatabaseSnapshots</code>
4124
4520
  * request. If your results are paginated, the response will return a next page token that you
@@ -4131,10 +4527,12 @@ export interface GetRelationalDatabaseSnapshotsRequest {
4131
4527
  */
4132
4528
  export interface GetRelationalDatabaseSnapshotsResult {
4133
4529
  /**
4530
+ * @public
4134
4531
  * <p>An object describing the result of your get relational database snapshots request.</p>
4135
4532
  */
4136
4533
  relationalDatabaseSnapshots?: RelationalDatabaseSnapshot[];
4137
4534
  /**
4535
+ * @public
4138
4536
  * <p>The token to advance to the next page of results from your request.</p>
4139
4537
  * <p>A next page token is not returned if there are no more results to display.</p>
4140
4538
  * <p>To get the next page of results, perform another
@@ -4148,6 +4546,7 @@ export interface GetRelationalDatabaseSnapshotsResult {
4148
4546
  */
4149
4547
  export interface GetStaticIpRequest {
4150
4548
  /**
4549
+ * @public
4151
4550
  * <p>The name of the static IP in Lightsail.</p>
4152
4551
  */
4153
4552
  staticIpName: string | undefined;
@@ -4158,42 +4557,51 @@ export interface GetStaticIpRequest {
4158
4557
  */
4159
4558
  export interface StaticIp {
4160
4559
  /**
4560
+ * @public
4161
4561
  * <p>The name of the static IP (e.g., <code>StaticIP-Ohio-EXAMPLE</code>).</p>
4162
4562
  */
4163
4563
  name?: string;
4164
4564
  /**
4565
+ * @public
4165
4566
  * <p>The Amazon Resource Name (ARN) of the static IP (e.g.,
4166
4567
  * <code>arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE</code>).</p>
4167
4568
  */
4168
4569
  arn?: string;
4169
4570
  /**
4571
+ * @public
4170
4572
  * <p>The support code. Include this code in your email to support when you have questions about
4171
4573
  * an instance or another resource in Lightsail. This code enables our support team to look up
4172
4574
  * your Lightsail information more easily.</p>
4173
4575
  */
4174
4576
  supportCode?: string;
4175
4577
  /**
4578
+ * @public
4176
4579
  * <p>The timestamp when the static IP was created (e.g., <code>1479735304.222</code>).</p>
4177
4580
  */
4178
4581
  createdAt?: Date;
4179
4582
  /**
4583
+ * @public
4180
4584
  * <p>The region and Availability Zone where the static IP was created.</p>
4181
4585
  */
4182
4586
  location?: ResourceLocation;
4183
4587
  /**
4588
+ * @public
4184
4589
  * <p>The resource type (usually <code>StaticIp</code>).</p>
4185
4590
  */
4186
4591
  resourceType?: ResourceType | string;
4187
4592
  /**
4593
+ * @public
4188
4594
  * <p>The static IP address.</p>
4189
4595
  */
4190
4596
  ipAddress?: string;
4191
4597
  /**
4598
+ * @public
4192
4599
  * <p>The instance where the static IP is attached (e.g.,
4193
4600
  * <code>Amazon_Linux-1GB-Ohio-1</code>).</p>
4194
4601
  */
4195
4602
  attachedTo?: string;
4196
4603
  /**
4604
+ * @public
4197
4605
  * <p>A Boolean value indicating whether the static IP is attached.</p>
4198
4606
  */
4199
4607
  isAttached?: boolean;
@@ -4203,6 +4611,7 @@ export interface StaticIp {
4203
4611
  */
4204
4612
  export interface GetStaticIpResult {
4205
4613
  /**
4614
+ * @public
4206
4615
  * <p>An array of key-value pairs containing information about the requested static IP.</p>
4207
4616
  */
4208
4617
  staticIp?: StaticIp;
@@ -4212,6 +4621,7 @@ export interface GetStaticIpResult {
4212
4621
  */
4213
4622
  export interface GetStaticIpsRequest {
4214
4623
  /**
4624
+ * @public
4215
4625
  * <p>The token to advance to the next page of results from your request.</p>
4216
4626
  * <p>To get a page token, perform an initial <code>GetStaticIps</code> request. If your results
4217
4627
  * are paginated, the response will return a next page token that you can specify as the page
@@ -4224,11 +4634,13 @@ export interface GetStaticIpsRequest {
4224
4634
  */
4225
4635
  export interface GetStaticIpsResult {
4226
4636
  /**
4637
+ * @public
4227
4638
  * <p>An array of key-value pairs containing information about your get static IPs
4228
4639
  * request.</p>
4229
4640
  */
4230
4641
  staticIps?: StaticIp[];
4231
4642
  /**
4643
+ * @public
4232
4644
  * <p>The token to advance to the next page of results from your request.</p>
4233
4645
  * <p>A next page token is not returned if there are no more results to display.</p>
4234
4646
  * <p>To get the next page of results, perform another <code>GetStaticIps</code> request and
@@ -4241,10 +4653,12 @@ export interface GetStaticIpsResult {
4241
4653
  */
4242
4654
  export interface ImportKeyPairRequest {
4243
4655
  /**
4656
+ * @public
4244
4657
  * <p>The name of the key pair for which you want to import the public key.</p>
4245
4658
  */
4246
4659
  keyPairName: string | undefined;
4247
4660
  /**
4661
+ * @public
4248
4662
  * <p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>
4249
4663
  */
4250
4664
  publicKeyBase64: string | undefined;
@@ -4254,6 +4668,7 @@ export interface ImportKeyPairRequest {
4254
4668
  */
4255
4669
  export interface ImportKeyPairResult {
4256
4670
  /**
4671
+ * @public
4257
4672
  * <p>An array of objects that describe the result of the action, such as the status of the
4258
4673
  * request, the timestamp of the request, and the resources affected by the request.</p>
4259
4674
  */
@@ -4269,6 +4684,7 @@ export interface IsVpcPeeredRequest {
4269
4684
  */
4270
4685
  export interface IsVpcPeeredResult {
4271
4686
  /**
4687
+ * @public
4272
4688
  * <p>Returns <code>true</code> if the Lightsail VPC is peered; otherwise,
4273
4689
  * <code>false</code>.</p>
4274
4690
  */
@@ -4279,10 +4695,12 @@ export interface IsVpcPeeredResult {
4279
4695
  */
4280
4696
  export interface OpenInstancePublicPortsRequest {
4281
4697
  /**
4698
+ * @public
4282
4699
  * <p>An object to describe the ports to open for the specified instance.</p>
4283
4700
  */
4284
4701
  portInfo: PortInfo | undefined;
4285
4702
  /**
4703
+ * @public
4286
4704
  * <p>The name of the instance for which to open ports.</p>
4287
4705
  */
4288
4706
  instanceName: string | undefined;
@@ -4292,6 +4710,7 @@ export interface OpenInstancePublicPortsRequest {
4292
4710
  */
4293
4711
  export interface OpenInstancePublicPortsResult {
4294
4712
  /**
4713
+ * @public
4295
4714
  * <p>An array of objects that describe the result of the action, such as the status of the
4296
4715
  * request, the timestamp of the request, and the resources affected by the request.</p>
4297
4716
  */
@@ -4307,6 +4726,7 @@ export interface PeerVpcRequest {
4307
4726
  */
4308
4727
  export interface PeerVpcResult {
4309
4728
  /**
4729
+ * @public
4310
4730
  * <p>An array of objects that describe the result of the action, such as the status of the
4311
4731
  * request, the timestamp of the request, and the resources affected by the request.</p>
4312
4732
  */
@@ -4317,11 +4737,13 @@ export interface PeerVpcResult {
4317
4737
  */
4318
4738
  export interface PutAlarmRequest {
4319
4739
  /**
4740
+ * @public
4320
4741
  * <p>The name for the alarm. Specify the name of an existing alarm to update, and overwrite the
4321
4742
  * previous configuration of the alarm.</p>
4322
4743
  */
4323
4744
  alarmName: string | undefined;
4324
4745
  /**
4746
+ * @public
4325
4747
  * <p>The name of the metric to associate with the alarm.</p>
4326
4748
  * <p>You can configure up to two alarms per metric.</p>
4327
4749
  * <p>The following metrics are available for each resource type:</p>
@@ -4356,21 +4778,25 @@ export interface PutAlarmRequest {
4356
4778
  */
4357
4779
  metricName: MetricName | string | undefined;
4358
4780
  /**
4781
+ * @public
4359
4782
  * <p>The name of the Lightsail resource that will be monitored.</p>
4360
4783
  * <p>Instances, load balancers, and relational databases are the only Lightsail resources
4361
4784
  * that can currently be monitored by alarms.</p>
4362
4785
  */
4363
4786
  monitoredResourceName: string | undefined;
4364
4787
  /**
4788
+ * @public
4365
4789
  * <p>The arithmetic operation to use when comparing the specified statistic to the threshold.
4366
4790
  * The specified statistic value is used as the first operand.</p>
4367
4791
  */
4368
4792
  comparisonOperator: ComparisonOperator | string | undefined;
4369
4793
  /**
4794
+ * @public
4370
4795
  * <p>The value against which the specified statistic is compared.</p>
4371
4796
  */
4372
4797
  threshold: number | undefined;
4373
4798
  /**
4799
+ * @public
4374
4800
  * <p>The number of most recent periods over which data is compared to the specified threshold.
4375
4801
  * If you are setting an "M out of N" alarm, this value (<code>evaluationPeriods</code>) is the
4376
4802
  * N.</p>
@@ -4384,12 +4810,14 @@ export interface PutAlarmRequest {
4384
4810
  */
4385
4811
  evaluationPeriods: number | undefined;
4386
4812
  /**
4813
+ * @public
4387
4814
  * <p>The number of data points that must be not within the specified threshold to trigger the
4388
4815
  * alarm. If you are setting an "M out of N" alarm, this value (<code>datapointsToAlarm</code>)
4389
4816
  * is the M.</p>
4390
4817
  */
4391
4818
  datapointsToAlarm?: number;
4392
4819
  /**
4820
+ * @public
4393
4821
  * <p>Sets how this alarm will handle missing data points.</p>
4394
4822
  * <p>An alarm can treat missing data in the following ways:</p>
4395
4823
  * <ul>
@@ -4419,6 +4847,7 @@ export interface PutAlarmRequest {
4419
4847
  */
4420
4848
  treatMissingData?: TreatMissingData | string;
4421
4849
  /**
4850
+ * @public
4422
4851
  * <p>The contact protocols to use for the alarm, such as <code>Email</code>, <code>SMS</code>
4423
4852
  * (text messaging), or both.</p>
4424
4853
  * <p>A notification is sent via the specified contact protocol if notifications are enabled for
@@ -4431,6 +4860,7 @@ export interface PutAlarmRequest {
4431
4860
  */
4432
4861
  contactProtocols?: (ContactProtocol | string)[];
4433
4862
  /**
4863
+ * @public
4434
4864
  * <p>The alarm states that trigger a notification.</p>
4435
4865
  * <p>An alarm has the following possible states:</p>
4436
4866
  * <ul>
@@ -4470,6 +4900,7 @@ export interface PutAlarmRequest {
4470
4900
  */
4471
4901
  notificationTriggers?: (AlarmState | string)[];
4472
4902
  /**
4903
+ * @public
4473
4904
  * <p>Indicates whether the alarm is enabled.</p>
4474
4905
  * <p>Notifications are enabled by default if you don't specify this parameter.</p>
4475
4906
  */
@@ -4480,6 +4911,7 @@ export interface PutAlarmRequest {
4480
4911
  */
4481
4912
  export interface PutAlarmResult {
4482
4913
  /**
4914
+ * @public
4483
4915
  * <p>An array of objects that describe the result of the action, such as the status of the
4484
4916
  * request, the timestamp of the request, and the resources affected by the request.</p>
4485
4917
  */
@@ -4490,10 +4922,12 @@ export interface PutAlarmResult {
4490
4922
  */
4491
4923
  export interface PutInstancePublicPortsRequest {
4492
4924
  /**
4925
+ * @public
4493
4926
  * <p>An array of objects to describe the ports to open for the specified instance.</p>
4494
4927
  */
4495
4928
  portInfos: PortInfo[] | undefined;
4496
4929
  /**
4930
+ * @public
4497
4931
  * <p>The name of the instance for which to open ports.</p>
4498
4932
  */
4499
4933
  instanceName: string | undefined;
@@ -4503,6 +4937,7 @@ export interface PutInstancePublicPortsRequest {
4503
4937
  */
4504
4938
  export interface PutInstancePublicPortsResult {
4505
4939
  /**
4940
+ * @public
4506
4941
  * <p>An array of objects that describe the result of the action, such as the status of the
4507
4942
  * request, the timestamp of the request, and the resources affected by the request.</p>
4508
4943
  */
@@ -4513,6 +4948,7 @@ export interface PutInstancePublicPortsResult {
4513
4948
  */
4514
4949
  export interface RebootInstanceRequest {
4515
4950
  /**
4951
+ * @public
4516
4952
  * <p>The name of the instance to reboot.</p>
4517
4953
  */
4518
4954
  instanceName: string | undefined;
@@ -4522,6 +4958,7 @@ export interface RebootInstanceRequest {
4522
4958
  */
4523
4959
  export interface RebootInstanceResult {
4524
4960
  /**
4961
+ * @public
4525
4962
  * <p>An array of objects that describe the result of the action, such as the status of the
4526
4963
  * request, the timestamp of the request, and the resources affected by the request.</p>
4527
4964
  */
@@ -4532,6 +4969,7 @@ export interface RebootInstanceResult {
4532
4969
  */
4533
4970
  export interface RebootRelationalDatabaseRequest {
4534
4971
  /**
4972
+ * @public
4535
4973
  * <p>The name of your database to reboot.</p>
4536
4974
  */
4537
4975
  relationalDatabaseName: string | undefined;
@@ -4541,6 +4979,7 @@ export interface RebootRelationalDatabaseRequest {
4541
4979
  */
4542
4980
  export interface RebootRelationalDatabaseResult {
4543
4981
  /**
4982
+ * @public
4544
4983
  * <p>An array of objects that describe the result of the action, such as the status of the
4545
4984
  * request, the timestamp of the request, and the resources affected by the request.</p>
4546
4985
  */
@@ -4551,10 +4990,12 @@ export interface RebootRelationalDatabaseResult {
4551
4990
  */
4552
4991
  export interface RegisterContainerImageRequest {
4553
4992
  /**
4993
+ * @public
4554
4994
  * <p>The name of the container service for which to register a container image.</p>
4555
4995
  */
4556
4996
  serviceName: string | undefined;
4557
4997
  /**
4998
+ * @public
4558
4999
  * <p>The label for the container image when it's registered to the container service.</p>
4559
5000
  * <p>Use a descriptive label that you can use to track the different versions of your
4560
5001
  * registered container images.</p>
@@ -4579,6 +5020,7 @@ export interface RegisterContainerImageRequest {
4579
5020
  */
4580
5021
  label: string | undefined;
4581
5022
  /**
5023
+ * @public
4582
5024
  * <p>The digest of the container image to be registered.</p>
4583
5025
  */
4584
5026
  digest: string | undefined;
@@ -4588,6 +5030,7 @@ export interface RegisterContainerImageRequest {
4588
5030
  */
4589
5031
  export interface RegisterContainerImageResult {
4590
5032
  /**
5033
+ * @public
4591
5034
  * <p>An object that describes a container image that is registered to a Lightsail container
4592
5035
  * service</p>
4593
5036
  */
@@ -4598,6 +5041,7 @@ export interface RegisterContainerImageResult {
4598
5041
  */
4599
5042
  export interface ReleaseStaticIpRequest {
4600
5043
  /**
5044
+ * @public
4601
5045
  * <p>The name of the static IP to delete.</p>
4602
5046
  */
4603
5047
  staticIpName: string | undefined;
@@ -4607,6 +5051,7 @@ export interface ReleaseStaticIpRequest {
4607
5051
  */
4608
5052
  export interface ReleaseStaticIpResult {
4609
5053
  /**
5054
+ * @public
4610
5055
  * <p>An array of objects that describe the result of the action, such as the status of the
4611
5056
  * request, the timestamp of the request, and the resources affected by the request.</p>
4612
5057
  */
@@ -4617,6 +5062,7 @@ export interface ReleaseStaticIpResult {
4617
5062
  */
4618
5063
  export interface ResetDistributionCacheRequest {
4619
5064
  /**
5065
+ * @public
4620
5066
  * <p>The name of the distribution for which to reset cache.</p>
4621
5067
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
4622
5068
  * can specify.</p>
@@ -4628,15 +5074,18 @@ export interface ResetDistributionCacheRequest {
4628
5074
  */
4629
5075
  export interface ResetDistributionCacheResult {
4630
5076
  /**
5077
+ * @public
4631
5078
  * <p>The status of the reset cache request.</p>
4632
5079
  */
4633
5080
  status?: string;
4634
5081
  /**
5082
+ * @public
4635
5083
  * <p>The timestamp of the reset cache request (e.g., <code>1479734909.17</code>) in Unix time
4636
5084
  * format.</p>
4637
5085
  */
4638
5086
  createTime?: Date;
4639
5087
  /**
5088
+ * @public
4640
5089
  * <p>An array of objects that describe the result of the action, such as the status of the
4641
5090
  * request, the timestamp of the request, and the resources affected by the request.</p>
4642
5091
  */
@@ -4647,6 +5096,7 @@ export interface ResetDistributionCacheResult {
4647
5096
  */
4648
5097
  export interface SendContactMethodVerificationRequest {
4649
5098
  /**
5099
+ * @public
4650
5100
  * <p>The protocol to verify, such as <code>Email</code> or <code>SMS</code> (text
4651
5101
  * messaging).</p>
4652
5102
  */
@@ -4657,6 +5107,7 @@ export interface SendContactMethodVerificationRequest {
4657
5107
  */
4658
5108
  export interface SendContactMethodVerificationResult {
4659
5109
  /**
5110
+ * @public
4660
5111
  * <p>An array of objects that describe the result of the action, such as the status of the
4661
5112
  * request, the timestamp of the request, and the resources affected by the request.</p>
4662
5113
  */
@@ -4667,6 +5118,7 @@ export interface SendContactMethodVerificationResult {
4667
5118
  */
4668
5119
  export interface SetIpAddressTypeRequest {
4669
5120
  /**
5121
+ * @public
4670
5122
  * <p>The resource type.</p>
4671
5123
  * <p>The possible values are <code>Distribution</code>, <code>Instance</code>, and
4672
5124
  * <code>LoadBalancer</code>.</p>
@@ -4678,10 +5130,12 @@ export interface SetIpAddressTypeRequest {
4678
5130
  */
4679
5131
  resourceType: ResourceType | string | undefined;
4680
5132
  /**
5133
+ * @public
4681
5134
  * <p>The name of the resource for which to set the IP address type.</p>
4682
5135
  */
4683
5136
  resourceName: string | undefined;
4684
5137
  /**
5138
+ * @public
4685
5139
  * <p>The IP address type to set for the specified resource.</p>
4686
5140
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
4687
5141
  * IPv4 and IPv6.</p>
@@ -4693,6 +5147,7 @@ export interface SetIpAddressTypeRequest {
4693
5147
  */
4694
5148
  export interface SetIpAddressTypeResult {
4695
5149
  /**
5150
+ * @public
4696
5151
  * <p>An array of objects that describe the result of the action, such as the status of the
4697
5152
  * request, the timestamp of the request, and the resources affected by the request.</p>
4698
5153
  */
@@ -4715,15 +5170,18 @@ export type ResourceBucketAccess = (typeof ResourceBucketAccess)[keyof typeof Re
4715
5170
  */
4716
5171
  export interface SetResourceAccessForBucketRequest {
4717
5172
  /**
5173
+ * @public
4718
5174
  * <p>The name of the Lightsail instance for which to set bucket access. The instance must be
4719
5175
  * in a running or stopped state.</p>
4720
5176
  */
4721
5177
  resourceName: string | undefined;
4722
5178
  /**
5179
+ * @public
4723
5180
  * <p>The name of the bucket for which to set access to another Lightsail resource.</p>
4724
5181
  */
4725
5182
  bucketName: string | undefined;
4726
5183
  /**
5184
+ * @public
4727
5185
  * <p>The access setting.</p>
4728
5186
  * <p>The following access settings are available:</p>
4729
5187
  * <ul>
@@ -4745,6 +5203,7 @@ export interface SetResourceAccessForBucketRequest {
4745
5203
  */
4746
5204
  export interface SetResourceAccessForBucketResult {
4747
5205
  /**
5206
+ * @public
4748
5207
  * <p>An array of objects that describe the result of the action, such as the status of the
4749
5208
  * request, the timestamp of the request, and the resources affected by the request.</p>
4750
5209
  */
@@ -4755,6 +5214,7 @@ export interface SetResourceAccessForBucketResult {
4755
5214
  */
4756
5215
  export interface StartGUISessionRequest {
4757
5216
  /**
5217
+ * @public
4758
5218
  * <p>The resource name.</p>
4759
5219
  */
4760
5220
  resourceName: string | undefined;
@@ -4764,6 +5224,7 @@ export interface StartGUISessionRequest {
4764
5224
  */
4765
5225
  export interface StartGUISessionResult {
4766
5226
  /**
5227
+ * @public
4767
5228
  * <p>The available API operations.</p>
4768
5229
  */
4769
5230
  operations?: Operation[];
@@ -4773,6 +5234,7 @@ export interface StartGUISessionResult {
4773
5234
  */
4774
5235
  export interface StartInstanceRequest {
4775
5236
  /**
5237
+ * @public
4776
5238
  * <p>The name of the instance (a virtual private server) to start.</p>
4777
5239
  */
4778
5240
  instanceName: string | undefined;
@@ -4782,6 +5244,7 @@ export interface StartInstanceRequest {
4782
5244
  */
4783
5245
  export interface StartInstanceResult {
4784
5246
  /**
5247
+ * @public
4785
5248
  * <p>An array of objects that describe the result of the action, such as the status of the
4786
5249
  * request, the timestamp of the request, and the resources affected by the request.</p>
4787
5250
  */
@@ -4792,6 +5255,7 @@ export interface StartInstanceResult {
4792
5255
  */
4793
5256
  export interface StartRelationalDatabaseRequest {
4794
5257
  /**
5258
+ * @public
4795
5259
  * <p>The name of your database to start.</p>
4796
5260
  */
4797
5261
  relationalDatabaseName: string | undefined;
@@ -4801,6 +5265,7 @@ export interface StartRelationalDatabaseRequest {
4801
5265
  */
4802
5266
  export interface StartRelationalDatabaseResult {
4803
5267
  /**
5268
+ * @public
4804
5269
  * <p>An array of objects that describe the result of the action, such as the status of the
4805
5270
  * request, the timestamp of the request, and the resources affected by the request.</p>
4806
5271
  */
@@ -4811,6 +5276,7 @@ export interface StartRelationalDatabaseResult {
4811
5276
  */
4812
5277
  export interface StopGUISessionRequest {
4813
5278
  /**
5279
+ * @public
4814
5280
  * <p>The resource name.</p>
4815
5281
  */
4816
5282
  resourceName: string | undefined;
@@ -4820,6 +5286,7 @@ export interface StopGUISessionRequest {
4820
5286
  */
4821
5287
  export interface StopGUISessionResult {
4822
5288
  /**
5289
+ * @public
4823
5290
  * <p>The available API operations.</p>
4824
5291
  */
4825
5292
  operations?: Operation[];
@@ -4829,10 +5296,12 @@ export interface StopGUISessionResult {
4829
5296
  */
4830
5297
  export interface StopInstanceRequest {
4831
5298
  /**
5299
+ * @public
4832
5300
  * <p>The name of the instance (a virtual private server) to stop.</p>
4833
5301
  */
4834
5302
  instanceName: string | undefined;
4835
5303
  /**
5304
+ * @public
4836
5305
  * <p>When set to <code>True</code>, forces a Lightsail instance that is stuck in a
4837
5306
  * <code>stopping</code> state to stop.</p>
4838
5307
  * <important>
@@ -4848,6 +5317,7 @@ export interface StopInstanceRequest {
4848
5317
  */
4849
5318
  export interface StopInstanceResult {
4850
5319
  /**
5320
+ * @public
4851
5321
  * <p>An array of objects that describe the result of the action, such as the status of the
4852
5322
  * request, the timestamp of the request, and the resources affected by the request.</p>
4853
5323
  */
@@ -4858,10 +5328,12 @@ export interface StopInstanceResult {
4858
5328
  */
4859
5329
  export interface StopRelationalDatabaseRequest {
4860
5330
  /**
5331
+ * @public
4861
5332
  * <p>The name of your database to stop.</p>
4862
5333
  */
4863
5334
  relationalDatabaseName: string | undefined;
4864
5335
  /**
5336
+ * @public
4865
5337
  * <p>The name of your new database snapshot to be created before stopping your database.</p>
4866
5338
  */
4867
5339
  relationalDatabaseSnapshotName?: string;
@@ -4871,6 +5343,7 @@ export interface StopRelationalDatabaseRequest {
4871
5343
  */
4872
5344
  export interface StopRelationalDatabaseResult {
4873
5345
  /**
5346
+ * @public
4874
5347
  * <p>An array of objects that describe the result of the action, such as the status of the
4875
5348
  * request, the timestamp of the request, and the resources affected by the request.</p>
4876
5349
  */
@@ -4881,14 +5354,17 @@ export interface StopRelationalDatabaseResult {
4881
5354
  */
4882
5355
  export interface TagResourceRequest {
4883
5356
  /**
5357
+ * @public
4884
5358
  * <p>The name of the resource to which you are adding tags.</p>
4885
5359
  */
4886
5360
  resourceName: string | undefined;
4887
5361
  /**
5362
+ * @public
4888
5363
  * <p>The Amazon Resource Name (ARN) of the resource to which you want to add a tag.</p>
4889
5364
  */
4890
5365
  resourceArn?: string;
4891
5366
  /**
5367
+ * @public
4892
5368
  * <p>The tag key and optional value.</p>
4893
5369
  */
4894
5370
  tags: Tag[] | undefined;
@@ -4898,6 +5374,7 @@ export interface TagResourceRequest {
4898
5374
  */
4899
5375
  export interface TagResourceResult {
4900
5376
  /**
5377
+ * @public
4901
5378
  * <p>An array of objects that describe the result of the action, such as the status of the
4902
5379
  * request, the timestamp of the request, and the resources affected by the request.</p>
4903
5380
  */
@@ -4908,10 +5385,12 @@ export interface TagResourceResult {
4908
5385
  */
4909
5386
  export interface TestAlarmRequest {
4910
5387
  /**
5388
+ * @public
4911
5389
  * <p>The name of the alarm to test.</p>
4912
5390
  */
4913
5391
  alarmName: string | undefined;
4914
5392
  /**
5393
+ * @public
4915
5394
  * <p>The alarm state to test.</p>
4916
5395
  * <p>An alarm has the following possible states that can be tested:</p>
4917
5396
  * <ul>
@@ -4938,6 +5417,7 @@ export interface TestAlarmRequest {
4938
5417
  */
4939
5418
  export interface TestAlarmResult {
4940
5419
  /**
5420
+ * @public
4941
5421
  * <p>An array of objects that describe the result of the action, such as the status of the
4942
5422
  * request, the timestamp of the request, and the resources affected by the request.</p>
4943
5423
  */
@@ -4953,6 +5433,7 @@ export interface UnpeerVpcRequest {
4953
5433
  */
4954
5434
  export interface UnpeerVpcResult {
4955
5435
  /**
5436
+ * @public
4956
5437
  * <p>An array of objects that describe the result of the action, such as the status of the
4957
5438
  * request, the timestamp of the request, and the resources affected by the request.</p>
4958
5439
  */
@@ -4963,14 +5444,17 @@ export interface UnpeerVpcResult {
4963
5444
  */
4964
5445
  export interface UntagResourceRequest {
4965
5446
  /**
5447
+ * @public
4966
5448
  * <p>The name of the resource from which you are removing a tag.</p>
4967
5449
  */
4968
5450
  resourceName: string | undefined;
4969
5451
  /**
5452
+ * @public
4970
5453
  * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.</p>
4971
5454
  */
4972
5455
  resourceArn?: string;
4973
5456
  /**
5457
+ * @public
4974
5458
  * <p>The tag keys to delete from the specified resource.</p>
4975
5459
  */
4976
5460
  tagKeys: string[] | undefined;
@@ -4980,6 +5464,7 @@ export interface UntagResourceRequest {
4980
5464
  */
4981
5465
  export interface UntagResourceResult {
4982
5466
  /**
5467
+ * @public
4983
5468
  * <p>An array of objects that describe the result of the action, such as the status of the
4984
5469
  * request, the timestamp of the request, and the resources affected by the request.</p>
4985
5470
  */
@@ -4990,14 +5475,17 @@ export interface UntagResourceResult {
4990
5475
  */
4991
5476
  export interface UpdateBucketRequest {
4992
5477
  /**
5478
+ * @public
4993
5479
  * <p>The name of the bucket to update.</p>
4994
5480
  */
4995
5481
  bucketName: string | undefined;
4996
5482
  /**
5483
+ * @public
4997
5484
  * <p>An object that sets the public accessibility of objects in the specified bucket.</p>
4998
5485
  */
4999
5486
  accessRules?: AccessRules;
5000
5487
  /**
5488
+ * @public
5001
5489
  * <p>Specifies whether to enable or suspend versioning of objects in the bucket.</p>
5002
5490
  * <p>The following options can be specified:</p>
5003
5491
  * <ul>
@@ -5014,12 +5502,14 @@ export interface UpdateBucketRequest {
5014
5502
  */
5015
5503
  versioning?: string;
5016
5504
  /**
5505
+ * @public
5017
5506
  * <p>An array of strings to specify the Amazon Web Services account IDs that can access the
5018
5507
  * bucket.</p>
5019
5508
  * <p>You can give a maximum of 10 Amazon Web Services accounts access to a bucket.</p>
5020
5509
  */
5021
5510
  readonlyAccessAccounts?: string[];
5022
5511
  /**
5512
+ * @public
5023
5513
  * <p>An object that describes the access log configuration for the bucket.</p>
5024
5514
  */
5025
5515
  accessLogConfig?: BucketAccessLogConfig;
@@ -5029,10 +5519,12 @@ export interface UpdateBucketRequest {
5029
5519
  */
5030
5520
  export interface UpdateBucketResult {
5031
5521
  /**
5522
+ * @public
5032
5523
  * <p>An object that describes the bucket that is updated.</p>
5033
5524
  */
5034
5525
  bucket?: Bucket;
5035
5526
  /**
5527
+ * @public
5036
5528
  * <p>An array of objects that describe the result of the action, such as the status of the
5037
5529
  * request, the timestamp of the request, and the resources affected by the request.</p>
5038
5530
  */
@@ -5043,10 +5535,12 @@ export interface UpdateBucketResult {
5043
5535
  */
5044
5536
  export interface UpdateBucketBundleRequest {
5045
5537
  /**
5538
+ * @public
5046
5539
  * <p>The name of the bucket for which to update the bundle.</p>
5047
5540
  */
5048
5541
  bucketName: string | undefined;
5049
5542
  /**
5543
+ * @public
5050
5544
  * <p>The ID of the new bundle to apply to the bucket.</p>
5051
5545
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html">GetBucketBundles</a> action to get a list of
5052
5546
  * bundle IDs that you can specify.</p>
@@ -5058,6 +5552,7 @@ export interface UpdateBucketBundleRequest {
5058
5552
  */
5059
5553
  export interface UpdateBucketBundleResult {
5060
5554
  /**
5555
+ * @public
5061
5556
  * <p>An array of objects that describe the result of the action, such as the status of the
5062
5557
  * request, the timestamp of the request, and the resources affected by the request.</p>
5063
5558
  */
@@ -5068,10 +5563,12 @@ export interface UpdateBucketBundleResult {
5068
5563
  */
5069
5564
  export interface UpdateContainerServiceRequest {
5070
5565
  /**
5566
+ * @public
5071
5567
  * <p>The name of the container service to update.</p>
5072
5568
  */
5073
5569
  serviceName: string | undefined;
5074
5570
  /**
5571
+ * @public
5075
5572
  * <p>The power for the container service.</p>
5076
5573
  * <p>The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the
5077
5574
  * container service. The <code>power</code> and <code>scale</code> of a container service makes
@@ -5083,6 +5580,7 @@ export interface UpdateContainerServiceRequest {
5083
5580
  */
5084
5581
  power?: ContainerServicePowerName | string;
5085
5582
  /**
5583
+ * @public
5086
5584
  * <p>The scale for the container service.</p>
5087
5585
  * <p>The scale specifies the allocated compute nodes of the container service. The
5088
5586
  * <code>power</code> and <code>scale</code> of a container service makes up its configured
@@ -5092,10 +5590,12 @@ export interface UpdateContainerServiceRequest {
5092
5590
  */
5093
5591
  scale?: number;
5094
5592
  /**
5593
+ * @public
5095
5594
  * <p>A Boolean value to indicate whether the container service is disabled.</p>
5096
5595
  */
5097
5596
  isDisabled?: boolean;
5098
5597
  /**
5598
+ * @public
5099
5599
  * <p>The public domain names to use with the container service, such as
5100
5600
  * <code>example.com</code> and <code>www.example.com</code>.</p>
5101
5601
  * <p>You can specify up to four public domain names for a container service. The domain names
@@ -5113,6 +5613,7 @@ export interface UpdateContainerServiceRequest {
5113
5613
  */
5114
5614
  publicDomainNames?: Record<string, string[]>;
5115
5615
  /**
5616
+ * @public
5116
5617
  * <p>An object to describe the configuration for the container service to access private
5117
5618
  * container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private
5118
5619
  * repositories.</p>
@@ -5125,6 +5626,7 @@ export interface UpdateContainerServiceRequest {
5125
5626
  */
5126
5627
  export interface UpdateContainerServiceResult {
5127
5628
  /**
5629
+ * @public
5128
5630
  * <p>An object that describes a container service.</p>
5129
5631
  */
5130
5632
  containerService?: ContainerService;
@@ -5134,22 +5636,26 @@ export interface UpdateContainerServiceResult {
5134
5636
  */
5135
5637
  export interface UpdateDistributionRequest {
5136
5638
  /**
5639
+ * @public
5137
5640
  * <p>The name of the distribution to update.</p>
5138
5641
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
5139
5642
  * can specify.</p>
5140
5643
  */
5141
5644
  distributionName: string | undefined;
5142
5645
  /**
5646
+ * @public
5143
5647
  * <p>An object that describes the origin resource for the distribution, such as a Lightsail
5144
5648
  * instance, bucket, or load balancer.</p>
5145
5649
  * <p>The distribution pulls, caches, and serves content from the origin.</p>
5146
5650
  */
5147
5651
  origin?: InputOrigin;
5148
5652
  /**
5653
+ * @public
5149
5654
  * <p>An object that describes the default cache behavior for the distribution.</p>
5150
5655
  */
5151
5656
  defaultCacheBehavior?: CacheBehavior;
5152
5657
  /**
5658
+ * @public
5153
5659
  * <p>An object that describes the cache behavior settings for the distribution.</p>
5154
5660
  * <note>
5155
5661
  * <p>The <code>cacheBehaviorSettings</code> specified in your
@@ -5159,10 +5665,12 @@ export interface UpdateDistributionRequest {
5159
5665
  */
5160
5666
  cacheBehaviorSettings?: CacheSettings;
5161
5667
  /**
5668
+ * @public
5162
5669
  * <p>An array of objects that describe the per-path cache behavior for the distribution.</p>
5163
5670
  */
5164
5671
  cacheBehaviors?: CacheBehaviorPerPath[];
5165
5672
  /**
5673
+ * @public
5166
5674
  * <p>Indicates whether to enable the distribution.</p>
5167
5675
  */
5168
5676
  isEnabled?: boolean;
@@ -5172,6 +5680,7 @@ export interface UpdateDistributionRequest {
5172
5680
  */
5173
5681
  export interface UpdateDistributionResult {
5174
5682
  /**
5683
+ * @public
5175
5684
  * <p>An array of objects that describe the result of the action, such as the status of the
5176
5685
  * request, the timestamp of the request, and the resources affected by the request.</p>
5177
5686
  */
@@ -5182,12 +5691,14 @@ export interface UpdateDistributionResult {
5182
5691
  */
5183
5692
  export interface UpdateDistributionBundleRequest {
5184
5693
  /**
5694
+ * @public
5185
5695
  * <p>The name of the distribution for which to update the bundle.</p>
5186
5696
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
5187
5697
  * can specify.</p>
5188
5698
  */
5189
5699
  distributionName?: string;
5190
5700
  /**
5701
+ * @public
5191
5702
  * <p>The bundle ID of the new bundle to apply to your distribution.</p>
5192
5703
  * <p>Use the <code>GetDistributionBundles</code> action to get a list of distribution bundle
5193
5704
  * IDs that you can specify.</p>
@@ -5199,6 +5710,7 @@ export interface UpdateDistributionBundleRequest {
5199
5710
  */
5200
5711
  export interface UpdateDistributionBundleResult {
5201
5712
  /**
5713
+ * @public
5202
5714
  * <p>An object that describes the result of the action, such as the status of the request, the
5203
5715
  * timestamp of the request, and the resources affected by the request.</p>
5204
5716
  */
@@ -5209,10 +5721,12 @@ export interface UpdateDistributionBundleResult {
5209
5721
  */
5210
5722
  export interface UpdateDomainEntryRequest {
5211
5723
  /**
5724
+ * @public
5212
5725
  * <p>The name of the domain recordset to update.</p>
5213
5726
  */
5214
5727
  domainName: string | undefined;
5215
5728
  /**
5729
+ * @public
5216
5730
  * <p>An array of key-value pairs containing information about the domain entry.</p>
5217
5731
  */
5218
5732
  domainEntry: DomainEntry | undefined;
@@ -5222,6 +5736,7 @@ export interface UpdateDomainEntryRequest {
5222
5736
  */
5223
5737
  export interface UpdateDomainEntryResult {
5224
5738
  /**
5739
+ * @public
5225
5740
  * <p>An array of objects that describe the result of the action, such as the status of the
5226
5741
  * request, the timestamp of the request, and the resources affected by the request.</p>
5227
5742
  */
@@ -5232,10 +5747,12 @@ export interface UpdateDomainEntryResult {
5232
5747
  */
5233
5748
  export interface UpdateInstanceMetadataOptionsRequest {
5234
5749
  /**
5750
+ * @public
5235
5751
  * <p>The name of the instance for which to update metadata parameters.</p>
5236
5752
  */
5237
5753
  instanceName: string | undefined;
5238
5754
  /**
5755
+ * @public
5239
5756
  * <p>The state of token usage for your instance metadata requests. If the parameter is not
5240
5757
  * specified in the request, the default state is <code>optional</code>.</p>
5241
5758
  * <p>If the state is <code>optional</code>, you can choose whether to retrieve instance
@@ -5249,6 +5766,7 @@ export interface UpdateInstanceMetadataOptionsRequest {
5249
5766
  */
5250
5767
  httpTokens?: HttpTokens | string;
5251
5768
  /**
5769
+ * @public
5252
5770
  * <p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not
5253
5771
  * specified, the existing state is maintained.</p>
5254
5772
  * <p>If you specify a value of <code>disabled</code>, you cannot access your instance
@@ -5256,12 +5774,14 @@ export interface UpdateInstanceMetadataOptionsRequest {
5256
5774
  */
5257
5775
  httpEndpoint?: HttpEndpoint | string;
5258
5776
  /**
5777
+ * @public
5259
5778
  * <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number
5260
5779
  * means that the instance metadata requests can travel farther. If no parameter is specified,
5261
5780
  * the existing state is maintained.</p>
5262
5781
  */
5263
5782
  httpPutResponseHopLimit?: number;
5264
5783
  /**
5784
+ * @public
5265
5785
  * <p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting
5266
5786
  * applies only when the HTTP metadata endpoint is enabled.</p>
5267
5787
  * <note>
@@ -5275,6 +5795,7 @@ export interface UpdateInstanceMetadataOptionsRequest {
5275
5795
  */
5276
5796
  export interface UpdateInstanceMetadataOptionsResult {
5277
5797
  /**
5798
+ * @public
5278
5799
  * <p>An array of objects that describe the result of the action, such as the status of the
5279
5800
  * request, the timestamp of the request, and the resources affected by the request.</p>
5280
5801
  */
@@ -5285,15 +5806,18 @@ export interface UpdateInstanceMetadataOptionsResult {
5285
5806
  */
5286
5807
  export interface UpdateLoadBalancerAttributeRequest {
5287
5808
  /**
5809
+ * @public
5288
5810
  * <p>The name of the load balancer that you want to modify (e.g.,
5289
5811
  * <code>my-load-balancer</code>.</p>
5290
5812
  */
5291
5813
  loadBalancerName: string | undefined;
5292
5814
  /**
5815
+ * @public
5293
5816
  * <p>The name of the attribute you want to update.</p>
5294
5817
  */
5295
5818
  attributeName: LoadBalancerAttributeName | string | undefined;
5296
5819
  /**
5820
+ * @public
5297
5821
  * <p>The value that you want to specify for the attribute name.</p>
5298
5822
  * <p>The following values are supported depending on what you specify for the
5299
5823
  * <code>attributeName</code> request parameter:</p>
@@ -5337,6 +5861,7 @@ export interface UpdateLoadBalancerAttributeRequest {
5337
5861
  */
5338
5862
  export interface UpdateLoadBalancerAttributeResult {
5339
5863
  /**
5864
+ * @public
5340
5865
  * <p>An array of objects that describe the result of the action, such as the status of the
5341
5866
  * request, the timestamp of the request, and the resources affected by the request.</p>
5342
5867
  */
@@ -5347,10 +5872,12 @@ export interface UpdateLoadBalancerAttributeResult {
5347
5872
  */
5348
5873
  export interface UpdateRelationalDatabaseRequest {
5349
5874
  /**
5875
+ * @public
5350
5876
  * <p>The name of your Lightsail database resource to update.</p>
5351
5877
  */
5352
5878
  relationalDatabaseName: string | undefined;
5353
5879
  /**
5880
+ * @public
5354
5881
  * <p>The password for the master user. The password can include any printable ASCII character
5355
5882
  * except "/", """, or "@".</p>
5356
5883
  * <p>My<b>SQL</b>
@@ -5363,6 +5890,7 @@ export interface UpdateRelationalDatabaseRequest {
5363
5890
  */
5364
5891
  masterUserPassword?: string;
5365
5892
  /**
5893
+ * @public
5366
5894
  * <p>When <code>true</code>, the master user password is changed to a new strong password
5367
5895
  * generated by Lightsail.</p>
5368
5896
  * <p>Use the <code>get relational database master user password</code> operation to get the new
@@ -5370,6 +5898,7 @@ export interface UpdateRelationalDatabaseRequest {
5370
5898
  */
5371
5899
  rotateMasterUserPassword?: boolean;
5372
5900
  /**
5901
+ * @public
5373
5902
  * <p>The daily time range during which automated backups are created for your database if
5374
5903
  * automated backups are enabled.</p>
5375
5904
  * <p>Constraints:</p>
@@ -5392,6 +5921,7 @@ export interface UpdateRelationalDatabaseRequest {
5392
5921
  */
5393
5922
  preferredBackupWindow?: string;
5394
5923
  /**
5924
+ * @public
5395
5925
  * <p>The weekly time range during which system maintenance can occur on your database.</p>
5396
5926
  * <p>The default is a 30-minute window selected at random from an 8-hour block of time for each
5397
5927
  * Amazon Web Services Region, occurring on a random day of the week.</p>
@@ -5417,12 +5947,14 @@ export interface UpdateRelationalDatabaseRequest {
5417
5947
  */
5418
5948
  preferredMaintenanceWindow?: string;
5419
5949
  /**
5950
+ * @public
5420
5951
  * <p>When <code>true</code>, enables automated backup retention for your database.</p>
5421
5952
  * <p>Updates are applied during the next maintenance window because this can result in an
5422
5953
  * outage.</p>
5423
5954
  */
5424
5955
  enableBackupRetention?: boolean;
5425
5956
  /**
5957
+ * @public
5426
5958
  * <p>When <code>true</code>, disables automated backup retention for your database.</p>
5427
5959
  * <p>Disabling backup retention deletes all automated database backups. Before disabling this,
5428
5960
  * you may want to create a snapshot of your database using the <code>create relational database
@@ -5432,6 +5964,7 @@ export interface UpdateRelationalDatabaseRequest {
5432
5964
  */
5433
5965
  disableBackupRetention?: boolean;
5434
5966
  /**
5967
+ * @public
5435
5968
  * <p>Specifies the accessibility options for your database. A value of <code>true</code>
5436
5969
  * specifies a database that is available to resources outside of your Lightsail account. A
5437
5970
  * value of <code>false</code> specifies a database that is available only to your Lightsail
@@ -5439,6 +5972,7 @@ export interface UpdateRelationalDatabaseRequest {
5439
5972
  */
5440
5973
  publiclyAccessible?: boolean;
5441
5974
  /**
5975
+ * @public
5442
5976
  * <p>When <code>true</code>, applies changes immediately. When <code>false</code>, applies
5443
5977
  * changes during the preferred maintenance window. Some changes may cause an outage.</p>
5444
5978
  * <p>Default: <code>false</code>
@@ -5446,6 +5980,7 @@ export interface UpdateRelationalDatabaseRequest {
5446
5980
  */
5447
5981
  applyImmediately?: boolean;
5448
5982
  /**
5983
+ * @public
5449
5984
  * <p>Indicates the certificate that needs to be associated with the database.</p>
5450
5985
  */
5451
5986
  caCertificateIdentifier?: string;
@@ -5455,6 +5990,7 @@ export interface UpdateRelationalDatabaseRequest {
5455
5990
  */
5456
5991
  export interface UpdateRelationalDatabaseResult {
5457
5992
  /**
5993
+ * @public
5458
5994
  * <p>An array of objects that describe the result of the action, such as the status of the
5459
5995
  * request, the timestamp of the request, and the resources affected by the request.</p>
5460
5996
  */
@@ -5465,10 +6001,12 @@ export interface UpdateRelationalDatabaseResult {
5465
6001
  */
5466
6002
  export interface UpdateRelationalDatabaseParametersRequest {
5467
6003
  /**
6004
+ * @public
5468
6005
  * <p>The name of your database for which to update parameters.</p>
5469
6006
  */
5470
6007
  relationalDatabaseName: string | undefined;
5471
6008
  /**
6009
+ * @public
5472
6010
  * <p>The database parameters to update.</p>
5473
6011
  */
5474
6012
  parameters: RelationalDatabaseParameter[] | undefined;
@@ -5478,6 +6016,7 @@ export interface UpdateRelationalDatabaseParametersRequest {
5478
6016
  */
5479
6017
  export interface UpdateRelationalDatabaseParametersResult {
5480
6018
  /**
6019
+ * @public
5481
6020
  * <p>An array of objects that describe the result of the action, such as the status of the
5482
6021
  * request, the timestamp of the request, and the resources affected by the request.</p>
5483
6022
  */