257 lines
10 KiB
C++
257 lines
10 KiB
C++
/**
|
||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||
* SPDX-License-Identifier: Apache-2.0.
|
||
*/
|
||
|
||
#pragma once
|
||
#include <aws/cloudfront/CloudFront_EXPORTS.h>
|
||
#include <aws/core/utils/memory/stl/AWSString.h>
|
||
#include <aws/cloudfront/model/OriginRequestPolicyHeadersConfig.h>
|
||
#include <aws/cloudfront/model/OriginRequestPolicyCookiesConfig.h>
|
||
#include <aws/cloudfront/model/OriginRequestPolicyQueryStringsConfig.h>
|
||
#include <utility>
|
||
|
||
namespace Aws
|
||
{
|
||
namespace Utils
|
||
{
|
||
namespace Xml
|
||
{
|
||
class XmlNode;
|
||
} // namespace Xml
|
||
} // namespace Utils
|
||
namespace CloudFront
|
||
{
|
||
namespace Model
|
||
{
|
||
|
||
/**
|
||
* <p>An origin request policy configuration.</p> <p>This configuration determines
|
||
* the values that CloudFront includes in requests that it sends to the origin.
|
||
* Each request that CloudFront sends to the origin includes the following:</p>
|
||
* <ul> <li> <p>The request body and the URL path (without the domain name) from
|
||
* the viewer request.</p> </li> <li> <p>The headers that CloudFront automatically
|
||
* includes in every origin request, including <code>Host</code>,
|
||
* <code>User-Agent</code>, and <code>X-Amz-Cf-Id</code>.</p> </li> <li> <p>All
|
||
* HTTP headers, cookies, and URL query strings that are specified in the cache
|
||
* policy or the origin request policy. These can include items from the viewer
|
||
* request and, in the case of headers, additional ones that are added by
|
||
* CloudFront.</p> </li> </ul> <p>CloudFront sends a request when it can’t find an
|
||
* object in its cache that matches the request. If you want to send values to the
|
||
* origin and also include them in the cache key, use
|
||
* <code>CreateCachePolicy</code>.</p><p><h3>See Also:</h3> <a
|
||
* href="http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/OriginRequestPolicyConfig">AWS
|
||
* API Reference</a></p>
|
||
*/
|
||
class AWS_CLOUDFRONT_API OriginRequestPolicyConfig
|
||
{
|
||
public:
|
||
OriginRequestPolicyConfig();
|
||
OriginRequestPolicyConfig(const Aws::Utils::Xml::XmlNode& xmlNode);
|
||
OriginRequestPolicyConfig& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
|
||
|
||
void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
|
||
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline const Aws::String& GetComment() const{ return m_comment; }
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline bool CommentHasBeenSet() const { return m_commentHasBeenSet; }
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline void SetComment(const Aws::String& value) { m_commentHasBeenSet = true; m_comment = value; }
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline void SetComment(Aws::String&& value) { m_commentHasBeenSet = true; m_comment = std::move(value); }
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline void SetComment(const char* value) { m_commentHasBeenSet = true; m_comment.assign(value); }
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithComment(const Aws::String& value) { SetComment(value); return *this;}
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithComment(Aws::String&& value) { SetComment(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>A comment to describe the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithComment(const char* value) { SetComment(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline const Aws::String& GetName() const{ return m_name; }
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithName(const Aws::String& value) { SetName(value); return *this;}
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>A unique name to identify the origin request policy.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithName(const char* value) { SetName(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline const OriginRequestPolicyHeadersConfig& GetHeadersConfig() const{ return m_headersConfig; }
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline bool HeadersConfigHasBeenSet() const { return m_headersConfigHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline void SetHeadersConfig(const OriginRequestPolicyHeadersConfig& value) { m_headersConfigHasBeenSet = true; m_headersConfig = value; }
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline void SetHeadersConfig(OriginRequestPolicyHeadersConfig&& value) { m_headersConfigHasBeenSet = true; m_headersConfig = std::move(value); }
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithHeadersConfig(const OriginRequestPolicyHeadersConfig& value) { SetHeadersConfig(value); return *this;}
|
||
|
||
/**
|
||
* <p>The HTTP headers to include in origin requests. These can include headers
|
||
* from viewer requests and additional headers added by CloudFront.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithHeadersConfig(OriginRequestPolicyHeadersConfig&& value) { SetHeadersConfig(std::move(value)); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline const OriginRequestPolicyCookiesConfig& GetCookiesConfig() const{ return m_cookiesConfig; }
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline bool CookiesConfigHasBeenSet() const { return m_cookiesConfigHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline void SetCookiesConfig(const OriginRequestPolicyCookiesConfig& value) { m_cookiesConfigHasBeenSet = true; m_cookiesConfig = value; }
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline void SetCookiesConfig(OriginRequestPolicyCookiesConfig&& value) { m_cookiesConfigHasBeenSet = true; m_cookiesConfig = std::move(value); }
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithCookiesConfig(const OriginRequestPolicyCookiesConfig& value) { SetCookiesConfig(value); return *this;}
|
||
|
||
/**
|
||
* <p>The cookies from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithCookiesConfig(OriginRequestPolicyCookiesConfig&& value) { SetCookiesConfig(std::move(value)); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline const OriginRequestPolicyQueryStringsConfig& GetQueryStringsConfig() const{ return m_queryStringsConfig; }
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline bool QueryStringsConfigHasBeenSet() const { return m_queryStringsConfigHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline void SetQueryStringsConfig(const OriginRequestPolicyQueryStringsConfig& value) { m_queryStringsConfigHasBeenSet = true; m_queryStringsConfig = value; }
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline void SetQueryStringsConfig(OriginRequestPolicyQueryStringsConfig&& value) { m_queryStringsConfigHasBeenSet = true; m_queryStringsConfig = std::move(value); }
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithQueryStringsConfig(const OriginRequestPolicyQueryStringsConfig& value) { SetQueryStringsConfig(value); return *this;}
|
||
|
||
/**
|
||
* <p>The URL query strings from viewer requests to include in origin requests.</p>
|
||
*/
|
||
inline OriginRequestPolicyConfig& WithQueryStringsConfig(OriginRequestPolicyQueryStringsConfig&& value) { SetQueryStringsConfig(std::move(value)); return *this;}
|
||
|
||
private:
|
||
|
||
Aws::String m_comment;
|
||
bool m_commentHasBeenSet;
|
||
|
||
Aws::String m_name;
|
||
bool m_nameHasBeenSet;
|
||
|
||
OriginRequestPolicyHeadersConfig m_headersConfig;
|
||
bool m_headersConfigHasBeenSet;
|
||
|
||
OriginRequestPolicyCookiesConfig m_cookiesConfig;
|
||
bool m_cookiesConfigHasBeenSet;
|
||
|
||
OriginRequestPolicyQueryStringsConfig m_queryStringsConfig;
|
||
bool m_queryStringsConfigHasBeenSet;
|
||
};
|
||
|
||
} // namespace Model
|
||
} // namespace CloudFront
|
||
} // namespace Aws
|