Package software.amazon.awscdk.services.s3

Interface CfnBucket.RedirectRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.RedirectRuleProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.RedirectRuleProperty
extends software.amazon.jsii.JsiiSerializable

Specifies how requests are redirected.

In the event of an error, you can specify a different error code to return.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 RedirectRuleProperty redirectRuleProperty = RedirectRuleProperty.builder()
         .hostName("hostName")
         .httpRedirectCode("httpRedirectCode")
         .protocol("protocol")
         .replaceKeyPrefixWith("replaceKeyPrefixWith")
         .replaceKeyWith("replaceKeyWith")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.RedirectRuleProperty.Builder	A builder for CfnBucket.RedirectRuleProperty
static final class	CfnBucket.RedirectRuleProperty.Jsii$Proxy	An implementation for CfnBucket.RedirectRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.RedirectRuleProperty.Builder	builder()
default String	getHostName()	The host name to use in the redirect request.
default String	getHttpRedirectCode()	The HTTP redirect code to use on the response.
default String	getProtocol()	Protocol to use when redirecting requests.
default String	getReplaceKeyPrefixWith()	The object key prefix to use in the redirect request.
default String	getReplaceKeyWith()	The specific object key to use in the redirect request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHostName

@Stability(Stable)
@Nullable
default String getHostName()

The host name to use in the redirect request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-hostname

getHttpRedirectCode

@Stability(Stable)
@Nullable
default String getHttpRedirectCode()

The HTTP redirect code to use on the response.

Not required if one of the siblings is present.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-httpredirectcode

getProtocol

@Stability(Stable)
@Nullable
default String getProtocol()

Protocol to use when redirecting requests.

The default is the protocol that is used in the original request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-protocol

getReplaceKeyPrefixWith

@Stability(Stable)
@Nullable
default String getReplaceKeyPrefixWith()

The object key prefix to use in the redirect request.

For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/ , you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents . Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-replacekeyprefixwith

getReplaceKeyWith

@Stability(Stable)
@Nullable
default String getReplaceKeyWith()

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 if ReplaceKeyPrefixWith is not provided.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-replacekeywith

builder

@Stability(Stable)
static CfnBucket.RedirectRuleProperty.Builder builder()

Returns:

a CfnBucket.RedirectRuleProperty.Builder of CfnBucket.RedirectRuleProperty