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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing S3Location as input to an Aws::Client method, you can use a vanilla 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, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
}

Describes an Amazon S3 location that will receive the results of the restore request.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_list ⇒ Array<Types::Grant>

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

Returns:

  • (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.

Returns:

  • (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.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • aws-exec-read
  • bucket-owner-read
  • bucket-owner-full-control

Returns:

  • (String) —

    The canned ACL to apply to the restore results.

#encryption ⇒ Types::Encryption

Contains the type of server-side encryption used.

Returns:

#prefix ⇒ String

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

Returns:

  • (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.

Possible values:

  • STANDARD
  • REDUCED_REDUNDANCY
  • STANDARD_IA
  • ONEZONE_IA
  • INTELLIGENT_TIERING
  • GLACIER
  • DEEP_ARCHIVE
  • OUTPOSTS

Returns:

  • (String) —

    The class of storage used to store the restore results.

#tagging ⇒ Types::Tagging

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

Returns:

  • (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.

Returns: