feat(client-transfer): Adds support for creating Webapps accessible from a VPC.

Author: awstools

clients/client-transfer/src/commands/CreateWebAppCommand.ts

@@ -27,7 +27,7 @@ export interface CreateWebAppCommandInput extends CreateWebAppRequest {}
 export interface CreateWebAppCommandOutput extends CreateWebAppResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a web app based on specified parameters, and returns the ID for the new web app.</p>
+ * <p>Creates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -54,6 +54,17 @@ export interface CreateWebAppCommandOutput extends CreateWebAppResponse, __Metad
  *     },
  *   ],
  *   WebAppEndpointPolicy: "FIPS" || "STANDARD",
+ *   EndpointDetails: { // WebAppEndpointDetails Union: only one key present
+ *     Vpc: { // WebAppVpcConfig
+ *       SubnetIds: [ // SubnetIds
+ *         "STRING_VALUE",
+ *       ],
+ *       VpcId: "STRING_VALUE",
+ *       SecurityGroupIds: [ // SecurityGroupIds
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
  * };
  * const command = new CreateWebAppCommand(input);
  * const response = await client.send(command);

clients/client-transfer/src/commands/DescribeWebAppCommand.ts

@@ -27,7 +27,7 @@ export interface DescribeWebAppCommandInput extends DescribeWebAppRequest {}
 export interface DescribeWebAppCommandOutput extends DescribeWebAppResponse, __MetadataBearer {}
 
 /**
- * <p>Describes the web app that's identified by <code>WebAppId</code>.</p>
+ * <p>Describes the web app that's identified by <code>WebAppId</code>. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -64,6 +64,16 @@ export interface DescribeWebAppCommandOutput extends DescribeWebAppResponse, __M
  * //       },
  * //     ],
  * //     WebAppEndpointPolicy: "FIPS" || "STANDARD",
+ * //     EndpointType: "PUBLIC" || "VPC",
+ * //     DescribedEndpointDetails: { // DescribedWebAppEndpointDetails Union: only one key present
+ * //       Vpc: { // DescribedWebAppVpcConfig
+ * //         SubnetIds: [ // SubnetIds
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         VpcId: "STRING_VALUE",
+ * //         VpcEndpointId: "STRING_VALUE",
+ * //       },
+ * //     },
  * //   },
  * // };
  *

clients/client-transfer/src/commands/ListWebAppsCommand.ts

@@ -27,7 +27,7 @@ export interface ListWebAppsCommandInput extends ListWebAppsRequest {}
 export interface ListWebAppsCommandOutput extends ListWebAppsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists all web apps associated with your Amazon Web Services account for your current region.</p>
+ * <p>Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -50,6 +50,7 @@ export interface ListWebAppsCommandOutput extends ListWebAppsResponse, __Metadat
  * //       WebAppId: "STRING_VALUE", // required
  * //       AccessEndpoint: "STRING_VALUE",
  * //       WebAppEndpoint: "STRING_VALUE",
+ * //       EndpointType: "PUBLIC" || "VPC",
  * //     },
  * //   ],
  * // };

clients/client-transfer/src/commands/UpdateWebAppCommand.ts

@@ -27,7 +27,7 @@ export interface UpdateWebAppCommandInput extends UpdateWebAppRequest {}
 export interface UpdateWebAppCommandOutput extends UpdateWebAppResponse, __MetadataBearer {}
 
 /**
- * <p>Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units.</p>
+ * <p>Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -47,6 +47,13 @@ export interface UpdateWebAppCommandOutput extends UpdateWebAppResponse, __Metad
  *   WebAppUnits: { // WebAppUnits Union: only one key present
  *     Provisioned: Number("int"),
  *   },
+ *   EndpointDetails: { // UpdateWebAppEndpointDetails Union: only one key present
+ *     Vpc: { // UpdateWebAppVpcConfig
+ *       SubnetIds: [ // SubnetIds
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
  * };
  * const command = new UpdateWebAppCommand(input);
  * const response = await client.send(command);

clients/client-transfer/src/models/enums.ts

@@ -529,3 +529,16 @@ export const State = {
  * @public
  */
 export type State = (typeof State)[keyof typeof State];
+
+/**
+ * @public
+ * @enum
+ */
+export const WebAppEndpointType = {
+  PUBLIC: "PUBLIC",
+  VPC: "VPC",
+} as const;
+/**
+ * @public
+ */
+export type WebAppEndpointType = (typeof WebAppEndpointType)[keyof typeof WebAppEndpointType];

clients/client-transfer/src/models/models_0.ts

@@ -37,6 +37,7 @@ import {
   TlsSessionResumptionMode,
   TransferTableStatus,
   WebAppEndpointPolicy,
+  WebAppEndpointType,
   WorkflowStepType,
 } from "./enums";
 
@@ -1986,6 +1987,67 @@ export interface CreateUserResponse {
   UserName: string | undefined;
 }
 
+/**
+ * <p>Contains the VPC configuration settings for hosting a web app endpoint, including the VPC ID, subnet IDs, and security group IDs for access control.</p>
+ * @public
+ */
+export interface WebAppVpcConfig {
+  /**
+   * <p>The list of subnet IDs within the VPC where the web app endpoint will be deployed. These subnets must be in the same VPC specified in the VpcId parameter.</p>
+   * @public
+   */
+  SubnetIds?: string[] | undefined;
+
+  /**
+   * <p>The identifier of the VPC where the web app endpoint will be hosted.</p>
+   * @public
+   */
+  VpcId?: string | undefined;
+
+  /**
+   * <p>The list of security group IDs that control access to the web app endpoint. These security groups determine which sources can access the endpoint based on IP addresses and port configurations.</p>
+   * @public
+   */
+  SecurityGroupIds?: string[] | undefined;
+}
+
+/**
+ * <p>Contains the endpoint configuration for a web app, including VPC settings when the endpoint is hosted within a VPC.</p>
+ * @public
+ */
+export type WebAppEndpointDetails = WebAppEndpointDetails.VpcMember | WebAppEndpointDetails.$UnknownMember;
+
+/**
+ * @public
+ */
+export namespace WebAppEndpointDetails {
+  /**
+   * <p>The VPC configuration for hosting the web app endpoint within a VPC.</p>
+   * @public
+   */
+  export interface VpcMember {
+    Vpc: WebAppVpcConfig;
+    $unknown?: never;
+  }
+
+  /**
+   * @public
+   */
+  export interface $UnknownMember {
+    Vpc?: never;
+    $unknown: [string, any];
+  }
+
+  /**
+   * @deprecated unused in schema-serde mode.
+   *
+   */
+  export interface Visitor<T> {
+    Vpc: (value: WebAppVpcConfig) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+
 /**
  * <p>A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.</p>
  * @public
@@ -2113,6 +2175,12 @@ export interface CreateWebAppRequest {
    * @public
    */
   WebAppEndpointPolicy?: WebAppEndpointPolicy | undefined;
+
+  /**
+   * <p>The endpoint configuration for the web app. You can specify whether the web app endpoint is publicly accessible or hosted within a VPC.</p>
+   * @public
+   */
+  EndpointDetails?: WebAppEndpointDetails | undefined;
 }
 
 /**
@@ -3169,6 +3237,69 @@ export interface DescribedUser {
   UserName?: string | undefined;
 }
 
+/**
+ * <p>Contains the VPC configuration details for a web app endpoint, including the VPC identifier, subnet IDs, and VPC endpoint ID used for hosting the endpoint.</p>
+ * @public
+ */
+export interface DescribedWebAppVpcConfig {
+  /**
+   * <p>The list of subnet IDs within the VPC where the web app endpoint is deployed. These subnets must be in the same VPC and provide network connectivity for the endpoint.</p>
+   * @public
+   */
+  SubnetIds?: string[] | undefined;
+
+  /**
+   * <p>The identifier of the VPC where the web app endpoint is hosted.</p>
+   * @public
+   */
+  VpcId?: string | undefined;
+
+  /**
+   * <p>The identifier of the VPC endpoint created for the web app.</p>
+   * @public
+   */
+  VpcEndpointId?: string | undefined;
+}
+
+/**
+ * <p>Contains the endpoint configuration details for a web app, including VPC configuration when the endpoint is hosted within a VPC.</p>
+ * @public
+ */
+export type DescribedWebAppEndpointDetails =
+  | DescribedWebAppEndpointDetails.VpcMember
+  | DescribedWebAppEndpointDetails.$UnknownMember;
+
+/**
+ * @public
+ */
+export namespace DescribedWebAppEndpointDetails {
+  /**
+   * <p>The VPC configuration details when the web app endpoint is hosted within a VPC. This includes the VPC ID, subnet IDs, and VPC endpoint ID.</p>
+   * @public
+   */
+  export interface VpcMember {
+    Vpc: DescribedWebAppVpcConfig;
+    $unknown?: never;
+  }
+
+  /**
+   * @public
+   */
+  export interface $UnknownMember {
+    Vpc?: never;
+    $unknown: [string, any];
+  }
+
+  /**
+   * @deprecated unused in schema-serde mode.
+   *
+   */
+  export interface Visitor<T> {
+    Vpc: (value: DescribedWebAppVpcConfig) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+
 /**
  * <p>Returns a structure that contains the identity provider details for your web app.</p>
  * @public
@@ -3260,6 +3391,18 @@ export interface DescribedWebApp {
    * @public
    */
   WebAppEndpointPolicy?: WebAppEndpointPolicy | undefined;
+
+  /**
+   * <p>The type of endpoint hosting the web app. Valid values are <code>PUBLIC</code> for publicly accessible endpoints and <code>VPC</code> for VPC-hosted endpoints that provide network isolation.</p>
+   * @public
+   */
+  EndpointType?: WebAppEndpointType | undefined;
+
+  /**
+   * <p>The endpoint configuration details for the web app, including VPC settings if the endpoint is hosted within a VPC.</p>
+   * @public
+   */
+  DescribedEndpointDetails?: DescribedWebAppEndpointDetails | undefined;
 }
 
 /**
@@ -3963,6 +4106,12 @@ export interface ListedWebApp {
    * @public
    */
   WebAppEndpoint?: string | undefined;
+
+  /**
+   * <p>The type of endpoint hosting the web app. Valid values are <code>PUBLIC</code> for publicly accessible endpoints and <code>VPC</code> for VPC-hosted endpoints.</p>
+   * @public
+   */
+  EndpointType?: WebAppEndpointType | undefined;
 }
 
 /**
@@ -5122,6 +5271,57 @@ export interface UpdateWebAppCustomizationResponse {
   WebAppId: string | undefined;
 }
 
+/**
+ * <p>Contains the VPC configuration settings for updating a web app endpoint, including the subnet IDs where the endpoint should be deployed.</p>
+ * @public
+ */
+export interface UpdateWebAppVpcConfig {
+  /**
+   * <p>The list of subnet IDs within the VPC where the web app endpoint should be deployed during the update operation.</p>
+   * @public
+   */
+  SubnetIds?: string[] | undefined;
+}
+
+/**
+ * <p>Contains the endpoint configuration details for updating a web app, including VPC settings for endpoints hosted within a VPC.</p>
+ * @public
+ */
+export type UpdateWebAppEndpointDetails =
+  | UpdateWebAppEndpointDetails.VpcMember
+  | UpdateWebAppEndpointDetails.$UnknownMember;
+
+/**
+ * @public
+ */
+export namespace UpdateWebAppEndpointDetails {
+  /**
+   * <p>The VPC configuration details for updating a web app endpoint hosted within a VPC. This includes the subnet IDs for endpoint deployment.</p>
+   * @public
+   */
+  export interface VpcMember {
+    Vpc: UpdateWebAppVpcConfig;
+    $unknown?: never;
+  }
+
+  /**
+   * @public
+   */
+  export interface $UnknownMember {
+    Vpc?: never;
+    $unknown: [string, any];
+  }
+
+  /**
+   * @deprecated unused in schema-serde mode.
+   *
+   */
+  export interface Visitor<T> {
+    Vpc: (value: UpdateWebAppVpcConfig) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+
 /**
  * <p>A structure that describes the values to use for the IAM Identity Center settings when you update a web app.</p>
  * @public
@@ -5200,6 +5400,12 @@ export interface UpdateWebAppRequest {
    * @public
    */
   WebAppUnits?: WebAppUnits | undefined;
+
+  /**
+   * <p>The updated endpoint configuration for the web app. You can modify the endpoint type and VPC configuration settings.</p>
+   * @public
+   */
+  EndpointDetails?: UpdateWebAppEndpointDetails | undefined;
 }
 
 /**