672 lines
38 KiB
C++
672 lines
38 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/kms/KMS_EXPORTS.h>
|
|
#include <aws/kms/KMSRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/kms/model/GrantConstraints.h>
|
|
#include <aws/kms/model/GrantOperation.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace KMS
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_KMS_API CreateGrantRequest : public KMSRequest
|
|
{
|
|
public:
|
|
CreateGrantRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "CreateGrant"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline const Aws::String& GetKeyId() const{ return m_keyId; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The unique identifier for the customer master key (CMK) that the grant
|
|
* applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the
|
|
* CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p>
|
|
* <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline const Aws::String& GetGranteePrincipal() const{ return m_granteePrincipal; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline bool GranteePrincipalHasBeenSet() const { return m_granteePrincipalHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetGranteePrincipal(const Aws::String& value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal = value; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetGranteePrincipal(Aws::String&& value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal = std::move(value); }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetGranteePrincipal(const char* value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal.assign(value); }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithGranteePrincipal(const Aws::String& value) { SetGranteePrincipal(value); return *this;}
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithGranteePrincipal(Aws::String&& value) { SetGranteePrincipal(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The principal that is given permission to perform the operations that the
|
|
* grant permits.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, IAM roles, federated users, and assumed role users.
|
|
* For examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithGranteePrincipal(const char* value) { SetGranteePrincipal(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline const Aws::String& GetRetiringPrincipal() const{ return m_retiringPrincipal; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline bool RetiringPrincipalHasBeenSet() const { return m_retiringPrincipalHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetRetiringPrincipal(const Aws::String& value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal = value; }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetRetiringPrincipal(Aws::String&& value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal = std::move(value); }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline void SetRetiringPrincipal(const char* value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal.assign(value); }
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithRetiringPrincipal(const Aws::String& value) { SetRetiringPrincipal(value); return *this;}
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithRetiringPrincipal(Aws::String&& value) { SetRetiringPrincipal(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The principal that is given permission to retire the grant by using
|
|
* <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
* Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS
|
|
* accounts (root), IAM users, federated users, and assumed role users. For
|
|
* examples of the ARN syntax to use for specifying a principal, see <a
|
|
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
* <i>AWS General Reference</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithRetiringPrincipal(const char* value) { SetRetiringPrincipal(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline const Aws::Vector<GrantOperation>& GetOperations() const{ return m_operations; }
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline bool OperationsHasBeenSet() const { return m_operationsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline void SetOperations(const Aws::Vector<GrantOperation>& value) { m_operationsHasBeenSet = true; m_operations = value; }
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline void SetOperations(Aws::Vector<GrantOperation>&& value) { m_operationsHasBeenSet = true; m_operations = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithOperations(const Aws::Vector<GrantOperation>& value) { SetOperations(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithOperations(Aws::Vector<GrantOperation>&& value) { SetOperations(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline CreateGrantRequest& AddOperations(const GrantOperation& value) { m_operationsHasBeenSet = true; m_operations.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A list of operations that the grant permits.</p>
|
|
*/
|
|
inline CreateGrantRequest& AddOperations(GrantOperation&& value) { m_operationsHasBeenSet = true; m_operations.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline const GrantConstraints& GetConstraints() const{ return m_constraints; }
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline bool ConstraintsHasBeenSet() const { return m_constraintsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline void SetConstraints(const GrantConstraints& value) { m_constraintsHasBeenSet = true; m_constraints = value; }
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline void SetConstraints(GrantConstraints&& value) { m_constraintsHasBeenSet = true; m_constraints = std::move(value); }
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithConstraints(const GrantConstraints& value) { SetConstraints(value); return *this;}
|
|
|
|
/**
|
|
* <p>Allows a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
|
|
* operation</a> only when the encryption context matches or includes the
|
|
* encryption context specified in this structure. For more information about
|
|
* encryption context, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
* Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i>
|
|
* </i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithConstraints(GrantConstraints&& value) { SetConstraints(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetGrantTokens() const{ return m_grantTokens; }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline bool GrantTokensHasBeenSet() const { return m_grantTokensHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline void SetGrantTokens(const Aws::Vector<Aws::String>& value) { m_grantTokensHasBeenSet = true; m_grantTokens = value; }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline void SetGrantTokens(Aws::Vector<Aws::String>&& value) { m_grantTokensHasBeenSet = true; m_grantTokens = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithGrantTokens(const Aws::Vector<Aws::String>& value) { SetGrantTokens(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithGrantTokens(Aws::Vector<Aws::String>&& value) { SetGrantTokens(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& AddGrantTokens(const Aws::String& value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& AddGrantTokens(Aws::String&& value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>A list of grant tokens.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant
|
|
* Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
*/
|
|
inline CreateGrantRequest& AddGrantTokens(const char* value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A friendly name for identifying the grant. Use this value to prevent the
|
|
* unintended creation of duplicate grants when retrying this request.</p> <p>When
|
|
* this value is absent, all <code>CreateGrant</code> requests result in a new
|
|
* grant with a unique <code>GrantId</code> even if all the supplied parameters are
|
|
* identical. This can result in unintended duplicates when you retry the
|
|
* <code>CreateGrant</code> request.</p> <p>When this value is present, you can
|
|
* retry a <code>CreateGrant</code> request with identical parameters; if the grant
|
|
* already exists, the original <code>GrantId</code> is returned without creating a
|
|
* new grant. Note that the returned grant token is unique with every
|
|
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is
|
|
* returned. All grant tokens obtained in this way can be used interchangeably.</p>
|
|
*/
|
|
inline CreateGrantRequest& WithName(const char* value) { SetName(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_keyId;
|
|
bool m_keyIdHasBeenSet;
|
|
|
|
Aws::String m_granteePrincipal;
|
|
bool m_granteePrincipalHasBeenSet;
|
|
|
|
Aws::String m_retiringPrincipal;
|
|
bool m_retiringPrincipalHasBeenSet;
|
|
|
|
Aws::Vector<GrantOperation> m_operations;
|
|
bool m_operationsHasBeenSet;
|
|
|
|
GrantConstraints m_constraints;
|
|
bool m_constraintsHasBeenSet;
|
|
|
|
Aws::Vector<Aws::String> m_grantTokens;
|
|
bool m_grantTokensHasBeenSet;
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace KMS
|
|
} // namespace Aws
|