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
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
-
#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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 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.
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 |
# File 'lib/aws-sdk-s3/types.rb', line 9137 class InventoryConfiguration < Struct.new( :destination, :is_enabled, :filter, :id, :included_object_versions, :optional_fields, :schedule) SENSITIVE = [] include Aws::Structure end |