Class: Aws::S3::Types::S3Location
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::S3Location
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
When making an API call, you may pass S3Location data as a hash:
{
bucket_name: "BucketName", # required
prefix: "LocationPrefix", # required
encryption: {
encryption_type: "AES256", # required, accepts AES256, aws:kms
kms_key_id: "SSEKMSKeyId",
kms_context: "KMSContext",
},
canned_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
access_control_list: [
{
grantee: {
display_name: "DisplayName",
email_address: "EmailAddress",
id: "ID",
type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
uri: "URI",
},
permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
},
],
tagging: {
tag_set: [ # required
{
key: "ObjectKey", # required
value: "Value", # required
},
],
},
user_metadata: [
{
name: "MetadataKey",
value: "MetadataValue",
},
],
storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA
}
Describes an S3 location that will receive the results of the restore request.
Instance Attribute Summary collapse
-
#access_control_list ⇒ Array<Types::Grant>
A list of grants that control access to the staged results.
-
#bucket_name ⇒ String
The name of the bucket where the restore results will be placed.
-
#canned_acl ⇒ String
The canned ACL to apply to the restore results.
-
#encryption ⇒ Types::Encryption
Describes the server-side encryption that will be applied to the restore results.
-
#prefix ⇒ String
The prefix that is prepended to the restore results for this request.
-
#storage_class ⇒ String
The class of storage used to store the restore results.
-
#tagging ⇒ Types::Tagging
The tag-set that is applied to the restore results.
-
#user_metadata ⇒ Array<Types::MetadataEntry>
A list of metadata to store with the restore results in S3.
Instance Attribute Details
#access_control_list ⇒ Array<Types::Grant>
A list of grants that control access to the staged results.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#bucket_name ⇒ String
The name of the bucket where the restore results will be placed.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#canned_acl ⇒ String
The canned ACL to apply to the restore results.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#encryption ⇒ Types::Encryption
Describes the server-side encryption that will be applied to the restore results.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#prefix ⇒ String
The prefix that is prepended to the restore results for this request.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#storage_class ⇒ String
The class of storage used to store the restore results.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#tagging ⇒ Types::Tagging
The tag-set that is applied to the restore results.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |
#user_metadata ⇒ Array<Types::MetadataEntry>
A list of metadata to store with the restore results in S3.
7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 |
# File 'lib/aws-sdk-s3/types.rb', line 7928 class S3Location < Struct.new( :bucket_name, :prefix, :encryption, :canned_acl, :access_control_list, :tagging, :user_metadata, :storage_class) include Aws::Structure end |