Class: Aws::S3::Types::InventoryConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::InventoryConfiguration

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  destination: { # required
    s3_bucket_destination: { # required
      account_id: "AccountId",
      bucket: "BucketName", # required
      format: "CSV", # required, accepts CSV, ORC, Parquet
      prefix: "Prefix",
      encryption: {
        sses3: {
        },
        ssekms: {
          key_id: "SSEKMSKeyId", # required
        },
      },
    },
  },
  is_enabled: false, # required
  filter: {
    prefix: "Prefix", # required
  },
  id: "InventoryId", # required
  included_object_versions: "All", # required, accepts All, Current
  optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus, ChecksumAlgorithm
  schedule: { # required
    frequency: "Daily", # required, accepts Daily, Weekly
  },
}

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory] in the *Amazon S3 API Reference*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination ⇒ Types::InventoryDestination

  Contains information about where to publish the inventory results.

• #filter ⇒ Types::InventoryFilter

  Specifies an inventory filter.

• #id ⇒ String

  The ID used to identify the inventory configuration.

• #included_object_versions ⇒ String

  Object versions to include in the inventory list.

• #is_enabled ⇒ Boolean

  Specifies whether the inventory is enabled or disabled.

• #optional_fields ⇒ Array<String>

  Contains the optional fields that are included in the inventory results.

• #schedule ⇒ Types::InventorySchedule

  Specifies the schedule for generating inventory results.

Instance Attribute Details

#destination ⇒ Types::InventoryDestination

Contains information about where to publish the inventory results.

Returns:

• (Types::InventoryDestination)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::InventoryFilter

Specifies an inventory filter. The inventory only includes objects that meet the filter’s criteria.

Returns:

• (Types::InventoryFilter)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID used to identify the inventory configuration.

Returns:

• (String)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#included_object_versions ⇒ String

Object versions to include in the inventory list. If set to ‘All`, the list includes all the object versions, which adds the version-related fields `VersionId`, `IsLatest`, and `DeleteMarker` to the list. If set to `Current`, the list does not contain these version-related fields.

Returns:

• (String)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#is_enabled ⇒ Boolean

Specifies whether the inventory is enabled or disabled. If set to ‘True`, an inventory list is generated. If set to `False`, no inventory list is generated.

Returns:

• (Boolean)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#optional_fields ⇒ Array<String>

Contains the optional fields that are included in the inventory results.

Returns:

• (Array<String>)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::InventorySchedule

Specifies the schedule for generating inventory results.

Returns:

• (Types::InventorySchedule)

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

class InventoryConfiguration < Struct.new(
  :destination,
  :is_enabled,
  :filter,
  :id,
  :included_object_versions,
  :optional_fields,
  :schedule)
  SENSITIVE = []
  include Aws::Structure
end