Class: Aws::Lightsail::Types::BucketAccessLogConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lightsail/types.rb

Overview

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see [Logging bucket requests using access logging in Amazon Lightsail] in the *Amazon Lightsail Developer Guide*.

[1]: docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-bucket-access-logs

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination ⇒ String

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

<note markdown=“1”> This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

</note>

Returns:

  • (String) 


1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1245

class BucketAccessLogConfig < Struct.new(
  :enabled,
  :destination,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

Returns:

  • (Boolean) 


1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1245

class BucketAccessLogConfig < Struct.new(
  :enabled,
  :destination,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a ‘logs/` prefix, then each log object will begin with the `logs/` prefix in its key (for example, `logs/2021-11-01-21-32-16-E568B2907131C0C0`).

<note markdown=“1”> This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

</note>

Returns:

  • (String) 


1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1245

class BucketAccessLogConfig < Struct.new(
  :enabled,
  :destination,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end