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

Class: Aws::Glacier::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: "string",
  prefix: "string",
  encryption: {
    encryption_type: "aws:kms", # accepts aws:kms, AES256
    kms_key_id: "string",
    kms_context: "string",
  },
  canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
  access_control_list: [
    {
      grantee: {
        type: "AmazonCustomerByEmail", # required, accepts AmazonCustomerByEmail, CanonicalUser, Group
        display_name: "string",
        uri: "string",
        id: "string",
        email_address: "string",
      },
      permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
    },
  ],
  tagging: {
    "string" => "string",
  },
  user_metadata: {
    "string" => "string",
  },
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA
}

Contains information about the location in Amazon S3 where the select job results are stored.

Returned by:

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 Amazon S3 bucket where the job results are stored.

Returns:

  • (String) —

    The name of the Amazon S3 bucket where the job results are stored.

#canned_acl ⇒ String

The canned access control list (ACL) to apply to the job results.

Possible values:

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

Returns:

  • (String) —

    The canned access control list (ACL) to apply to the job results.

#encryption ⇒ Types::Encryption

Contains information about the encryption used to store the job results in Amazon S3.

Returns:

  • (Types::Encryption) —

    Contains information about the encryption used to store the job results in Amazon S3.

#prefix ⇒ String

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

Returns:

  • (String) —

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

#storage_class ⇒ String

The storage class used to store the job results.

Possible values:

  • STANDARD
  • REDUCED_REDUNDANCY
  • STANDARD_IA

Returns:

  • (String) —

    The storage class used to store the job results.

#tagging ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

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

#user_metadata ⇒ Hash<String,String>

A map of metadata to store with the job results in Amazon S3.

Returns:

  • (Hash<String,String>) —

    A map of metadata to store with the job results in Amazon S3.