Package software.amazon.awscdk.services.s3

Interface CfnBucket.RoutingRuleConditionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.RoutingRuleConditionProperty.Jsii$Proxy

Enclosing class:

CfnBucket

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

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.

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.*;
 RoutingRuleConditionProperty routingRuleConditionProperty = RoutingRuleConditionProperty.builder()
         .httpErrorCodeReturnedEquals("httpErrorCodeReturnedEquals")
         .keyPrefixEquals("keyPrefixEquals")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucket.RoutingRuleConditionProperty.Builder	builder()
default String	getHttpErrorCodeReturnedEquals()	The HTTP error code when the redirect is applied.
default String	getKeyPrefixEquals()	The object key name prefix when the redirect is applied.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpErrorCodeReturnedEquals

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

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.

See Also:

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

getKeyPrefixEquals

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

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.

See Also:

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

builder

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

Returns:

a CfnBucket.RoutingRuleConditionProperty.Builder of CfnBucket.RoutingRuleConditionProperty