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

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination ⇒ Types::InventoryDestination

Contains information about where to publish the inventory results.

Returns:



8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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:



8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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) 


8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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) 


8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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) 


8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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


8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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:



8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
 
# File 'lib/aws-sdk-s3/types.rb', line 8857

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