You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::S3::Types::Condition
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::Condition
- Defined in:
- (unknown)
Overview
When passing Condition as input to an Aws::Client method, you can use a vanilla Hash:
{
http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
key_prefix_equals: "KeyPrefixEquals",
}
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.
Returned by:
Instance Attribute Summary collapse
-
#http_error_code_returned_equals ⇒ String
The HTTP error code when the redirect is applied.
-
#key_prefix_equals ⇒ String
The object key name prefix when the redirect is applied.
Instance Attribute Details
#http_error_code_returned_equals ⇒ String
The HTTP error code when the redirect is applied. In the event of an
error, if the error code equals this value, then the specified redirect
is applied. Required when parent element Condition
is specified and
sibling KeyPrefixEquals
is not specified. If both are specified, then
both must be true for the redirect to be applied.
#key_prefix_equals ⇒ String
The object key name prefix when the redirect is applied. For example, to
redirect requests for ExamplePage.html
, the key prefix will be
ExamplePage.html
. To redirect request for all pages with the prefix
docs/
, the key prefix will be /docs
, which identifies all objects in
the docs/
folder. Required when the parent element Condition
is
specified and sibling HttpErrorCodeReturnedEquals
is not specified. If
both conditions are specified, both must be true for the redirect to be
applied.