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

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

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

Overview

Note:

When passing InventoryConfiguration as input to an Aws::Client method, you can use a vanilla 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
  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 Simple Storage Service API Reference.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#destination ⇒ Types::InventoryDestination

Contains information about where to publish the inventory results.

Returns:

#filter ⇒ Types::InventoryFilter

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

Returns:

#id ⇒ String

The ID used to identify the inventory configuration.

Returns:

  • (String) —

    The ID used to identify the inventory configuration.

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

Possible values:

  • All
  • Current

Returns:

  • (String) —

    Object versions to include in the inventory list.

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

    Specifies whether the inventory is enabled or disabled.

#optional_fields ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#schedule ⇒ Types::InventorySchedule

Specifies the schedule for generating inventory results.

Returns: