software.amazon.awscdk.services.s3

Interface CfnBucket.RoutingRuleProperty

All Known Implementing Classes:

CfnBucket.RoutingRuleProperty.Jsii$Proxy

Enclosing class:

CfnBucket

public static interface CfnBucket.RoutingRuleProperty

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 .

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.*;
 RoutingRuleProperty routingRuleProperty = RoutingRuleProperty.builder()
         .redirectRule(RedirectRuleProperty.builder()
                 .hostName("hostName")
                 .httpRedirectCode("httpRedirectCode")
                 .protocol("protocol")
                 .replaceKeyPrefixWith("replaceKeyPrefixWith")
                 .replaceKeyWith("replaceKeyWith")
                 .build())
         // the properties below are optional
         .routingRuleCondition(RoutingRuleConditionProperty.builder()
                 .httpErrorCodeReturnedEquals("httpErrorCodeReturnedEquals")
                 .keyPrefixEquals("keyPrefixEquals")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBucket.RoutingRuleProperty.Builder	builder()
java.lang.Object	getRedirectRule() Container for redirect information.
default java.lang.Object	getRoutingRuleCondition() A container for describing a condition that must be met for the specified redirect to apply.

Method Detail

getRedirectRule

java.lang.Object getRedirectRule()

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.

getRoutingRuleCondition

default java.lang.Object getRoutingRuleCondition()

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.

builder

static CfnBucket.RoutingRuleProperty.Builder builder()

Returns:

a CfnBucket.RoutingRuleProperty.Builder of CfnBucket.RoutingRuleProperty