AWS::S3::Bucket RedirectRule
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "HostName" :
String
, "HttpRedirectCode" :String
, "Protocol" :String
, "ReplaceKeyPrefixWith" :String
, "ReplaceKeyWith" :String
}
YAML
HostName:
String
HttpRedirectCode:String
Protocol:String
ReplaceKeyPrefixWith:String
ReplaceKeyWith:String
Properties
HostName
-
The host name to use in the redirect request.
Required: No
Type: String
Update requires: No interruption
HttpRedirectCode
-
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
Required: No
Type: String
Update requires: No interruption
Protocol
-
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
Required: No
Type: String
Allowed values:
http | https
Update requires: No interruption
ReplaceKeyPrefixWith
-
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix
docs/
(objects in thedocs/
folder) todocuments/
, you can set a condition block withKeyPrefixEquals
set todocs/
and in the Redirect setReplaceKeyPrefixWith
to/documents
. Not required if one of the siblings is present. Can be present only ifReplaceKeyWith
is not provided.Important 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.
Required: No
Type: String
Update requires: No interruption
ReplaceKeyWith
-
The specific object key to use in the redirect request. For example, redirect request to
error.html
. Not required if one of the siblings is present. Can be present only ifReplaceKeyPrefixWith
is not provided.Important 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.
Required: No
Type: String
Update requires: No interruption
See also
-
AWS::S3::Bucket Examples