/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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.See Also:
AWS API
* Reference
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline const Aws::String& GetKeyPrefixEquals() const{ return m_keyPrefixEquals; } /** *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.
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.
*/ inline bool KeyPrefixEqualsHasBeenSet() const { return m_keyPrefixEqualsHasBeenSet; } /** *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.
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.
*/ inline void SetKeyPrefixEquals(const Aws::String& value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals = value; } /** *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.
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.
*/ inline void SetKeyPrefixEquals(Aws::String&& value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals = std::move(value); } /** *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.
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.
*/ inline void SetKeyPrefixEquals(const char* value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals.assign(value); } /** *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.
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.
*/ inline Condition& WithKeyPrefixEquals(const Aws::String& value) { SetKeyPrefixEquals(value); return *this;} /** *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.
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.
*/ inline Condition& WithKeyPrefixEquals(Aws::String&& value) { SetKeyPrefixEquals(std::move(value)); return *this;} /** *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.
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.
*/ inline Condition& WithKeyPrefixEquals(const char* value) { SetKeyPrefixEquals(value); return *this;} private: Aws::String m_httpErrorCodeReturnedEquals; bool m_httpErrorCodeReturnedEqualsHasBeenSet; Aws::String m_keyPrefixEquals; bool m_keyPrefixEqualsHasBeenSet; }; } // namespace Model } // namespace S3 } // namespace Aws