Overview
Quickly delete a file or multiple files within an Amazon S3 bucket. Once successfully deleted, the action cannot be undone.
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
S3 Bucket Name |
S3_BUCKET_NAME |
Alphanumeric |
✅ |
None |
- |
The target S3 bucket the target file is in |
|
S3 Folder Name |
S3_SOURCE_FOLDER_NAME |
Alphanumeric |
➖ |
None |
- |
Name of the folder within the bucket where the source file is located. If left blank, the file will be scanned for in the root directory |
|
S3 File Name Match Type |
S3_FILE_MATCH_TYPE |
Select |
✅ |
exact_match |
Exact Match: exact_match
|
Determines if the text in "Local File Name" will look for one file with exact match, or multiple files using regex. |
|
S3 File Name |
S3_SOURCE_FILE_NAME |
Alphanumeric |
✅ |
None |
- |
The name of the file desired to delete. If regex match is selected, then it is the pattern to match files |
|
Access Key ID |
AWS_ACCESS_KEY_ID |
Password |
✅ |
None |
- |
The access key ID for programmatic IAM user used to download the file. See Authorization documentation for more information. |
|
Secret Access Key |
AWS_SECRET_ACCESS_KEY |
Password |
✅ |
None |
- |
The secret access key for programmatic IAM user used to download the file. See Authorization documentation for more information. |
|
Default Region |
AWS_DEFAULT_REGION |
Select |
✅ |
us-east-2 |
us-east-2
|
The AWS region for the S3 bucket and IAM user. |
YAML
Below is the YAML template
source:
template: Amazon S3 - Delete Files
inputs:
S3_BUCKET_NAME:
S3_SOURCE_FOLDER_NAME:
S3_FILE_MATCH_TYPE: exact_match
S3_SOURCE_FILE_NAME:
AWS_ACCESS_KEY_ID:
AWS_SECRET_ACCESS_KEY:
AWS_DEFAULT_REGION: us-east-2
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 10
- 14
- 101
- 102
- 204
- 205
- 206