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

Inherits:
Struct
  • Object
show all
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
  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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationTypes::InventoryDestination

Contains information about where to publish the inventory results.


7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#filterTypes::InventoryFilter

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


7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#idString

The ID used to identify the inventory configuration.

Returns:

  • (String)

7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#included_object_versionsString

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)

7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#is_enabledBoolean

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)

7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#optional_fieldsArray<String>

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

Returns:

  • (Array<String>)

7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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

#scheduleTypes::InventorySchedule

Specifies the schedule for generating inventory results.


7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
# File 'lib/aws-sdk-s3/types.rb', line 7016

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