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

Class: Aws::Glacier::Types::S3Location

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

Overview

Note:

When making an API call, you may pass S3Location data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_listArray<Types::Grant>

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

Returns:



2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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

Returns:

  • (String)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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 access control list (ACL) to apply to the job results.

Returns:

  • (String)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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

#encryptionTypes::Encryption

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

Returns:



2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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 results for this request.

Returns:

  • (String)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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 storage class used to store the job results.

Returns:

  • (String)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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

#taggingHash<String,String>

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

Returns:

  • (Hash<String,String>)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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

#user_metadataHash<String,String>

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

Returns:

  • (Hash<String,String>)


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2406

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