242 lines
13 KiB
C
242 lines
13 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 <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace KMS
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
*/
|
|||
|
|
class AWS_KMS_API GetPublicKeyRequest : public KMSRequest
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
GetPublicKeyRequest();
|
|||
|
|
|
|||
|
|
// 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 "GetPublicKey"; }
|
|||
|
|
|
|||
|
|
Aws::String SerializePayload() const override;
|
|||
|
|
|
|||
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetKeyId() const{ return m_keyId; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline GetPublicKeyRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline GetPublicKeyRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify
|
|||
|
|
* a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|||
|
|
* When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK
|
|||
|
|
* in a different AWS account, you must use the key ARN or alias 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> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li>
|
|||
|
|
* <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>
|
|||
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|||
|
|
* or <a>DescribeKey</a>. To get the alias name and alias ARN, use
|
|||
|
|
* <a>ListAliases</a>.</p>
|
|||
|
|
*/
|
|||
|
|
inline GetPublicKeyRequest& WithKeyId(const char* value) { SetKeyId(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 GetPublicKeyRequest& 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 GetPublicKeyRequest& 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 GetPublicKeyRequest& 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 GetPublicKeyRequest& 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 GetPublicKeyRequest& AddGrantTokens(const char* value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(value); return *this; }
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::String m_keyId;
|
|||
|
|
bool m_keyIdHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::Vector<Aws::String> m_grantTokens;
|
|||
|
|
bool m_grantTokensHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace KMS
|
|||
|
|
} // namespace Aws
|