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-kms/include/aws/kms/model/CreateAliasRequest.h

194 lines
8.7 KiB
C
Raw Normal View History

/**
* 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 <utility>
namespace Aws
{
namespace KMS
{
namespace Model
{
/**
*/
class AWS_KMS_API CreateAliasRequest : public KMSRequest
{
public:
CreateAliasRequest();
// 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 "CreateAlias"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline const Aws::String& GetAliasName() const{ return m_aliasName; }
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline bool AliasNameHasBeenSet() const { return m_aliasNameHasBeenSet; }
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline void SetAliasName(const Aws::String& value) { m_aliasNameHasBeenSet = true; m_aliasName = value; }
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline void SetAliasName(Aws::String&& value) { m_aliasNameHasBeenSet = true; m_aliasName = std::move(value); }
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline void SetAliasName(const char* value) { m_aliasNameHasBeenSet = true; m_aliasName.assign(value); }
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline CreateAliasRequest& WithAliasName(const Aws::String& value) { SetAliasName(value); return *this;}
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline CreateAliasRequest& WithAliasName(Aws::String&& value) { SetAliasName(std::move(value)); return *this;}
/**
* <p>Specifies the alias name. This value must begin with <code>alias/</code>
* followed by a name, such as <code>alias/ExampleAlias</code>. The alias name
* cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is
* reserved for AWS managed CMKs.</p>
*/
inline CreateAliasRequest& WithAliasName(const char* value) { SetAliasName(value); return *this;}
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline const Aws::String& GetTargetKeyId() const{ return m_targetKeyId; }
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline bool TargetKeyIdHasBeenSet() const { return m_targetKeyIdHasBeenSet; }
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline void SetTargetKeyId(const Aws::String& value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId = value; }
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline void SetTargetKeyId(Aws::String&& value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId = std::move(value); }
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline void SetTargetKeyId(const char* value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId.assign(value); }
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline CreateAliasRequest& WithTargetKeyId(const Aws::String& value) { SetTargetKeyId(value); return *this;}
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline CreateAliasRequest& WithTargetKeyId(Aws::String&& value) { SetTargetKeyId(std::move(value)); return *this;}
/**
* <p>Identifies the CMK to which the alias refers. Specify the key ID or the
* Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For
* help finding the key ID and ARN, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding
* the Key ID and ARN</a> in the <i>AWS Key Management Service Developer
* Guide</i>.</p>
*/
inline CreateAliasRequest& WithTargetKeyId(const char* value) { SetTargetKeyId(value); return *this;}
private:
Aws::String m_aliasName;
bool m_aliasNameHasBeenSet;
Aws::String m_targetKeyId;
bool m_targetKeyIdHasBeenSet;
};
} // namespace Model
} // namespace KMS
} // namespace Aws