Class: Aws::S3::Types::RoutingRule

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::RoutingRule

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass RoutingRule data as a hash:

{
  condition: {
    http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
    key_prefix_equals: "KeyPrefixEquals",
  },
  redirect: { # required
    host_name: "HostName",
    http_redirect_code: "HttpRedirectCode",
    protocol: "http", # accepts http, https
    replace_key_prefix_with: "ReplaceKeyPrefixWith",
    replace_key_with: "ReplaceKeyWith",
  },
}

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #condition ⇒ Types::Condition

  A container for describing a condition that must be met for the specified redirect to apply.

• #redirect ⇒ Types::Redirect

  Container for redirect information.

Instance Attribute Details

#condition ⇒ Types::Condition

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ‘/docs` folder, redirect to the `/documents` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

Returns:

• (Types::Condition)

# File 'lib/aws-sdk-s3/types.rb', line 15335

class RoutingRule < Struct.new(
  :condition,
  :redirect)
  SENSITIVE = []
  include Aws::Structure
end

#redirect ⇒ Types::Redirect

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

Returns:

• (Types::Redirect)

# File 'lib/aws-sdk-s3/types.rb', line 15335

class RoutingRule < Struct.new(
  :condition,
  :redirect)
  SENSITIVE = []
  include Aws::Structure
end