Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Types.Condition

Description

Synopsis

Documentation

data Condition Source #

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: newCondition smart constructor.

Constructors

Condition'

Fields

keyPrefixEquals :: Maybe Text
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.
httpErrorCodeReturnedEquals :: Maybe Text
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.

Instances

Instances details

Eq Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods (==) :: Condition -> Condition -> Bool # (/=) :: Condition -> Condition -> Bool #
Read Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods readsPrec :: Int -> ReadS Condition # readList :: ReadS [Condition] # readPrec :: ReadPrec Condition # readListPrec :: ReadPrec [Condition] #
Show Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods showsPrec :: Int -> Condition -> ShowS # show :: Condition -> String # showList :: [Condition] -> ShowS #
Generic Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Associated Types type Rep Condition :: Type -> Type # Methods from :: Condition -> Rep Condition x # to :: Rep Condition x -> Condition #
NFData Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods rnf :: Condition -> () #
Hashable Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods hashWithSalt :: Int -> Condition -> Int # hash :: Condition -> Int #
FromXML Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods parseXML :: [Node] -> Either String Condition #
ToXML Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition Methods toXML :: Condition -> XML #
type Rep Condition Source #
Instance details Defined in Amazonka.S3.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.S3.Types.Condition" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPrefixEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpErrorCodeReturnedEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCondition :: Condition Source #

Create a value of Condition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPrefixEquals:Condition', condition_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.

$sel:httpErrorCodeReturnedEquals:Condition', condition_httpErrorCodeReturnedEquals - 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.

condition_keyPrefixEquals :: Lens' Condition (Maybe Text) Source #

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.

condition_httpErrorCodeReturnedEquals :: Lens' Condition (Maybe Text) Source #

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.