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

Class: Aws::S3::Types::RestoreRequest

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

Overview

Note:

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

{
  days: 1,
  glacier_job_parameters: {
    tier: "Standard", # required, accepts Standard, Bulk, Expedited
  },
  type: "SELECT", # accepts SELECT
  tier: "Standard", # accepts Standard, Bulk, Expedited
  description: "Description",
  select_parameters: {
    input_serialization: { # required
      csv: {
        file_header_info: "USE", # accepts USE, IGNORE, NONE
        comments: "Comments",
        quote_escape_character: "QuoteEscapeCharacter",
        record_delimiter: "RecordDelimiter",
        field_delimiter: "FieldDelimiter",
        quote_character: "QuoteCharacter",
        allow_quoted_record_delimiter: false,
      },
      compression_type: "NONE", # accepts NONE, GZIP, BZIP2
      json: {
        type: "DOCUMENT", # accepts DOCUMENT, LINES
      },
      parquet: {
      },
    },
    expression_type: "SQL", # required, accepts SQL
    expression: "Expression", # required
    output_serialization: { # required
      csv: {
        quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
        quote_escape_character: "QuoteEscapeCharacter",
        record_delimiter: "RecordDelimiter",
        field_delimiter: "FieldDelimiter",
        quote_character: "QuoteCharacter",
      },
      json: {
        record_delimiter: "RecordDelimiter",
      },
    },
  },
  output_location: {
    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
    },
  },
}

Container for restore job parameters.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#days ⇒ Integer

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Returns:

  • (Integer) —

    Lifetime of the active copy in days.

#description ⇒ String

The optional description for the job.

Returns:

  • (String) —

    The optional description for the job.

#glacier_job_parameters ⇒ Types::GlacierJobParameters

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Returns:

#output_location ⇒ Types::OutputLocation

Describes the location where the restore job\'s output is stored.

Returns:

#select_parameters ⇒ Types::SelectParameters

Describes the parameters for Select job types.

Returns:

#tier ⇒ String

Retrieval tier at which the restore will be processed.

Possible values:

  • Standard
  • Bulk
  • Expedited

Returns:

  • (String) —

    Retrieval tier at which the restore will be processed.

#type ⇒ String

Type of restore request.

Possible values:

  • SELECT

Returns:

  • (String) —

    Type of restore request.