Skip to content

Commit

Permalink
Documentation improvements for create, describe, and modify DB cluste…
Browse files Browse the repository at this point in the history
…rs and DB instances.

Update to Amazon FSx documentation.
Added improved descriptions and new code samples to SDK documentation.
This release adds support for encryption via customer managed keys.
  • Loading branch information
aws-sdk-cpp-automation committed Jun 23, 2023
1 parent b926af3 commit fa0b625
Show file tree
Hide file tree
Showing 46 changed files with 9,368 additions and 8,133 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.11.106
1.11.107
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,14 @@ namespace DevOpsGuru
* <p> Adds a notification channel to DevOps Guru. A notification channel is used
* to notify you about important DevOps Guru events, such as when an insight is
* generated. </p> <p>If you use an Amazon SNS topic in another account, you must
* attach a policy to it that grants DevOps Guru permission to it notifications.
* DevOps Guru adds the required policy on your behalf to send notifications using
* Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For
* more information, see <a
* attach a policy to it that grants DevOps Guru permission to send it
* notifications. DevOps Guru adds the required policy on your behalf to send
* notifications using Amazon SNS in your account. DevOps Guru only supports
* standard SNS topics. For more information, see <a
* href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
* for cross account Amazon SNS topics</a>.</p> <p>If you use an Amazon SNS topic
* in another account, you must attach a policy to it that grants DevOps Guru
* permission to it notifications. DevOps Guru adds the required policy on your
* behalf to send notifications using Amazon SNS in your account. For more
* information, see Permissions for cross account Amazon SNS topics.</p> <p>If you
* use an Amazon SNS topic that is encrypted by an Amazon Web Services Key
* Management Service customer-managed key (CMK), then you must add permissions to
* the CMK. For more information, see <a
* for Amazon SNS topics</a>.</p> <p>If you use an Amazon SNS topic that is
* encrypted by an Amazon Web Services Key Management Service customer-managed key
* (CMK), then you must add permissions to the CMK. For more information, see <a
* href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions
* for Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p><p><h3>See
* Also:</h3> <a
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/

#pragma once
#include <aws/devops-guru/DevOpsGuru_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/devops-guru/model/OptInStatus.h>
#include <aws/devops-guru/model/ServerSideEncryptionType.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace DevOpsGuru
{
namespace Model
{

/**
* <p> Information about the KMS encryption used with DevOps Guru. </p><p><h3>See
* Also:</h3> <a
* href="https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/KMSServerSideEncryptionIntegration">AWS
* API Reference</a></p>
*/
class KMSServerSideEncryptionIntegration
{
public:
AWS_DEVOPSGURU_API KMSServerSideEncryptionIntegration();
AWS_DEVOPSGURU_API KMSServerSideEncryptionIntegration(Aws::Utils::Json::JsonView jsonValue);
AWS_DEVOPSGURU_API KMSServerSideEncryptionIntegration& operator=(Aws::Utils::Json::JsonView jsonValue);
AWS_DEVOPSGURU_API Aws::Utils::Json::JsonValue Jsonize() const;


/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline const Aws::String& GetKMSKeyId() const{ return m_kMSKeyId; }

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline bool KMSKeyIdHasBeenSet() const { return m_kMSKeyIdHasBeenSet; }

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline void SetKMSKeyId(const Aws::String& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = value; }

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline void SetKMSKeyId(Aws::String&& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = std::move(value); }

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline void SetKMSKeyId(const char* value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId.assign(value); }

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline KMSServerSideEncryptionIntegration& WithKMSKeyId(const Aws::String& value) { SetKMSKeyId(value); return *this;}

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline KMSServerSideEncryptionIntegration& WithKMSKeyId(Aws::String&& value) { SetKMSKeyId(std::move(value)); return *this;}

/**
* <p> Describes the specified KMS key. </p> <p>To specify a KMS key, use its key
* ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web
* Services alias with no key ID), Amazon Web Services KMS associates the alias
* with an Amazon Web Services managed key and returns its KeyId and Arn in the
* response. To specify a KMS key in a different Amazon Web Services account, you
* must use the key ARN or alias ARN.</p> <p>For example: </p> <p>Key ID:
* 1234abcd-12ab-34cd-56ef-1234567890ab</p> <p>Key ARN:
* arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</p>
* <p>Alias name: alias/ExampleAlias</p> <p>Alias ARN:
* arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</p>
*/
inline KMSServerSideEncryptionIntegration& WithKMSKeyId(const char* value) { SetKMSKeyId(value); return *this;}


/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline const OptInStatus& GetOptInStatus() const{ return m_optInStatus; }

/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline bool OptInStatusHasBeenSet() const { return m_optInStatusHasBeenSet; }

/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline void SetOptInStatus(const OptInStatus& value) { m_optInStatusHasBeenSet = true; m_optInStatus = value; }

/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline void SetOptInStatus(OptInStatus&& value) { m_optInStatusHasBeenSet = true; m_optInStatus = std::move(value); }

/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline KMSServerSideEncryptionIntegration& WithOptInStatus(const OptInStatus& value) { SetOptInStatus(value); return *this;}

/**
* <p> Specifies if DevOps Guru is enabled for customer managed keys. </p>
*/
inline KMSServerSideEncryptionIntegration& WithOptInStatus(OptInStatus&& value) { SetOptInStatus(std::move(value)); return *this;}


/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline const ServerSideEncryptionType& GetType() const{ return m_type; }

/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }

/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline void SetType(const ServerSideEncryptionType& value) { m_typeHasBeenSet = true; m_type = value; }

/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline void SetType(ServerSideEncryptionType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }

/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline KMSServerSideEncryptionIntegration& WithType(const ServerSideEncryptionType& value) { SetType(value); return *this;}

/**
* <p> The type of KMS key used. Customer managed keys are the KMS keys that you
* create. Amazon Web Services owned keys are keys that are owned and managed by
* DevOps Guru. </p>
*/
inline KMSServerSideEncryptionIntegration& WithType(ServerSideEncryptionType&& value) { SetType(std::move(value)); return *this;}

private:

Aws::String m_kMSKeyId;
bool m_kMSKeyIdHasBeenSet = false;

OptInStatus m_optInStatus;
bool m_optInStatusHasBeenSet = false;

ServerSideEncryptionType m_type;
bool m_typeHasBeenSet = false;
};

} // namespace Model
} // namespace DevOpsGuru
} // namespace Aws
Loading

0 comments on commit fa0b625

Please sign in to comment.