Skip to content

Commit 74d66f6

Browse files
committed
add documentation for aws_transfer_web_app_customization
1 parent 1cd797d commit 74d66f6

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
subcategory: "Transfer Family"
3+
layout: "aws"
4+
page_title: "AWS: aws_transfer_web_app_customization"
5+
description: |-
6+
Terraform resource for managing an AWS Transfer Family Web App Customization.
7+
---
8+
9+
# Resource: aws_transfer_web_app_customization
10+
11+
Terraform resource for managing an AWS Transfer Family Web App Customization.
12+
13+
## Example Usage
14+
15+
### Basic Usage
16+
17+
```terraform
18+
resource "aws_transfer_web_app" "test" {
19+
identity_provider_details {
20+
identity_center_config {
21+
instance_arn = tolist(data.aws_ssoadmin_instances.test.arns)[0]
22+
role = aws_iam_role.test.arn
23+
}
24+
}
25+
web_app_units {
26+
provisioned = 1
27+
}
28+
tags = {
29+
Name = "test"
30+
}
31+
}
32+
33+
resource "aws_transfer_web_app_customization" "test" {
34+
web_app_id = aws_transfer_web_app.test.id
35+
favicon_file = filebase64("${path.module}/favicon.png")
36+
logo_file = filebase64("${path.module}/logo.png")
37+
title = "test"
38+
}
39+
```
40+
41+
## Argument Reference
42+
43+
The following arguments are required:
44+
45+
* `web_app_id` - (Required) The identifier of the web app to be customized.
46+
47+
The following arguments are optional:
48+
49+
* `favicon_file` - (Optional) Base64-encoded string representing the favicon image. Terraform will detect drift only if this argument is specified. To remove the favicon, recreate the resource.
50+
* `logo_file` - (Optional) Base64-encoded string representing the logo image. Terraform will detect drift only if this argument is specified. To remove the logo, recreate the resource.
51+
* `title` – (Optional) Title of the web app.
52+
53+
## Attribute Reference
54+
55+
This resource exports the following attributes in addition to the arguments above:
56+
57+
* `id` - Same as `web_app_id`.
58+
59+
## Timeouts
60+
61+
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
62+
63+
* `create` - (Default `5m`)
64+
* `delete` - (Default `5m`)
65+
66+
## Import
67+
68+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Transfer Family Web App Customization using the `web_app_id`. For example:
69+
70+
```terraform
71+
import {
72+
to = aws_transfer_web_app_customization.example
73+
id = "webapp-12345678901234567890"
74+
}
75+
```
76+
77+
Using `terraform import`, import Transfer Family Web App Customization using the `web_app_id`. For example:
78+
79+
```console
80+
% terraform import aws_transfer_web_app_customization.example webapp-12345678901234567890
81+
```

0 commit comments

Comments
 (0)