Class: Aws::S3::Types::InventoryS3BucketDestination

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

Overview

Note:

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

{
  account_id: "AccountId",
  bucket: "BucketName", # required
  format: "CSV", # required, accepts CSV, ORC, Parquet
  prefix: "Prefix",
  encryption: {
    sses3: {
    },
    ssekms: {
      key_id: "SSEKMSKeyId", # required
    },
  },
}

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


8011
8012
8013
8014
8015
8016
8017
8018
8019
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8011

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

#bucketString

The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

Returns:

  • (String)


8011
8012
8013
8014
8015
8016
8017
8018
8019
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8011

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

#encryptionTypes::InventoryEncryption

Contains the type of server-side encryption used to encrypt the inventory results.



8011
8012
8013
8014
8015
8016
8017
8018
8019
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8011

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

#formatString

Specifies the output format of the inventory results.

Returns:

  • (String)


8011
8012
8013
8014
8015
8016
8017
8018
8019
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8011

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

#prefixString

The prefix that is prepended to all inventory results.

Returns:

  • (String)


8011
8012
8013
8014
8015
8016
8017
8018
8019
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8011

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