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

Class: Aws::S3::Types::OutputLocation

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

Overview

Note:

When passing OutputLocation as input to an Aws::Client method, you can use a vanilla Hash:

{
  s3: {
    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 the location where the restore job's output is stored.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#s3 ⇒ Types::S3Location

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

Returns:

  • (Types::S3Location) —

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