s3:summarizebuckets
Full name:
org.kuali.maven.plugins:s3-maven-plugin:1.0.0-SNAPSHOT:summarizebuckets
Description:
Generate summary information for any S3 buckets "owned" by the
provided accessKey
Attributes:
- Requires a Maven project to be executed.
Required Parameters
Name |
Type |
Since |
Description |
accessKey |
String |
- |
The AWS Access Key Id for an account on S3
|
secretKey |
String |
- |
The AWS Secret Access Key for an account on S3
|
Optional Parameters
Name |
Type |
Since |
Description |
csvFile |
File |
- |
The file where the CSV summary is written. If the file already
exists, it is appended to. Default value is: ${project.build.directory}/s3/summary.csv. |
exclude |
String |
- |
A comma separated list of buckets to exclude from the summary
|
include |
String |
- |
A comma separated list of buckets to include in the summary
|
writeCsv |
boolean |
- |
If true, a CSV file is generated containing bucket summary
statistics. Default value is: true. |
Parameter Details
accessKey:
The AWS Access Key Id for an account on S3
- Type: java.lang.String
- Required: Yes
- Expression: ${s3.accessKey}
csvFile:
The file where the CSV summary is written. If the file already
exists, it is appended to.
- Type: java.io.File
- Required: No
- Expression: ${s3.csvFile}
- Default: ${project.build.directory}/s3/summary.csv
exclude:
A comma separated list of buckets to exclude from the summary
- Type: java.lang.String
- Required: No
- Expression: ${s3.exclude}
include:
A comma separated list of buckets to include in the summary
- Type: java.lang.String
- Required: No
- Expression: ${s3.include}
secretKey:
The AWS Secret Access Key for an account on S3
- Type: java.lang.String
- Required: Yes
- Expression: ${s3.secretKey}
writeCsv:
If true, a CSV file is generated containing bucket summary
statistics.
- Type: boolean
- Required: No
- Expression: ${s3.writeCsv}
- Default: true