You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::AnalyticsS3BucketDestination

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AnalyticsS3BucketDestination as input to an Aws::Client method, you can use a vanilla Hash:

{
  format: "CSV", # required, accepts CSV
  bucket_account_id: "AccountId",
  bucket: "BucketName", # required
  prefix: "Prefix",
}

Contains information about where to publish the analytics results.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The Amazon Resource Name (ARN) of the bucket to which data is exported.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the bucket to which data is exported.

#bucket_account_idString

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

Returns:

  • (String)

    The account ID that owns the destination S3 bucket.

#formatString

Specifies the file format used when exporting data to Amazon S3.

Possible values:

  • CSV

Returns:

  • (String)

    Specifies the file format used when exporting data to Amazon S3.

#prefixString

The prefix to use when exporting data. The prefix is prepended to all results.

Returns:

  • (String)

    The prefix to use when exporting data.