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

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

Overview

Note:

When making an API call, you may pass BucketAccessLogConfig data as a hash:

{
  enabled: false, # required
  destination: "BucketName",
  prefix: "BucketAccessLogPrefix",
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationString

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.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

Returns:

  • (String)


1272
1273
1274
1275
1276
1277
1278
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1272

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

#enabledBoolean

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

Returns:

  • (Boolean)


1272
1273
1274
1275
1276
1277
1278
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1272

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

#prefixString

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).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

Returns:

  • (String)


1272
1273
1274
1275
1276
1277
1278
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1272

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