web_apps

Creates, updates, deletes, gets or lists a web_apps resource.

Overview

Name	web_apps
Type	Resource
Id	aws.transfer.web_apps

Fields

The following fields are returned by SELECT queries:

describe_web_app

Name	Datatype	Description
access_endpoint	string	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
arn	string	The Amazon Resource Name (ARN) of the web app. (pattern: <code>arn:\S+</code>)
described_endpoint_details	object	The endpoint configuration details for the web app, including VPC settings if the endpoint is hosted within a VPC.
described_identity_provider_details	object	A structure that contains the details for the identity provider used by the web app.
endpoint_type	string	The type of endpoint hosting the web app. Valid values are PUBLIC for publicly accessible endpoints and VPC for VPC-hosted endpoints that provide network isolation. (PUBLIC, VPC)
tags	array	Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.
web_app_endpoint	string	The WebAppEndpoint is the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.
web_app_endpoint_policy	string	Setting for the type of endpoint policy for the web app. The default value is STANDARD. If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be FIPS, which indicates the web app endpoint is FIPS-compliant. (FIPS, STANDARD)
web_app_id	string	The unique identifier for the web app. (pattern: <code>webapp-[0-9a-f]{17}</code>)
web_app_units	object	A union that contains the value for number of concurrent connections or the user sessions on your web app.

list_web_apps

Name	Datatype	Description
access_endpoint	string	The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
arn	string	The Amazon Resource Name (ARN) for the web app. (pattern: <code>arn:\S+</code>)
endpoint_type	string	The type of endpoint hosting the web app. Valid values are PUBLIC for publicly accessible endpoints and VPC for VPC-hosted endpoints. (PUBLIC, VPC)
web_app_endpoint	string	The WebAppEndpoint is the unique URL for your Transfer Family web app. This is the value that you use when you configure Origins on CloudFront.
web_app_id	string	The unique identifier for the web app. (pattern: <code>webapp-[0-9a-f]{17}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_web_app	select	region		Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
list_web_apps	select	region		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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
create_web_app	insert	region, IdentityProviderDetails		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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
update_web_app	update	region, WebAppId		Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
delete_web_app	delete	region		Deletes the specified web app.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_web_app

Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

SELECT
access_endpoint,
arn,
described_endpoint_details,
described_identity_provider_details,
endpoint_type,
tags,
web_app_endpoint,
web_app_endpoint_policy,
web_app_id,
web_app_units
FROM aws.transfer.web_apps
WHERE region = '{{ region }}' -- required
;

list_web_apps

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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

SELECT
access_endpoint,
arn,
endpoint_type,
web_app_endpoint,
web_app_id
FROM aws.transfer.web_apps
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_web_app

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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

INSERT INTO aws.transfer.web_apps (
IdentityProviderDetails,
AccessEndpoint,
WebAppUnits,
Tags,
WebAppEndpointPolicy,
EndpointDetails,
region
)
SELECT 
'{{ IdentityProviderDetails }}' /* required */,
'{{ AccessEndpoint }}',
'{{ WebAppUnits }}',
'{{ Tags }}',
'{{ WebAppEndpointPolicy }}',
'{{ EndpointDetails }}',
'{{ region }}'
RETURNING
web_app_id
;

Manifest

# Description fields are for documentation purposes
- name: web_apps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the web_apps resource.
  - name: IdentityProviderDetails
    description: |
      You can provide a structure that contains the details for the identity provider to use with your web app. For more details about this parameter, see Configure your identity provider for Transfer Family web apps.
    value:
      IdentityCenterConfig:
        InstanceArn: "{{ InstanceArn }}"
        Role: "{{ Role }}"
  - name: AccessEndpoint
    value: "{{ AccessEndpoint }}"
    description: |
      The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.
  - name: WebAppUnits
    description: |
      A union that contains the value for number of concurrent connections or the user sessions on your web app.
    value:
      Provisioned: {{ Provisioned }}
  - name: Tags
    description: |
      Key-value pairs that can be used to group and search for web apps.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: WebAppEndpointPolicy
    value: "{{ WebAppEndpointPolicy }}"
    description: |
      Setting for the type of endpoint policy for the web app. The default value is STANDARD. If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.
    valid_values: ['FIPS', 'STANDARD']
  - name: EndpointDetails
    description: |
      The endpoint configuration for the web app. You can specify whether the web app endpoint is publicly accessible or hosted within a VPC.
    value:
      Vpc:
        SubnetIds:
          - "{{ SubnetIds }}"
        VpcId: "{{ VpcId }}"
        SecurityGroupIds:
          - "{{ SecurityGroupIds }}"
        IpAddressType: "{{ IpAddressType }}"

UPDATE examples

update_web_app

Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

UPDATE aws.transfer.web_apps
SET 
WebAppId = '{{ WebAppId }}',
IdentityProviderDetails = '{{ IdentityProviderDetails }}',
AccessEndpoint = '{{ AccessEndpoint }}',
WebAppUnits = '{{ WebAppUnits }}',
EndpointDetails = '{{ EndpointDetails }}'
WHERE 
region = '{{ region }}' --required
AND WebAppId = '{{ WebAppId }}' --required
RETURNING
web_app_id;

DELETE examples

delete_web_app

Deletes the specified web app.

DELETE FROM aws.transfer.web_apps
WHERE region = '{{ region }}' --required
;