Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Upload To S3 Log File Rotation Listener may be used to upload a log file to a specified Amazon S3 bucket as soon as it has been rotated.
The Upload To S3 Log File Rotation Listener component inherits from the Log File Rotation Listener
The following components have a direct aggregation relation from Upload To S3 Log File Rotation Listeners:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| aws-external-server | |
| s3-bucket-name | |
| target-throughput-in-megabits-per-second | |
| maximum-concurrent-transfer-connections | |
| maximum-file-count-to-retain | |
| maximum-file-age-to-retain | |
| file-retention-pattern |
| Description | A description for this Log File Rotation Listener |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Log File Rotation Listener is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The external server with information to use when interacting with the AWS S3 service. |
| Default Value | None |
| Allowed Values | The DN of any Amazon Aws External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the S3 bucket into which rotated log files should be copied. The bucket must already exist, and the account used to interact with the S3 service must have permission to add, remove, and list files in that bucket. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
target-throughput-in-megabits-per-second
| Description | The target throughput to attempt to achieve for data transfers to or from S3, in megabits per second. If this is not specified, the AWS SDK's default target rate will be used. |
| Default Value | The AWS SDK's default target rate will be used. |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-concurrent-transfer-connections
| Description | The maximum number of concurrent connections that may be used when transferring data to or from S3. Multiple concurrent connections may be used to speed up data transfers. If this is not specified, the AWS SDK's default maximum number of concurrent connections will be used. |
| Default Value | The AWS SDK's default maximum number of concurrent connections will be used. |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum number of existing files matching the file retention pattern that should be retained in the S3 bucket after successfully uploading a newly rotated file. If a maximum retention count is specified, and if the S3 bucket contains more than this number of files that match the file retention pattern, then existing files matching that pattern will be deleted, from oldest to youngest, until the number of files is within the retain count. Files that do not match the retention pattern will not be removed. When performing retention processing, the rotation listener will not remove the file that it just uploaded, so this count specifies the number of existing files that will be retained. For example, if the retention count is five, then the bucket will be allowed to retain up to six rotated log files (the newly rotated file that was uploaded, and the five most recent files that were also retained). If both maximum-file-count-to-retain and maximum-file-age-to-retain are specified, then a file may be deleted if it matches the criteria for either property. If neither is specified, then files will not be automatically removed and will be retained indefinitely unless they are manually removed. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum length of time to retain files matching the file retention pattern that should be retained in the S3 bucket after successfully uploading a newly rotated file. If a maximum retention age is specified, then any files that match the file retention pattern that are older than this age will be deleted. Files that do not match the retention pattern will not be removed. If both maximum-file-count-to-retain and maximum-file-age-to-retain are specified, then a file may be deleted if it matches the criteria for either property. If neither is specified, then files will not be automatically removed and will be retained indefinitely unless they are manually removed. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A regular expression pattern that will be used to identify which files are candidates for automatic removal based on the maximum-file-count-to-retain and maximum-file-age-to-retain properties. By default, all files in the bucket will be eligible for removal by retention processing. |
| Default Value | .* |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Log File Rotation Listeners:
dsconfig list-log-file-rotation-listeners
[--property {propertyName}] ...
To view the configuration for an existing Log File Rotation Listener:
dsconfig get-log-file-rotation-listener-prop
--listener-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log File Rotation Listener:
dsconfig set-log-file-rotation-listener-prop
--listener-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Upload To S3 Log File Rotation Listener:
dsconfig create-log-file-rotation-listener
--listener-name {name}
--type upload-to-s3
--set enabled:{propertyValue}
--set aws-external-server:{propertyValue}
--set s3-bucket-name:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log File Rotation Listener:
dsconfig delete-log-file-rotation-listener
--listener-name {name}