You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::S3Location

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

Overview

Note:

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

Instance Attribute Details

#access_control_listArray<Types::Grant>

A list of grants that control access to the staged results.

Returns:



7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#bucket_nameString

The name of the bucket where the restore results will be placed.

Returns:

  • (String)


7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#canned_aclString

The canned ACL to apply to the restore results.

Returns:

  • (String)


7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#encryptionTypes::Encryption

Describes the server-side encryption that will be applied to the restore results.

Returns:



7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#prefixString

The prefix that is prepended to the restore results for this request.

Returns:

  • (String)


7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#storage_classString

The class of storage used to store the restore results.

Returns:

  • (String)


7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#taggingTypes::Tagging

The tag-set that is applied to the restore results.

Returns:



7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end

#user_metadataArray<Types::MetadataEntry>

A list of metadata to store with the restore results in S3.

Returns:



7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7989

class S3Location < Struct.new(
  :bucket_name,
  :prefix,
  :encryption,
  :canned_acl,
  :access_control_list,
  :tagging,
  :user_metadata,
  :storage_class)
  include Aws::Structure
end