Package software.amazon.awscdk.services.s3

Class CfnBucket.RedirectRuleProperty.Builder

java.lang.Object

software.amazon.awscdk.services.s3.CfnBucket.RedirectRuleProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBucket.RedirectRuleProperty>

Enclosing interface:

CfnBucket.RedirectRuleProperty

@Stability(Stable)
public static final class CfnBucket.RedirectRuleProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBucket.RedirectRuleProperty>

A builder for CfnBucket.RedirectRuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBucket.RedirectRuleProperty	build()	Builds the configured instance.
CfnBucket.RedirectRuleProperty.Builder	hostName(String hostName)	Sets the value of CfnBucket.RedirectRuleProperty.getHostName()
CfnBucket.RedirectRuleProperty.Builder	httpRedirectCode(String httpRedirectCode)	Sets the value of CfnBucket.RedirectRuleProperty.getHttpRedirectCode()
CfnBucket.RedirectRuleProperty.Builder	protocol(String protocol)	Sets the value of CfnBucket.RedirectRuleProperty.getProtocol()
CfnBucket.RedirectRuleProperty.Builder	replaceKeyPrefixWith(String replaceKeyPrefixWith)	Sets the value of CfnBucket.RedirectRuleProperty.getReplaceKeyPrefixWith()
CfnBucket.RedirectRuleProperty.Builder	replaceKeyWith(String replaceKeyWith)	Sets the value of CfnBucket.RedirectRuleProperty.getReplaceKeyWith()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

hostName

@Stability(Stable)
public CfnBucket.RedirectRuleProperty.Builder hostName(String hostName)

Sets the value of CfnBucket.RedirectRuleProperty.getHostName()

Parameters:

hostName - The host name to use in the redirect request.

Returns:

this

httpRedirectCode

@Stability(Stable)
public CfnBucket.RedirectRuleProperty.Builder httpRedirectCode(String httpRedirectCode)

Sets the value of CfnBucket.RedirectRuleProperty.getHttpRedirectCode()

Parameters:

httpRedirectCode - The HTTP redirect code to use on the response. Not required if one of the siblings is present.

Returns:

this

protocol

@Stability(Stable)
public CfnBucket.RedirectRuleProperty.Builder protocol(String protocol)

Sets the value of CfnBucket.RedirectRuleProperty.getProtocol()

Parameters:

protocol - Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

Returns:

this

replaceKeyPrefixWith

@Stability(Stable)
public CfnBucket.RedirectRuleProperty.Builder replaceKeyPrefixWith(String replaceKeyPrefixWith)

Sets the value of CfnBucket.RedirectRuleProperty.getReplaceKeyPrefixWith()

Parameters:

replaceKeyPrefixWith - 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 .

Returns:

this

replaceKeyWith

@Stability(Stable)
public CfnBucket.RedirectRuleProperty.Builder replaceKeyWith(String replaceKeyWith)

Sets the value of CfnBucket.RedirectRuleProperty.getReplaceKeyWith()

Parameters:

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 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 .

Returns:

this

build

@Stability(Stable)
public CfnBucket.RedirectRuleProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnBucket.RedirectRuleProperty>

Returns:

a new instance of CfnBucket.RedirectRuleProperty

Throws:

NullPointerException - if any required attribute was not provided