/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace SecretsManager { namespace Model { /** */ class CreateSecretRequest : public SecretsManagerRequest { public: AWS_SECRETSMANAGER_API CreateSecretRequest(); // 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 "CreateSecret"; } AWS_SECRETSMANAGER_API Aws::String SerializePayload() const override; AWS_SECRETSMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

Do not end your secret * name with a hyphen followed by six characters. If you do so, you risk confusion * and unexpected results when searching for a secret by partial ARN. Secrets * Manager automatically adds a hyphen and six random characters after the secret * name at the end of the ARN.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline CreateSecretRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline CreateSecretRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the new secret.

The secret name can contain ASCII letters, * numbers, and the following characters: /_+=.@-

*/ inline CreateSecretRequest& WithName(const char* value) { SetName(value); return *this;} /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If you use * the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this * operation, then you can leave this parameter empty. The CLI or SDK generates a * random UUID for you and includes it as the value for this parameter in the * request. If you don't use the SDK and instead generate a raw HTTP request to the * Secrets Manager service endpoint, then you must generate a * ClientRequestToken yourself for the new version and include the * value in the request.

This value helps ensure idempotency. * Secrets Manager uses this value to prevent the accidental creation of duplicate * versions if there are failures and retries during a rotation. We recommend that * you generate a UUID-type * value to ensure uniqueness of your versions within the specified secret.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline CreateSecretRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline CreateSecretRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

If you include SecretString or SecretBinary, then * Secrets Manager creates an initial version for the secret, and this parameter * specifies the unique identifier for the new version.

If the ClientRequestToken value isn't already * associated with a version of the secret then a new version of the secret is * created.
If a version with this value already exists and the * version SecretString and SecretBinary values are the * same as those in the request, then the request is ignored.
If * a version with this value already exists and that version's * SecretString and SecretBinary values are different * from those in the request, then the request fails because you cannot modify an * existing version. Instead, use PutSecretValue to create a new * version.

This value becomes the VersionId of the * new version.

*/ inline CreateSecretRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

The description of the secret.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the secret.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description of the secret.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description of the secret.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description of the secret.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description of the secret.

*/ inline CreateSecretRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the secret.

*/ inline CreateSecretRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the secret.

*/ inline CreateSecretRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt * the secret value in the secret. An alias is always prefixed by * alias/, for example alias/aws/secretsmanager. For more * information, see About * aliases.

To use a KMS key in a different account, use the key ARN or * the alias ARN.

If you don't specify this value, then Secrets Manager uses * the key aws/secretsmanager. If that key doesn't yet exist, then * Secrets Manager creates it for you automatically the first time it encrypts the * secret value.

If the secret is in a different Amazon Web Services account * from the credentials calling the API, then you can't use * aws/secretsmanager to encrypt the secret, and you must create and * use a customer managed KMS key.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline CreateSecretRequest& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline CreateSecretRequest& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

To use a KMS key in a different account, use the key ARN or * the alias ARN.

*/ inline CreateSecretRequest& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline const Aws::Utils::CryptoBuffer& GetSecretBinary() const{ return m_secretBinary; } /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline bool SecretBinaryHasBeenSet() const { return m_secretBinaryHasBeenSet; } /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline void SetSecretBinary(const Aws::Utils::CryptoBuffer& value) { m_secretBinaryHasBeenSet = true; m_secretBinary = value; } /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline void SetSecretBinary(Aws::Utils::CryptoBuffer&& value) { m_secretBinaryHasBeenSet = true; m_secretBinary = std::move(value); } /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline CreateSecretRequest& WithSecretBinary(const Aws::Utils::CryptoBuffer& value) { SetSecretBinary(value); return *this;} /** *

The binary data to encrypt and store in the new version of the secret. We * recommend that you store your binary data in a file and then pass the contents * of the file as a parameter.

Either SecretString or * SecretBinary must have a value, but not both.

This parameter * is not available in the Secrets Manager console.

*/ inline CreateSecretRequest& WithSecretBinary(Aws::Utils::CryptoBuffer&& value) { SetSecretBinary(std::move(value)); return *this;} /** *

The text data to encrypt and store in this new version of the secret. We * recommend you use a JSON structure of key/value pairs for your secret value.