public class SetBucketLoggingConfigurationRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest
Contains options for setting the logging configuration for a bucket. The bucket logging configuration object controls whether or not server access logging is enabled for the specified bucket. If server access logging is enabled, this object provides options for specifying where the server access logs are delivered and the optional log file prefix.
In order to deliver server access logs, the destination bucket must have log
delivery write permissions. Use the
CannedAccessControlList.LogDeliveryWrite
ACL to quickly add the
correct permissions to the destination bucket. Alternatively, modify the
bucket's existing ACL to grant the GroupGrantee.LogDelivery
group
grantee the Permission.Write
permission.
Changes to the logging status for a bucket are visible in the configuration API immediately, but take time to actually affect the delivery of log files. For example, when enabling logging for a bucket, some requests made in the following hour might be logged while others might not. For another example, when changing the target bucket for logging from bucket 'A' to bucket 'B', some logs for the next hour might continue to be delivered to bucket 'A.' Others might be delivered to the new target bucket 'B.' In all cases, the new settings will eventually take effect without any further action from the user.
NOOP
Constructor and Description |
---|
SetBucketLoggingConfigurationRequest(String bucketName,
BucketLoggingConfiguration loggingConfiguration)
Constructs a new
SetBucketLoggingConfigurationRequest
to set the bucket logging configuration of
the specified bucket. |
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
Gets the name of the bucket whose logging configuration is being set.
|
String |
getExpectedBucketOwner()
Returns he account id of the expected bucket owner.
|
BucketLoggingConfiguration |
getLoggingConfiguration()
Gets the logging configuration for the specified bucket.
|
TargetObjectKeyFormat |
getTargetObjectKeyFormat()
Returns the
TargetObjectKeyFormat for this logging configuration request. |
void |
setBucketName(String bucketName)
Sets the name of the bucket whose logging configuration is being set.
|
void |
setExpectedBucketOwner(String expectedBucketOwner)
Set the account id of the expected bucket owner.
|
void |
setLoggingConfiguration(BucketLoggingConfiguration loggingConfiguration)
Sets the logging configuration for the specified bucket.
|
void |
setTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
Sets the
TargetObjectKeyFormat for this logging configuration request. |
SetBucketLoggingConfigurationRequest |
withBucketName(String bucketName)
Sets the name of the bucket whose logging configuration is being set
and returns this object, enabling additional method calls to be
chained together.
|
SetBucketLoggingConfigurationRequest |
withExpectedBucketOwner(String expectedBucketOwner)
Set the account id of the expected bucket owner.
|
SetBucketLoggingConfigurationRequest |
withLoggingConfiguration(BucketLoggingConfiguration loggingConfiguration)
Sets the logging configuration for the specified bucket and returns
the updated object, enabling additional method calls to be chained
together.
|
SetBucketLoggingConfigurationRequest |
withTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
Sets the
TargetObjectKeyFormat for this logging configuration request and returns this object for method chaining. |
addHandlerContext, clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SetBucketLoggingConfigurationRequest(String bucketName, BucketLoggingConfiguration loggingConfiguration)
SetBucketLoggingConfigurationRequest
to set the bucket logging configuration of
the specified bucket.bucketName
- The name of the bucket whose logging configuration is being
set.loggingConfiguration
- The new logging configuration for the specified bucket.public String getExpectedBucketOwner()
ExpectedBucketOwnerRequest
403 (Access Denied)
error.getExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public SetBucketLoggingConfigurationRequest withExpectedBucketOwner(String expectedBucketOwner)
ExpectedBucketOwnerRequest
403 (Access Denied)
error.withExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public void setExpectedBucketOwner(String expectedBucketOwner)
ExpectedBucketOwnerRequest
403 (Access Denied)
error.setExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public String getBucketName()
setBucketName(String)
,
withLoggingConfiguration(BucketLoggingConfiguration)
public void setBucketName(String bucketName)
bucketName
- The name of the bucket whose logging configuration is being
set.getBucketName()
,
withBucketName(String)
public SetBucketLoggingConfigurationRequest withBucketName(String bucketName)
bucketName
- The name of the bucket whose logging configuration is being
set.SetBucketLoggingConfigurationRequest
object, enabling
additional method calls may to be chained together.getBucketName()
,
setBucketName(String)
public BucketLoggingConfiguration getLoggingConfiguration()
setLoggingConfiguration(BucketLoggingConfiguration)
,
withLoggingConfiguration(BucketLoggingConfiguration)
public void setLoggingConfiguration(BucketLoggingConfiguration loggingConfiguration)
loggingConfiguration
- The logging configuration for the specified bucket.getLoggingConfiguration()
,
withLoggingConfiguration(BucketLoggingConfiguration)
public SetBucketLoggingConfigurationRequest withLoggingConfiguration(BucketLoggingConfiguration loggingConfiguration)
loggingConfiguration
- The logging configuration for the specified bucket.SetBucketLoggingConfigurationRequest
object, enabling
additional method calls to be chained together.getLoggingConfiguration()
,
setLoggingConfiguration(BucketLoggingConfiguration)
public TargetObjectKeyFormat getTargetObjectKeyFormat()
TargetObjectKeyFormat
for this logging configuration request.TargetObjectKeyFormat
for this logging configuration request.public void setTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
TargetObjectKeyFormat
for this logging configuration request.targetObjectKeyFormat
- The TargetObjectKeyFormat
for this logging configuration request.public SetBucketLoggingConfigurationRequest withTargetObjectKeyFormat(TargetObjectKeyFormat targetObjectKeyFormat)
TargetObjectKeyFormat
for this logging configuration request and returns this object for method chaining.targetObjectKeyFormat
- The TargetObjectKeyFormat
for this logging configuration request.