/
models_1.ts
9822 lines (8607 loc) · 313 KB
/
models_1.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
import {
_InstanceType,
AcceleratorCount,
AcceleratorCountRequest,
AcceleratorManufacturer,
AcceleratorName,
AcceleratorTotalMemoryMiB,
AcceleratorTotalMemoryMiBRequest,
AcceleratorType,
AccessScopePath,
AccessScopePathRequest,
AddIpamOperatingRegion,
AddPrefixListEntry,
AddressFamily,
AttachmentStatus,
CertificateAuthenticationRequest,
DirectoryServiceAuthenticationRequest,
FederatedAuthenticationRequest,
InstanceEventWindow,
Ipv4PrefixSpecification,
NatGatewayAddress,
PortRange,
Protocol,
ResourceType,
SubnetIpv6CidrBlockAssociation,
Tag,
TagSpecification,
UnsuccessfulItem,
VpcCidrBlockAssociation,
VpcIpv6CidrBlockAssociation,
WeekDay,
} from "./models_0";
/**
* @public
* @enum
*/
export const ClientVpnAuthenticationType = {
certificate_authentication: "certificate-authentication",
directory_service_authentication: "directory-service-authentication",
federated_authentication: "federated-authentication",
} as const;
/**
* @public
*/
export type ClientVpnAuthenticationType =
(typeof ClientVpnAuthenticationType)[keyof typeof ClientVpnAuthenticationType];
/**
* @public
* <p>Describes the authentication method to be used by a Client VPN endpoint. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication">Authentication</a>
* in the <i>Client VPN Administrator Guide</i>.</p>
*/
export interface ClientVpnAuthenticationRequest {
/**
* <p>The type of client authentication to be used.</p>
*/
Type?: ClientVpnAuthenticationType | string;
/**
* <p>Information about the Active Directory to be used, if applicable. You must provide this information if <b>Type</b> is <code>directory-service-authentication</code>.</p>
*/
ActiveDirectory?: DirectoryServiceAuthenticationRequest;
/**
* <p>Information about the authentication certificates to be used, if applicable. You must provide this information if <b>Type</b> is <code>certificate-authentication</code>.</p>
*/
MutualAuthentication?: CertificateAuthenticationRequest;
/**
* <p>Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if <b>Type</b> is <code>federated-authentication</code>.</p>
*/
FederatedAuthentication?: FederatedAuthenticationRequest;
}
/**
* @public
* <p>The options for managing connection authorization for new client connections.</p>
*/
export interface ClientConnectOptions {
/**
* <p>Indicates whether client connect options are enabled. The default is <code>false</code> (not enabled).</p>
*/
Enabled?: boolean;
/**
* <p>The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.</p>
*/
LambdaFunctionArn?: string;
}
/**
* @public
* <p>Options for enabling a customizable text banner that will be displayed on
* Amazon Web Services provided clients when a VPN session is established.</p>
*/
export interface ClientLoginBannerOptions {
/**
* <p>Enable or disable a customizable text banner that will be displayed on
* Amazon Web Services provided clients when a VPN session is established.</p>
* <p>Valid values: <code>true | false</code>
* </p>
* <p>Default value: <code>false</code>
* </p>
*/
Enabled?: boolean;
/**
* <p>Customizable text that will be displayed in a banner on Amazon Web Services provided
* clients when a VPN session is established. UTF-8 encoded characters only. Maximum of
* 1400 characters.</p>
*/
BannerText?: string;
}
/**
* @public
* <p>Describes the client connection logging options for the Client VPN endpoint.</p>
*/
export interface ConnectionLogOptions {
/**
* <p>Indicates whether connection logging is enabled.</p>
*/
Enabled?: boolean;
/**
* <p>The name of the CloudWatch Logs log group. Required if connection logging is enabled.</p>
*/
CloudwatchLogGroup?: string;
/**
* <p>The name of the CloudWatch Logs log stream to which the connection data is published.</p>
*/
CloudwatchLogStream?: string;
}
/**
* @public
* @enum
*/
export const SelfServicePortal = {
disabled: "disabled",
enabled: "enabled",
} as const;
/**
* @public
*/
export type SelfServicePortal = (typeof SelfServicePortal)[keyof typeof SelfServicePortal];
/**
* @public
* @enum
*/
export const TransportProtocol = {
tcp: "tcp",
udp: "udp",
} as const;
/**
* @public
*/
export type TransportProtocol = (typeof TransportProtocol)[keyof typeof TransportProtocol];
/**
* @public
*/
export interface CreateClientVpnEndpointRequest {
/**
* <p>The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.</p>
*/
ClientCidrBlock: string | undefined;
/**
* <p>The ARN of the server certificate. For more information, see
* the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
*/
ServerCertificateArn: string | undefined;
/**
* <p>Information about the authentication method to be used to authenticate clients.</p>
*/
AuthenticationOptions: ClientVpnAuthenticationRequest[] | undefined;
/**
* <p>Information about the client connection logging options.</p>
* <p>If you enable client connection logging, data about client connections is sent to a
* Cloudwatch Logs log stream. The following information is logged:</p>
* <ul>
* <li>
* <p>Client connection requests</p>
* </li>
* <li>
* <p>Client connection results (successful and unsuccessful)</p>
* </li>
* <li>
* <p>Reasons for unsuccessful client connection requests</p>
* </li>
* <li>
* <p>Client connection termination time</p>
* </li>
* </ul>
*/
ConnectionLogOptions: ConnectionLogOptions | undefined;
/**
* <p>Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can
* have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.</p>
*/
DnsServers?: string[];
/**
* <p>The transport protocol to be used by the VPN session.</p>
* <p>Default value: <code>udp</code>
* </p>
*/
TransportProtocol?: TransportProtocol | string;
/**
* <p>The port number to assign to the Client VPN endpoint for TCP and UDP traffic.</p>
* <p>Valid Values: <code>443</code> | <code>1194</code>
* </p>
* <p>Default Value: <code>443</code>
* </p>
*/
VpnPort?: number;
/**
* <p>A brief description of the Client VPN endpoint.</p>
*/
Description?: string;
/**
* <p>Indicates whether split-tunnel is enabled on the Client VPN endpoint.</p>
* <p>By default, split-tunnel on a VPN endpoint is disabled.</p>
* <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-tunnel Client VPN endpoint</a> in the
* <i>Client VPN Administrator Guide</i>.</p>
*/
SplitTunnel?: boolean;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">How to ensure idempotency</a>.</p>
*/
ClientToken?: string;
/**
* <p>The tags to apply to the Client VPN endpoint during creation.</p>
*/
TagSpecifications?: TagSpecification[];
/**
* <p>The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.</p>
*/
SecurityGroupIds?: string[];
/**
* <p>The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.</p>
*/
VpcId?: string;
/**
* <p>Specify whether to enable the self-service portal for the Client VPN endpoint.</p>
* <p>Default Value: <code>enabled</code>
* </p>
*/
SelfServicePortal?: SelfServicePortal | string;
/**
* <p>The options for managing connection authorization for new client connections.</p>
*/
ClientConnectOptions?: ClientConnectOptions;
/**
* <p>The maximum VPN session duration time in hours.</p>
* <p>Valid values: <code>8 | 10 | 12 | 24</code>
* </p>
* <p>Default value: <code>24</code>
* </p>
*/
SessionTimeoutHours?: number;
/**
* <p>Options for enabling a customizable text banner that will be displayed on
* Amazon Web Services provided clients when a VPN session is established.</p>
*/
ClientLoginBannerOptions?: ClientLoginBannerOptions;
}
/**
* @public
* @enum
*/
export const ClientVpnEndpointStatusCode = {
available: "available",
deleted: "deleted",
deleting: "deleting",
pending_associate: "pending-associate",
} as const;
/**
* @public
*/
export type ClientVpnEndpointStatusCode =
(typeof ClientVpnEndpointStatusCode)[keyof typeof ClientVpnEndpointStatusCode];
/**
* @public
* <p>Describes the state of a Client VPN endpoint.</p>
*/
export interface ClientVpnEndpointStatus {
/**
* <p>The state of the Client VPN endpoint. Possible states include:</p>
* <ul>
* <li>
* <p>
* <code>pending-associate</code> - The Client VPN endpoint has been created but no target networks
* have been associated. The Client VPN endpoint cannot accept connections.</p>
* </li>
* <li>
* <p>
* <code>available</code> - The Client VPN endpoint has been created and a target network has been
* associated. The Client VPN endpoint can accept connections.</p>
* </li>
* <li>
* <p>
* <code>deleting</code> - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept
* connections.</p>
* </li>
* <li>
* <p>
* <code>deleted</code> - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept
* connections.</p>
* </li>
* </ul>
*/
Code?: ClientVpnEndpointStatusCode | string;
/**
* <p>A message about the status of the Client VPN endpoint.</p>
*/
Message?: string;
}
/**
* @public
*/
export interface CreateClientVpnEndpointResult {
/**
* <p>The ID of the Client VPN endpoint.</p>
*/
ClientVpnEndpointId?: string;
/**
* <p>The current state of the Client VPN endpoint.</p>
*/
Status?: ClientVpnEndpointStatus;
/**
* <p>The DNS name to be used by clients when establishing their VPN session.</p>
*/
DnsName?: string;
}
/**
* @public
*/
export interface CreateClientVpnRouteRequest {
/**
* <p>The ID of the Client VPN endpoint to which to add the route.</p>
*/
ClientVpnEndpointId: string | undefined;
/**
* <p>The IPv4 address range, in CIDR notation, of the route destination. For example:</p>
* <ul>
* <li>
* <p>To add a route for Internet access, enter <code>0.0.0.0/0</code>
* </p>
* </li>
* <li>
* <p>To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range</p>
* </li>
* <li>
* <p>To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range</p>
* </li>
* <li>
* <p>To add a route for the local network, enter the client CIDR range</p>
* </li>
* </ul>
*/
DestinationCidrBlock: string | undefined;
/**
* <p>The ID of the subnet through which you want to route traffic. The specified subnet must be
* an existing target network of the Client VPN endpoint.</p>
* <p>Alternatively, if you're adding a route for the local network, specify <code>local</code>.</p>
*/
TargetVpcSubnetId: string | undefined;
/**
* <p>A brief description of the route.</p>
*/
Description?: string;
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">How to ensure idempotency</a>.</p>
*/
ClientToken?: string;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
/**
* @public
* @enum
*/
export const ClientVpnRouteStatusCode = {
active: "active",
creating: "creating",
deleting: "deleting",
failed: "failed",
} as const;
/**
* @public
*/
export type ClientVpnRouteStatusCode = (typeof ClientVpnRouteStatusCode)[keyof typeof ClientVpnRouteStatusCode];
/**
* @public
* <p>Describes the state of a Client VPN endpoint route.</p>
*/
export interface ClientVpnRouteStatus {
/**
* <p>The state of the Client VPN endpoint route.</p>
*/
Code?: ClientVpnRouteStatusCode | string;
/**
* <p>A message about the status of the Client VPN endpoint route, if applicable.</p>
*/
Message?: string;
}
/**
* @public
*/
export interface CreateClientVpnRouteResult {
/**
* <p>The current state of the route.</p>
*/
Status?: ClientVpnRouteStatus;
}
/**
* @public
*/
export interface CreateCoipCidrRequest {
/**
* <p>
* A customer-owned IP address range to create.
* </p>
*/
Cidr: string | undefined;
/**
* <p>
* The ID of the address pool.
* </p>
*/
CoipPoolId: string | undefined;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
/**
* @public
* <p>
* Information about a customer-owned IP address range.
* </p>
*/
export interface CoipCidr {
/**
* <p>
* An address range in a customer-owned IP address space.
* </p>
*/
Cidr?: string;
/**
* <p>
* The ID of the address pool.
* </p>
*/
CoipPoolId?: string;
/**
* <p>
* The ID of the local gateway route table.
* </p>
*/
LocalGatewayRouteTableId?: string;
}
/**
* @public
*/
export interface CreateCoipCidrResult {
/**
* <p>
* Information about a range of customer-owned IP addresses.
* </p>
*/
CoipCidr?: CoipCidr;
}
/**
* @public
*/
export interface CreateCoipPoolRequest {
/**
* <p>
* The ID of the local gateway route table.
* </p>
*/
LocalGatewayRouteTableId: string | undefined;
/**
* <p>
* The tags to assign to the CoIP address pool.
* </p>
*/
TagSpecifications?: TagSpecification[];
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
/**
* @public
* <p>Describes a customer-owned address pool.</p>
*/
export interface CoipPool {
/**
* <p>The ID of the address pool.</p>
*/
PoolId?: string;
/**
* <p>The address ranges of the address pool.</p>
*/
PoolCidrs?: string[];
/**
* <p>The ID of the local gateway route table.</p>
*/
LocalGatewayRouteTableId?: string;
/**
* <p>The tags.</p>
*/
Tags?: Tag[];
/**
* <p>The ARN of the address pool.</p>
*/
PoolArn?: string;
}
/**
* @public
*/
export interface CreateCoipPoolResult {
/**
* <p>Information about the CoIP address pool.</p>
*/
CoipPool?: CoipPool;
}
/**
* @public
* @enum
*/
export const GatewayType = {
ipsec_1: "ipsec.1",
} as const;
/**
* @public
*/
export type GatewayType = (typeof GatewayType)[keyof typeof GatewayType];
/**
* @public
* <p>Contains the parameters for CreateCustomerGateway.</p>
*/
export interface CreateCustomerGatewayRequest {
/**
* <p>For devices that support BGP, the customer gateway's BGP ASN.</p>
* <p>Default: 65000</p>
*/
BgpAsn?: number;
/**
* <p>
* <i>This member has been deprecated.</i> The Internet-routable IP address for the customer gateway's outside interface. The
* address must be static.</p>
*/
PublicIp?: string;
/**
* <p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>
*/
CertificateArn?: string;
/**
* <p>The type of VPN connection that this customer gateway supports
* (<code>ipsec.1</code>).</p>
*/
Type: GatewayType | string | undefined;
/**
* <p>The tags to apply to the customer gateway.</p>
*/
TagSpecifications?: TagSpecification[];
/**
* <p>A name for the customer gateway device.</p>
* <p>Length Constraints: Up to 255 characters.</p>
*/
DeviceName?: string;
/**
* <p>
* IPv4 address for the customer gateway device's outside interface. The address must be static.
* </p>
*/
IpAddress?: string;
/**
* <p>Checks whether you have the required permissions for the action, without actually
* making the request, and provides an error response. If you have the required
* permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is
* <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
/**
* @public
* <p>Describes a customer gateway.</p>
*/
export interface CustomerGateway {
/**
* <p>The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).</p>
*/
BgpAsn?: string;
/**
* <p>The ID of the customer gateway.</p>
*/
CustomerGatewayId?: string;
/**
* <p>The IP address of the customer gateway device's outside interface.</p>
*/
IpAddress?: string;
/**
* <p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>
*/
CertificateArn?: string;
/**
* <p>The current state of the customer gateway (<code>pending | available | deleting |
* deleted</code>).</p>
*/
State?: string;
/**
* <p>The type of VPN connection the customer gateway supports
* (<code>ipsec.1</code>).</p>
*/
Type?: string;
/**
* <p>The name of customer gateway device.</p>
*/
DeviceName?: string;
/**
* <p>Any tags assigned to the customer gateway.</p>
*/
Tags?: Tag[];
}
/**
* @public
* <p>Contains the output of CreateCustomerGateway.</p>
*/
export interface CreateCustomerGatewayResult {
/**
* <p>Information about the customer gateway.</p>
*/
CustomerGateway?: CustomerGateway;
}
/**
* @public
*/
export interface CreateDefaultSubnetRequest {
/**
* <p>The Availability Zone in which to create the default subnet.</p>
*/
AvailabilityZone: string | undefined;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Indicates whether to create an IPv6 only subnet. If you already have a default subnet
* for this Availability Zone, you must delete it before you can create an IPv6 only subnet.</p>
*/
Ipv6Native?: boolean;
}
/**
* @public
* @enum
*/
export const HostnameType = {
ip_name: "ip-name",
resource_name: "resource-name",
} as const;
/**
* @public
*/
export type HostnameType = (typeof HostnameType)[keyof typeof HostnameType];
/**
* @public
* <p>Describes the options for instance hostnames.</p>
*/
export interface PrivateDnsNameOptionsOnLaunch {
/**
* <p>The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name
* must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name
* must be based on the instance ID. For dual-stack subnets, you can specify whether DNS
* names use the instance IPv4 address or the instance ID.</p>
*/
HostnameType?: HostnameType | string;
/**
* <p>Indicates whether to respond to DNS queries for instance hostnames with DNS A
* records.</p>
*/
EnableResourceNameDnsARecord?: boolean;
/**
* <p>Indicates whether to respond to DNS queries for instance hostname with DNS AAAA
* records.</p>
*/
EnableResourceNameDnsAAAARecord?: boolean;
}
/**
* @public
* @enum
*/
export const SubnetState = {
available: "available",
pending: "pending",
} as const;
/**
* @public
*/
export type SubnetState = (typeof SubnetState)[keyof typeof SubnetState];
/**
* @public
* <p>Describes a subnet.</p>
*/
export interface Subnet {
/**
* <p>The Availability Zone of the subnet.</p>
*/
AvailabilityZone?: string;
/**
* <p>The AZ ID of the subnet.</p>
*/
AvailabilityZoneId?: string;
/**
* <p>The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any
* stopped instances are considered unavailable.</p>
*/
AvailableIpAddressCount?: number;
/**
* <p>The IPv4 CIDR block assigned to the subnet.</p>
*/
CidrBlock?: string;
/**
* <p>Indicates whether this is the default subnet for the Availability Zone.</p>
*/
DefaultForAz?: boolean;
/**
* <p>
* Indicates the device position for local network interfaces in this subnet. For example,
* <code>1</code> indicates local network interfaces in this subnet are the secondary
* network interface (eth1).
* </p>
*/
EnableLniAtDeviceIndex?: number;
/**
* <p>Indicates whether instances launched in this subnet receive a public IPv4 address.</p>
*/
MapPublicIpOnLaunch?: boolean;
/**
* <p>Indicates whether a network interface created in this subnet (including a network
* interface created by <a>RunInstances</a>) receives a customer-owned IPv4 address.</p>
*/
MapCustomerOwnedIpOnLaunch?: boolean;
/**
* <p>The customer-owned IPv4 address pool associated with the subnet.</p>
*/
CustomerOwnedIpv4Pool?: string;
/**
* <p>The current state of the subnet.</p>
*/
State?: SubnetState | string;
/**
* <p>The ID of the subnet.</p>
*/
SubnetId?: string;
/**
* <p>The ID of the VPC the subnet is in.</p>
*/
VpcId?: string;
/**
* <p>The ID of the Amazon Web Services account that owns the subnet.</p>
*/
OwnerId?: string;
/**
* <p>Indicates whether a network interface created in this subnet (including a network
* interface created by <a>RunInstances</a>) receives an IPv6 address.</p>
*/
AssignIpv6AddressOnCreation?: boolean;
/**
* <p>Information about the IPv6 CIDR blocks associated with the subnet.</p>
*/
Ipv6CidrBlockAssociationSet?: SubnetIpv6CidrBlockAssociation[];
/**
* <p>Any tags assigned to the subnet.</p>
*/
Tags?: Tag[];
/**
* <p>The Amazon Resource Name (ARN) of the subnet.</p>
*/
SubnetArn?: string;
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
OutpostArn?: string;
/**
* <p>Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet
* should return synthetic IPv6 addresses for IPv4-only destinations.</p>
*/
EnableDns64?: boolean;
/**
* <p>Indicates whether this is an IPv6 only subnet.</p>
*/
Ipv6Native?: boolean;
/**
* <p>The type of hostnames to assign to instances in the subnet at launch. An instance hostname
* is based on the IPv4 address or ID of the instance.</p>
*/
PrivateDnsNameOptionsOnLaunch?: PrivateDnsNameOptionsOnLaunch;
}
/**
* @public
*/
export interface CreateDefaultSubnetResult {
/**
* <p>Information about the subnet.</p>
*/
Subnet?: Subnet;
}
/**
* @public
*/
export interface CreateDefaultVpcRequest {
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
/**
* @public
* @enum
*/
export const Tenancy = {
dedicated: "dedicated",
default: "default",
host: "host",
} as const;
/**
* @public
*/
export type Tenancy = (typeof Tenancy)[keyof typeof Tenancy];
/**
* @public
* @enum
*/
export const VpcState = {
available: "available",
pending: "pending",
} as const;
/**
* @public
*/
export type VpcState = (typeof VpcState)[keyof typeof VpcState];
/**
* @public
* <p>Describes a VPC.</p>
*/
export interface Vpc {
/**
* <p>The primary IPv4 CIDR block for the VPC.</p>
*/
CidrBlock?: string;
/**
* <p>The ID of the set of DHCP options you've associated with the VPC.</p>
*/
DhcpOptionsId?: string;
/**
* <p>The current state of the VPC.</p>
*/
State?: VpcState | string;
/**
* <p>The ID of the VPC.</p>
*/