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-codeartifact/include/aws/codeartifact/model/CreateDomainRequest.h

262 lines
15 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/codeartifact/CodeArtifact_EXPORTS.h>
#include <aws/codeartifact/CodeArtifactRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Http
{
class URI;
} //namespace Http
namespace CodeArtifact
{
namespace Model
{
/**
*/
class AWS_CODEARTIFACT_API CreateDomainRequest : public CodeArtifactRequest
{
public:
CreateDomainRequest();
// 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 "CreateDomain"; }
Aws::String SerializePayload() const override;
void AddQueryStringParameters(Aws::Http::URI& uri) const override;
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline const Aws::String& GetDomain() const{ return m_domain; }
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; }
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline void SetDomain(const Aws::String& value) { m_domainHasBeenSet = true; m_domain = value; }
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline void SetDomain(Aws::String&& value) { m_domainHasBeenSet = true; m_domain = std::move(value); }
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline void SetDomain(const char* value) { m_domainHasBeenSet = true; m_domain.assign(value); }
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline CreateDomainRequest& WithDomain(const Aws::String& value) { SetDomain(value); return *this;}
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline CreateDomainRequest& WithDomain(Aws::String&& value) { SetDomain(std::move(value)); return *this;}
/**
* <p> The name of the domain to create. All domain names in an AWS Region that are
* in the same AWS account must be unique. The domain name is used as the prefix in
* DNS hostnames. Do not use sensitive information in a domain name because it is
* publicly discoverable. </p>
*/
inline CreateDomainRequest& WithDomain(const char* value) { SetDomain(value); return *this;}
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline const Aws::String& GetEncryptionKey() const{ return m_encryptionKey; }
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline bool EncryptionKeyHasBeenSet() const { return m_encryptionKeyHasBeenSet; }
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline void SetEncryptionKey(const Aws::String& value) { m_encryptionKeyHasBeenSet = true; m_encryptionKey = value; }
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline void SetEncryptionKey(Aws::String&& value) { m_encryptionKeyHasBeenSet = true; m_encryptionKey = std::move(value); }
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline void SetEncryptionKey(const char* value) { m_encryptionKeyHasBeenSet = true; m_encryptionKey.assign(value); }
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline CreateDomainRequest& WithEncryptionKey(const Aws::String& value) { SetEncryptionKey(value); return *this;}
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline CreateDomainRequest& WithEncryptionKey(Aws::String&& value) { SetEncryptionKey(std::move(value)); return *this;}
/**
* <p> The encryption key for the domain. This is used to encrypt content stored in
* a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a
* key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your
* IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code>
* permissions on the encryption key that is used. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax">DescribeKey</a>
* in the <i>AWS Key Management Service API Reference</i> and <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">AWS
* KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p> <p> CodeArtifact supports only symmetric CMKs. Do
* not associate an asymmetric CMK with your domain. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer
* Guide</i>. </p>
*/
inline CreateDomainRequest& WithEncryptionKey(const char* value) { SetEncryptionKey(value); return *this;}
private:
Aws::String m_domain;
bool m_domainHasBeenSet;
Aws::String m_encryptionKey;
bool m_encryptionKeyHasBeenSet;
};
} // namespace Model
} // namespace CodeArtifact
} // namespace Aws