AWS S3

Enable bucket logging

Set the logging parameters for a bucket, and specify permissions for who can view and modify the logging parameters.

Inputs

Expand All

Field

Type

Description

region [required]

enum

default: us-east-1

bucket [required]

string

The name of the bucket for which to set the logging parameters.

targetBucket [required]

string

Specifies the bucket where you want Amazon S3 to store server access logs.

targetPrefix [required]

string

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

targetGrants

[object]

Container for granting information.

Grantee

object

Container for the person being granted permissions.

DisplayName

string

Screen name of the grantee.

EmailAddress

string

Email address of the grantee. Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

ID

string

The canonical user ID of the grantee.

Type [required]

string

Type of grantee

URI

string

URI of the grantee group.

Permission

string

Logging permissions assigned to the grantee for the bucket.

Outputs

Expand All

Field

Type

Description

TargetBucket [required]

string

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

TargetGrants

[object]

Container for granting information. Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

Grantee

object

Container for the person being granted permissions.

DisplayName

string

Screen name of the grantee.

EmailAddress

string

Email address of the grantee. Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

ID

string

The canonical user ID of the grantee.

Type [required]

string

Type of grantee

URI

string

URI of the grantee group.

Permission

string

Logging permissions assigned to the grantee for the bucket.

TargetPrefix [required]

string

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

TargetObjectKeyFormat

object

Amazon S3 key format for log objects.

SimplePrefix

object

To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.

PartitionedPrefix

object

Partitioned S3 key for log objects.

PartitionDateSource

string

Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

amzRequestId [required]

string