web_app_customizations

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

Overview

Name	web_app_customizations
Type	Resource
Id	aws.transfer.web_app_customizations

Fields

The following fields are returned by SELECT queries:

describe_web_app_customization

Name	Datatype	Description
arn	string	Returns the Amazon Resource Name (ARN) for the web app. (pattern: <code>arn:\S+</code>)
favicon_file	string (byte)	Returns an icon file data string (in base64 encoding).
logo_file	string (byte)	Returns a logo file data string (in base64 encoding).
title	string	Returns the page title that you defined for your web app.
web_app_id	string	Returns the unique identifier for your 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_customization	select	region		Describes the web app customization object that's identified by WebAppId.
update_web_app_customization	update	region, WebAppId		Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.
delete_web_app_customization	delete	region		Deletes the WebAppCustomization object that corresponds to the web app ID specified.

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_customization

Describes the web app customization object that's identified by WebAppId.

SELECT
arn,
favicon_file,
logo_file,
title,
web_app_id
FROM aws.transfer.web_app_customizations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_web_app_customization

Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

UPDATE aws.transfer.web_app_customizations
SET 
WebAppId = '{{ WebAppId }}',
Title = '{{ Title }}',
LogoFile = '{{ LogoFile }}',
FaviconFile = '{{ FaviconFile }}'
WHERE 
region = '{{ region }}' --required
AND WebAppId = '{{ WebAppId }}' --required
RETURNING
web_app_id;

DELETE examples

delete_web_app_customization

Deletes the WebAppCustomization object that corresponds to the web app ID specified.

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