Class: Aws::S3::Types::Condition
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::Condition
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
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.
1303 1304 1305 1306 1307 1308 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1303 class Condition < Struct.new( :http_error_code_returned_equals, :key_prefix_equals) SENSITIVE = [] include Aws::Structure end |
#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.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
1303 1304 1305 1306 1307 1308 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1303 class Condition < Struct.new( :http_error_code_returned_equals, :key_prefix_equals) SENSITIVE = [] include Aws::Structure end |