276 lines
14 KiB
C++
276 lines
14 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/waf/WAF_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/waf/model/ByteMatchTuple.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace WAF
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>This is <b>AWS WAF Classic</b> documentation. For more information,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
|
|
* WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS
|
|
* WAF</b>, use the AWS WAFV2 API and see the <a
|
|
* href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS
|
|
* WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of
|
|
* endpoints for regional and global use. </p> <p>In a
|
|
* <a>GetByteMatchSet</a> request, <code>ByteMatchSet</code> is a complex type that
|
|
* contains the <code>ByteMatchSetId</code> and <code>Name</code> of a
|
|
* <code>ByteMatchSet</code>, and the values that you specified when you updated
|
|
* the <code>ByteMatchSet</code>. </p> <p>A complex type that contains
|
|
* <code>ByteMatchTuple</code> objects, which specify the parts of web requests
|
|
* that you want AWS WAF to inspect and the values that you want AWS WAF to search
|
|
* for. If a <code>ByteMatchSet</code> contains more than one
|
|
* <code>ByteMatchTuple</code> object, a request needs to match the settings in
|
|
* only one <code>ByteMatchTuple</code> to be considered a match.</p><p><h3>See
|
|
* Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/ByteMatchSet">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_WAF_API ByteMatchSet
|
|
{
|
|
public:
|
|
ByteMatchSet();
|
|
ByteMatchSet(Aws::Utils::Json::JsonView jsonValue);
|
|
ByteMatchSet& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline const Aws::String& GetByteMatchSetId() const{ return m_byteMatchSetId; }
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline bool ByteMatchSetIdHasBeenSet() const { return m_byteMatchSetIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline void SetByteMatchSetId(const Aws::String& value) { m_byteMatchSetIdHasBeenSet = true; m_byteMatchSetId = value; }
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline void SetByteMatchSetId(Aws::String&& value) { m_byteMatchSetIdHasBeenSet = true; m_byteMatchSetId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline void SetByteMatchSetId(const char* value) { m_byteMatchSetIdHasBeenSet = true; m_byteMatchSetId.assign(value); }
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithByteMatchSetId(const Aws::String& value) { SetByteMatchSetId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithByteMatchSetId(Aws::String&& value) { SetByteMatchSetId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use
|
|
* <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>
|
|
* (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see
|
|
* <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a
|
|
* <code>Rule</code> or delete one from a <code>Rule</code> (see
|
|
* <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see
|
|
* <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by
|
|
* <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithByteMatchSetId(const char* value) { SetByteMatchSetId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change
|
|
* <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>
|
|
*/
|
|
inline ByteMatchSet& WithName(const char* value) { SetName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline const Aws::Vector<ByteMatchTuple>& GetByteMatchTuples() const{ return m_byteMatchTuples; }
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline bool ByteMatchTuplesHasBeenSet() const { return m_byteMatchTuplesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline void SetByteMatchTuples(const Aws::Vector<ByteMatchTuple>& value) { m_byteMatchTuplesHasBeenSet = true; m_byteMatchTuples = value; }
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline void SetByteMatchTuples(Aws::Vector<ByteMatchTuple>&& value) { m_byteMatchTuplesHasBeenSet = true; m_byteMatchTuples = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline ByteMatchSet& WithByteMatchTuples(const Aws::Vector<ByteMatchTuple>& value) { SetByteMatchTuples(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline ByteMatchSet& WithByteMatchTuples(Aws::Vector<ByteMatchTuple>&& value) { SetByteMatchTuples(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline ByteMatchSet& AddByteMatchTuples(const ByteMatchTuple& value) { m_byteMatchTuplesHasBeenSet = true; m_byteMatchTuples.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>Specifies the bytes (typically a string that corresponds with ASCII
|
|
* characters) that you want AWS WAF to search for in web requests, the location in
|
|
* requests that you want AWS WAF to search, and other settings.</p>
|
|
*/
|
|
inline ByteMatchSet& AddByteMatchTuples(ByteMatchTuple&& value) { m_byteMatchTuplesHasBeenSet = true; m_byteMatchTuples.push_back(std::move(value)); return *this; }
|
|
|
|
private:
|
|
|
|
Aws::String m_byteMatchSetId;
|
|
bool m_byteMatchSetIdHasBeenSet;
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet;
|
|
|
|
Aws::Vector<ByteMatchTuple> m_byteMatchTuples;
|
|
bool m_byteMatchTuplesHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace WAF
|
|
} // namespace Aws
|