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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::AnalyticsS3BucketDestination

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

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

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

Contains information about where to publish the analytics results.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #bucket_account_id ⇒ String

  The account ID that owns the destination S3 bucket.

• #format ⇒ String

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

• #prefix ⇒ String

  The prefix to use when exporting data.

Instance Attribute Details

#bucket ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 434

class AnalyticsS3BucketDestination < Struct.new(
  :format,
  :bucket_account_id,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_account_id ⇒ String

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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 434

class AnalyticsS3BucketDestination < Struct.new(
  :format,
  :bucket_account_id,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 434

class AnalyticsS3BucketDestination < Struct.new(
  :format,
  :bucket_account_id,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 434

class AnalyticsS3BucketDestination < Struct.new(
  :format,
  :bucket_account_id,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end