Class: Aws::S3Control::Types::S3JobManifestGenerator

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

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

{
  expected_bucket_owner: "AccountId",
  source_bucket: "S3BucketArnString", # required
  manifest_output_location: {
    expected_manifest_bucket_owner: "AccountId",
    bucket: "S3BucketArnString", # required
    manifest_prefix: "ManifestPrefixString",
    manifest_encryption: {
      sses3: {
      },
      ssekms: {
        key_id: "KmsKeyArnString", # required
      },
    },
    manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130
  },
  filter: {
    eligible_for_replication: false,
    created_after: Time.now,
    created_before: Time.now,
    object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE
  },
  enable_manifest_output: false, # required
}

The container for the service that will create the S3 manifest.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enable_manifest_outputBoolean

Determines whether or not to write the job's generated manifest to a bucket.

Returns:

  • (Boolean)


5833
5834
5835
5836
5837
5838
5839
5840
5841
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5833

class S3JobManifestGenerator < Struct.new(
  :expected_bucket_owner,
  :source_bucket,
  :manifest_output_location,
  :filter,
  :enable_manifest_output)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

Returns:

  • (String)


5833
5834
5835
5836
5837
5838
5839
5840
5841
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5833

class S3JobManifestGenerator < Struct.new(
  :expected_bucket_owner,
  :source_bucket,
  :manifest_output_location,
  :filter,
  :enable_manifest_output)
  SENSITIVE = []
  include Aws::Structure
end

#filterTypes::JobManifestGeneratorFilter

Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.



5833
5834
5835
5836
5837
5838
5839
5840
5841
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5833

class S3JobManifestGenerator < Struct.new(
  :expected_bucket_owner,
  :source_bucket,
  :manifest_output_location,
  :filter,
  :enable_manifest_output)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_output_locationTypes::S3ManifestOutputLocation

Specifies the location the generated manifest will be written to.



5833
5834
5835
5836
5837
5838
5839
5840
5841
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5833

class S3JobManifestGenerator < Struct.new(
  :expected_bucket_owner,
  :source_bucket,
  :manifest_output_location,
  :filter,
  :enable_manifest_output)
  SENSITIVE = []
  include Aws::Structure
end

#source_bucketString

The source bucket used by the ManifestGenerator.

Returns:

  • (String)


5833
5834
5835
5836
5837
5838
5839
5840
5841
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5833

class S3JobManifestGenerator < Struct.new(
  :expected_bucket_owner,
  :source_bucket,
  :manifest_output_location,
  :filter,
  :enable_manifest_output)
  SENSITIVE = []
  include Aws::Structure
end