web_apps

Creates, updates, deletes or gets a web_app resource or lists web_apps in a region

Overview

Name	web_apps
Type	Resource
Description	Resource Type definition for AWS::Transfer::WebApp
Id	awscc.transfer.web_apps

Fields

Name	Datatype	Description
arn	string	Specifies the unique Amazon Resource Name (ARN) for the web app.
web_app_id	string	A unique identifier for the web app.
▶identity_provider_details	object	You can provide a structure that contains the details for the identity provider to use with your web app.
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.
web_app_units	object
▶web_app_customization	object
web_app_endpoint_policy	string
▶tags	array	Key-value pairs that can be used to group and search for web apps.
region	string	AWS region.

For more information, see AWS::Transfer::WebApp.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdentityProviderDetails, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual web_app.

SELECT
region,
arn,
web_app_id,
identity_provider_details,
access_endpoint,
web_app_units,
web_app_customization,
web_app_endpoint_policy,
tags
FROM awscc.transfer.web_apps
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new web_app resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.transfer.web_apps (
 IdentityProviderDetails,
 region
)
SELECT 
'{{ IdentityProviderDetails }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.transfer.web_apps (
 IdentityProviderDetails,
 AccessEndpoint,
 WebAppUnits,
 WebAppCustomization,
 WebAppEndpointPolicy,
 Tags,
 region
)
SELECT 
 '{{ IdentityProviderDetails }}',
 '{{ AccessEndpoint }}',
 '{{ WebAppUnits }}',
 '{{ WebAppCustomization }}',
 '{{ WebAppEndpointPolicy }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: web_app
    props:
      - name: IdentityProviderDetails
        value:
          ApplicationArn: '{{ ApplicationArn }}'
          InstanceArn: '{{ InstanceArn }}'
          Role: '{{ Role }}'
      - name: AccessEndpoint
        value: '{{ AccessEndpoint }}'
      - name: WebAppUnits
        value: null
      - name: WebAppCustomization
        value:
          Title: '{{ Title }}'
          LogoFile: '{{ LogoFile }}'
          FaviconFile: '{{ FaviconFile }}'
      - name: WebAppEndpointPolicy
        value: '{{ WebAppEndpointPolicy }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.transfer.web_apps
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the web_apps resource, the following permissions are required:

Create

transfer:CreateWebApp,
transfer:DescribeWebApp,
transfer:DescribeWebAppCustomization,
transfer:TagResource,
transfer:UpdateWebAppCustomization,
iam:PassRole,
sso:CreateApplication,
sso:DescribeApplication,
sso:ListApplications,
sso:PutApplicationGrant,
sso:GetApplicationGrant,
sso:ListApplicationGrants,
sso:PutApplicationAuthenticationMethod,
sso:GetApplicationAuthenticationMethod,
sso:ListApplicationAuthenticationMethods,
sso:PutApplicationAccessScope,
sso:GetApplicationAccessScope,
sso:ListApplicationAccessScopes

Read

transfer:DescribeWebApp,
transfer:DescribeWebAppCustomization

Update

transfer:DescribeWebApp,
transfer:DescribeWebAppCustomization,
transfer:UpdateWebApp,
transfer:UpdateWebAppCustomization,
transfer:DeleteWebAppCustomization,
transfer:UnTagResource,
transfer:TagResource,
iam:PassRole,
sso:PutApplicationGrant,
sso:GetApplicationGrant,
sso:ListApplicationGrants,
sso:UpdateApplication,
sso:DescribeApplication,
sso:ListApplications

Delete

transfer:DeleteWebApp,
sso:DescribeApplication,
sso:DeleteApplication

List

transfer:ListWebApps