This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-appsync/include/aws/appsync/model/ApiCache.h

359 lines
17 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/appsync/AppSync_EXPORTS.h>
#include <aws/appsync/model/ApiCachingBehavior.h>
#include <aws/appsync/model/ApiCacheType.h>
#include <aws/appsync/model/ApiCacheStatus.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace AppSync
{
namespace Model
{
/**
* <p>The <code>ApiCache</code> object.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ApiCache">AWS
* API Reference</a></p>
*/
class AWS_APPSYNC_API ApiCache
{
public:
ApiCache();
ApiCache(Aws::Utils::Json::JsonView jsonValue);
ApiCache& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600
* seconds.</p>
*/
inline long long GetTtl() const{ return m_ttl; }
/**
* <p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600
* seconds.</p>
*/
inline bool TtlHasBeenSet() const { return m_ttlHasBeenSet; }
/**
* <p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600
* seconds.</p>
*/
inline void SetTtl(long long value) { m_ttlHasBeenSet = true; m_ttl = value; }
/**
* <p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600
* seconds.</p>
*/
inline ApiCache& WithTtl(long long value) { SetTtl(value); return *this;}
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline const ApiCachingBehavior& GetApiCachingBehavior() const{ return m_apiCachingBehavior; }
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline bool ApiCachingBehaviorHasBeenSet() const { return m_apiCachingBehaviorHasBeenSet; }
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline void SetApiCachingBehavior(const ApiCachingBehavior& value) { m_apiCachingBehaviorHasBeenSet = true; m_apiCachingBehavior = value; }
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline void SetApiCachingBehavior(ApiCachingBehavior&& value) { m_apiCachingBehaviorHasBeenSet = true; m_apiCachingBehavior = std::move(value); }
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline ApiCache& WithApiCachingBehavior(const ApiCachingBehavior& value) { SetApiCachingBehavior(value); return *this;}
/**
* <p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests
* are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual
* resovlers that you specify are cached.</p> </li> </ul>
*/
inline ApiCache& WithApiCachingBehavior(ApiCachingBehavior&& value) { SetApiCachingBehavior(std::move(value)); return *this;}
/**
* <p>Transit encryption flag when connecting to cache. This setting cannot be
* updated after creation.</p>
*/
inline bool GetTransitEncryptionEnabled() const{ return m_transitEncryptionEnabled; }
/**
* <p>Transit encryption flag when connecting to cache. This setting cannot be
* updated after creation.</p>
*/
inline bool TransitEncryptionEnabledHasBeenSet() const { return m_transitEncryptionEnabledHasBeenSet; }
/**
* <p>Transit encryption flag when connecting to cache. This setting cannot be
* updated after creation.</p>
*/
inline void SetTransitEncryptionEnabled(bool value) { m_transitEncryptionEnabledHasBeenSet = true; m_transitEncryptionEnabled = value; }
/**
* <p>Transit encryption flag when connecting to cache. This setting cannot be
* updated after creation.</p>
*/
inline ApiCache& WithTransitEncryptionEnabled(bool value) { SetTransitEncryptionEnabled(value); return *this;}
/**
* <p>At rest encryption flag for cache. This setting cannot be updated after
* creation.</p>
*/
inline bool GetAtRestEncryptionEnabled() const{ return m_atRestEncryptionEnabled; }
/**
* <p>At rest encryption flag for cache. This setting cannot be updated after
* creation.</p>
*/
inline bool AtRestEncryptionEnabledHasBeenSet() const { return m_atRestEncryptionEnabledHasBeenSet; }
/**
* <p>At rest encryption flag for cache. This setting cannot be updated after
* creation.</p>
*/
inline void SetAtRestEncryptionEnabled(bool value) { m_atRestEncryptionEnabledHasBeenSet = true; m_atRestEncryptionEnabled = value; }
/**
* <p>At rest encryption flag for cache. This setting cannot be updated after
* creation.</p>
*/
inline ApiCache& WithAtRestEncryptionEnabled(bool value) { SetAtRestEncryptionEnabled(value); return *this;}
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline const ApiCacheType& GetType() const{ return m_type; }
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline void SetType(const ApiCacheType& value) { m_typeHasBeenSet = true; m_type = value; }
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline void SetType(ApiCacheType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline ApiCache& WithType(const ApiCacheType& value) { SetType(value); return *this;}
/**
* <p>The cache instance type. Valid values are </p> <ul> <li> <p>
* <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p>
* <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p>
* <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li>
* <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p>
* <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were
* identified by an EC2-style value. As of July 2020, this is deprecated, and the
* generic identifiers above should be used.</p> <p>The following legacy instance
* types are avaible, but their use is discouraged:</p> <ul> <li> <p>
* <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>:
* A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large
* instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance
* type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p>
* </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p>
* <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>
*/
inline ApiCache& WithType(ApiCacheType&& value) { SetType(std::move(value)); return *this;}
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline const ApiCacheStatus& GetStatus() const{ return m_status; }
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline void SetStatus(const ApiCacheStatus& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline void SetStatus(ApiCacheStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline ApiCache& WithStatus(const ApiCacheStatus& value) { SetStatus(value); return *this;}
/**
* <p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance
* is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is
* currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is
* currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is
* currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed
* creation.</p> </li> </ul>
*/
inline ApiCache& WithStatus(ApiCacheStatus&& value) { SetStatus(std::move(value)); return *this;}
private:
long long m_ttl;
bool m_ttlHasBeenSet;
ApiCachingBehavior m_apiCachingBehavior;
bool m_apiCachingBehaviorHasBeenSet;
bool m_transitEncryptionEnabled;
bool m_transitEncryptionEnabledHasBeenSet;
bool m_atRestEncryptionEnabled;
bool m_atRestEncryptionEnabledHasBeenSet;
ApiCacheType m_type;
bool m_typeHasBeenSet;
ApiCacheStatus m_status;
bool m_statusHasBeenSet;
};
} // namespace Model
} // namespace AppSync
} // namespace Aws