@aws-sdk/client-ec2 3.812.0 → 3.813.0

package/dist-types/models/models_4.d.ts

@@ -1,7 +1,174 @@
 import { ActiveInstance, AllocationState, AllowsMultipleInstanceTypes, AssociationStatus, AttachmentStatus, AutoPlacement, CurrencyCodeValues, HostMaintenance, HostRecovery, IamInstanceProfile, IamInstanceProfileAssociation, InstanceEventWindow, IpamResourceDiscoveryAssociation, Tag } from "./models_0";
-import { _InstanceType, AmdSevSnpSpecification, AttributeValue, BlockDeviceMapping, CapacityReservationPreference, CapacityReservationTargetResponse, ClientVpnEndpointStatus, ClientVpnRouteStatus, CoipPool, CustomerGateway, DefaultTargetCapacityType, DestinationFileFormat, DhcpOptions, DiskImageFormat, Ec2InstanceConnectEndpoint, EgressOnlyInternetGateway, ExportTask, FleetCapacityReservationUsageStrategy, FleetExcessCapacityTerminationPolicy, FleetLaunchTemplateOverrides, FleetLaunchTemplateSpecification, FleetOnDemandAllocationStrategy, FleetReplacementStrategy, FleetType, HostnameType, InstanceBandwidthWeighting, InstanceIpv6Address, InstanceLifecycle, InternetGateway, Ipam, IpamExternalResourceVerificationToken, IpamPool, IpamResourceDiscovery, IpamScope, KeyType, LaunchTemplate, LaunchTemplateAndOverridesResponse, LogDestinationType, OperatorResponse, Placement, PlatformValues, SpotAllocationStrategy, SpotInstanceInterruptionBehavior, TargetCapacityUnitType, TrafficType, TransportProtocol } from "./models_1";
-import { GroupIdentifier, LaunchTemplateVersion, LocalGatewayRouteTable, LocalGatewayRouteTableVirtualInterfaceGroupAssociation, LocalGatewayRouteTableVpcAssociation, NetworkInterfaceStatus, StateReason } from "./models_2";
-import { AssociatedTargetNetwork, Byoasn, ClientConnectResponseOptions, ClientLoginBannerResponseOptions, ClientRouteEnforcementResponseOptions, ClientVpnAuthentication, Filter, FleetStateCode, IdFormat, InstanceTagNotificationAttribute } from "./models_3";
+import { _InstanceType, AmdSevSnpSpecification, AttributeValue, BlockDeviceMapping, CapacityReservationPreference, CapacityReservationTargetResponse, ClientVpnAuthenticationType, ClientVpnEndpointStatus, ClientVpnRouteStatus, CoipPool, CustomerGateway, DefaultTargetCapacityType, DestinationFileFormat, DhcpOptions, DiskImageFormat, Ec2InstanceConnectEndpoint, EgressOnlyInternetGateway, ExportTask, FleetCapacityReservationUsageStrategy, FleetExcessCapacityTerminationPolicy, FleetLaunchTemplateOverrides, FleetLaunchTemplateSpecification, FleetOnDemandAllocationStrategy, FleetReplacementStrategy, FleetType, HostnameType, InstanceBandwidthWeighting, InstanceIpv6Address, InstanceLifecycle, InternetGateway, Ipam, IpamExternalResourceVerificationToken, IpamPool, IpamResourceDiscovery, IpamScope, KeyType, LaunchTemplate, LaunchTemplateAndOverridesResponse, LogDestinationType, OperatorResponse, Placement, PlatformValues, SpotAllocationStrategy, SpotInstanceInterruptionBehavior, TargetCapacityUnitType, TrafficType, TransportProtocol } from "./models_1";
+import { GroupIdentifier, LaunchTemplateVersion, NetworkInterfaceStatus, StateReason } from "./models_2";
+import { AssociatedNetworkType, Byoasn, Filter, FleetStateCode, IdFormat, InstanceTagNotificationAttribute } from "./models_3";
+/**
+ * <p>Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.</p>
+ * @public
+ */
+export interface AssociatedTargetNetwork {
+    /**
+     * <p>The ID of the subnet.</p>
+     * @public
+     */
+    NetworkId?: string | undefined;
+    /**
+     * <p>The target network type.</p>
+     * @public
+     */
+    NetworkType?: AssociatedNetworkType | undefined;
+}
+/**
+ * <p>Describes an Active Directory.</p>
+ * @public
+ */
+export interface DirectoryServiceAuthentication {
+    /**
+     * <p>The ID of the Active Directory used for authentication.</p>
+     * @public
+     */
+    DirectoryId?: string | undefined;
+}
+/**
+ * <p>Describes the IAM SAML identity providers used for federated authentication.</p>
+ * @public
+ */
+export interface FederatedAuthentication {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the IAM SAML identity provider.</p>
+     * @public
+     */
+    SamlProviderArn?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.</p>
+     * @public
+     */
+    SelfServiceSamlProviderArn?: string | undefined;
+}
+/**
+ * <p>Information about the client certificate used for authentication.</p>
+ * @public
+ */
+export interface CertificateAuthentication {
+    /**
+     * <p>The ARN of the client certificate. </p>
+     * @public
+     */
+    ClientRootCertificateChain?: string | undefined;
+}
+/**
+ * <p>Describes the authentication methods used by a Client VPN endpoint. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html">Authentication</a>
+ * 			in the <i>Client VPN Administrator Guide</i>.</p>
+ * @public
+ */
+export interface ClientVpnAuthentication {
+    /**
+     * <p>The authentication type used.</p>
+     * @public
+     */
+    Type?: ClientVpnAuthenticationType | undefined;
+    /**
+     * <p>Information about the Active Directory, if applicable.</p>
+     * @public
+     */
+    ActiveDirectory?: DirectoryServiceAuthentication | undefined;
+    /**
+     * <p>Information about the authentication certificates, if applicable.</p>
+     * @public
+     */
+    MutualAuthentication?: CertificateAuthentication | undefined;
+    /**
+     * <p>Information about the IAM SAML identity provider, if applicable.</p>
+     * @public
+     */
+    FederatedAuthentication?: FederatedAuthentication | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ClientVpnEndpointAttributeStatusCode: {
+    readonly applied: "applied";
+    readonly applying: "applying";
+};
+/**
+ * @public
+ */
+export type ClientVpnEndpointAttributeStatusCode = (typeof ClientVpnEndpointAttributeStatusCode)[keyof typeof ClientVpnEndpointAttributeStatusCode];
+/**
+ * <p>Describes the status of the Client VPN endpoint attribute.</p>
+ * @public
+ */
+export interface ClientVpnEndpointAttributeStatus {
+    /**
+     * <p>The status code.</p>
+     * @public
+     */
+    Code?: ClientVpnEndpointAttributeStatusCode | undefined;
+    /**
+     * <p>The status message.</p>
+     * @public
+     */
+    Message?: string | undefined;
+}
+/**
+ * <p>The options for managing connection authorization for new client connections.</p>
+ * @public
+ */
+export interface ClientConnectResponseOptions {
+    /**
+     * <p>Indicates whether client connect options are enabled.</p>
+     * @public
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.</p>
+     * @public
+     */
+    LambdaFunctionArn?: string | undefined;
+    /**
+     * <p>The status of any updates to the client connect options.</p>
+     * @public
+     */
+    Status?: ClientVpnEndpointAttributeStatus | undefined;
+}
+/**
+ * <p>Current state of options for customizable text banner that will be displayed on
+ * 			Amazon Web Services provided clients when a VPN session is established.</p>
+ * @public
+ */
+export interface ClientLoginBannerResponseOptions {
+    /**
+     * <p>Current state of text banner feature.</p>
+     *          <p>Valid values: <code>true | false</code>
+     *          </p>
+     * @public
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * <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>
+     * @public
+     */
+    BannerText?: string | undefined;
+}
+/**
+ * <p>The current status of Client Route Enforcement. </p>
+ * @public
+ */
+export interface ClientRouteEnforcementResponseOptions {
+    /**
+     * <p>Status of the client route enforcement feature, indicating whether Client Route Enforcement
+     * 			is <code>true</code> (enabled) or <code>false</code> (disabled).</p>
+     *          <p>Valid values: <code>true | false</code>
+     *          </p>
+     *          <p>Default value: <code>false</code>
+     *          </p>
+     * @public
+     */
+    Enforced?: boolean | undefined;
+}
 /**
  * <p>Information about the client connection logging options for a Client VPN endpoint.</p>
  * @public
@@ -10622,389 +10789,6 @@ export interface DescribeLaunchTemplateVersionsResult {
      */
     NextToken?: string | undefined;
 }
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTablesRequest {
-    /**
-     * <p>The IDs of the local gateway route tables.</p>
-     * @public
-     */
-    LocalGatewayRouteTableIds?: string[] | undefined;
-    /**
-     * <p>One or more filters.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-id</code> - The ID of a local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the
-     *                local gateway route table.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-id</code> - The ID of a local gateway route table.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway route table.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>state</code> - The state of the local gateway route table.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Filters?: Filter[] | undefined;
-    /**
-     * <p>The maximum number of results to return with a single call.
-     * 	To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The token for the next page of results.</p>
-     * @public
-     */
-    NextToken?: 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>
-     * @public
-     */
-    DryRun?: boolean | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTablesResult {
-    /**
-     * <p>Information about the local gateway route tables.</p>
-     * @public
-     */
-    LocalGatewayRouteTables?: LocalGatewayRouteTable[] | undefined;
-    /**
-     * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest {
-    /**
-     * <p>The IDs of the associations.</p>
-     * @public
-     */
-    LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds?: string[] | undefined;
-    /**
-     * <p>One or more filters.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-id</code> - The ID of a local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local
-     *                gateway route table for the virtual interface group.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-virtual-interface-group-association-id</code> - The ID of the association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-virtual-interface-group-id</code> - The ID of the virtual interface group.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual
-     *                interface group association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>state</code> - The state of the association.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Filters?: Filter[] | undefined;
-    /**
-     * <p>The maximum number of results to return with a single call.
-     * 	To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The token for the next page of results.</p>
-     * @public
-     */
-    NextToken?: 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>
-     * @public
-     */
-    DryRun?: boolean | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult {
-    /**
-     * <p>Information about the associations.</p>
-     * @public
-     */
-    LocalGatewayRouteTableVirtualInterfaceGroupAssociations?: LocalGatewayRouteTableVirtualInterfaceGroupAssociation[] | undefined;
-    /**
-     * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest {
-    /**
-     * <p>The IDs of the associations.</p>
-     * @public
-     */
-    LocalGatewayRouteTableVpcAssociationIds?: string[] | undefined;
-    /**
-     * <p>One or more filters.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-id</code> - The ID of a local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local
-     *                gateway route table for the association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-route-table-vpc-association-id</code> - The ID of the association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway route table
-     *                for the association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>state</code> - The state of the association.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>vpc-id</code> - The ID of the VPC.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Filters?: Filter[] | undefined;
-    /**
-     * <p>The maximum number of results to return with a single call.
-     * 	To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The token for the next page of results.</p>
-     * @public
-     */
-    NextToken?: 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>
-     * @public
-     */
-    DryRun?: boolean | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayRouteTableVpcAssociationsResult {
-    /**
-     * <p>Information about the associations.</p>
-     * @public
-     */
-    LocalGatewayRouteTableVpcAssociations?: LocalGatewayRouteTableVpcAssociation[] | undefined;
-    /**
-     * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewaysRequest {
-    /**
-     * <p>The IDs of the local gateways.</p>
-     * @public
-     */
-    LocalGatewayIds?: string[] | undefined;
-    /**
-     * <p>One or more filters.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-id</code> - The ID of a local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>state</code> - The state of the association.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Filters?: Filter[] | undefined;
-    /**
-     * <p>The maximum number of results to return with a single call.
-     * 	To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The token for the next page of results.</p>
-     * @public
-     */
-    NextToken?: 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>
-     * @public
-     */
-    DryRun?: boolean | undefined;
-}
-/**
- * <p>Describes a local gateway.</p>
- * @public
- */
-export interface LocalGateway {
-    /**
-     * <p>The ID of the local gateway.</p>
-     * @public
-     */
-    LocalGatewayId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the Outpost.</p>
-     * @public
-     */
-    OutpostArn?: string | undefined;
-    /**
-     * <p>The ID of the Amazon Web Services account that owns the local gateway.</p>
-     * @public
-     */
-    OwnerId?: string | undefined;
-    /**
-     * <p>The state of the local gateway.</p>
-     * @public
-     */
-    State?: string | undefined;
-    /**
-     * <p>The tags assigned to the local gateway.</p>
-     * @public
-     */
-    Tags?: Tag[] | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewaysResult {
-    /**
-     * <p>Information about the local gateways.</p>
-     * @public
-     */
-    LocalGateways?: LocalGateway[] | undefined;
-    /**
-     * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface DescribeLocalGatewayVirtualInterfaceGroupsRequest {
-    /**
-     * <p>The IDs of the virtual interface groups.</p>
-     * @public
-     */
-    LocalGatewayVirtualInterfaceGroupIds?: string[] | undefined;
-    /**
-     * <p>One or more filters.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-id</code> - The ID of a local gateway.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-virtual-interface-group-id</code> - The ID of the virtual interface group.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>local-gateway-virtual-interface-id</code> - The ID of the virtual interface.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Filters?: Filter[] | undefined;
-    /**
-     * <p>The maximum number of results to return with a single call.
-     * 	To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The token for the next page of results.</p>
-     * @public
-     */
-    NextToken?: 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>
-     * @public
-     */
-    DryRun?: boolean | undefined;
-}
 /**
  * @internal
  */