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-athena/include/aws/athena/model/EncryptionConfiguration.h

170 lines
6.9 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/athena/Athena_EXPORTS.h>
#include <aws/athena/model/EncryptionOption.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Athena
{
namespace Model
{
/**
* <p>If query results are encrypted in Amazon S3, indicates the encryption option
* used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key
* information.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/EncryptionConfiguration">AWS
* API Reference</a></p>
*/
class AWS_ATHENA_API EncryptionConfiguration
{
public:
EncryptionConfiguration();
EncryptionConfiguration(Aws::Utils::Json::JsonView jsonValue);
EncryptionConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline const EncryptionOption& GetEncryptionOption() const{ return m_encryptionOption; }
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline bool EncryptionOptionHasBeenSet() const { return m_encryptionOptionHasBeenSet; }
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline void SetEncryptionOption(const EncryptionOption& value) { m_encryptionOptionHasBeenSet = true; m_encryptionOption = value; }
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline void SetEncryptionOption(EncryptionOption&& value) { m_encryptionOptionHasBeenSet = true; m_encryptionOption = std::move(value); }
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline EncryptionConfiguration& WithEncryptionOption(const EncryptionOption& value) { SetEncryptionOption(value); return *this;}
/**
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
* keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys
* (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys
* (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup
* overrides client-side settings, then the workgroup's setting for encryption is
* used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup. </p>
*/
inline EncryptionConfiguration& WithEncryptionOption(EncryptionOption&& value) { SetEncryptionOption(std::move(value)); return *this;}
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline const Aws::String& GetKmsKey() const{ return m_kmsKey; }
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline bool KmsKeyHasBeenSet() const { return m_kmsKeyHasBeenSet; }
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline void SetKmsKey(const Aws::String& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = value; }
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline void SetKmsKey(Aws::String&& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = std::move(value); }
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline void SetKmsKey(const char* value) { m_kmsKeyHasBeenSet = true; m_kmsKey.assign(value); }
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline EncryptionConfiguration& WithKmsKey(const Aws::String& value) { SetKmsKey(value); return *this;}
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline EncryptionConfiguration& WithKmsKey(Aws::String&& value) { SetKmsKey(std::move(value)); return *this;}
/**
* <p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or
* ID.</p>
*/
inline EncryptionConfiguration& WithKmsKey(const char* value) { SetKmsKey(value); return *this;}
private:
EncryptionOption m_encryptionOption;
bool m_encryptionOptionHasBeenSet;
Aws::String m_kmsKey;
bool m_kmsKeyHasBeenSet;
};
} // namespace Model
} // namespace Athena
} // namespace Aws