/** * 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 namespace Aws { namespace SecretsManager { namespace Model { /** */ class PutSecretValueRequest : public SecretsManagerRequest { public: AWS_SECRETSMANAGER_API PutSecretValueRequest(); // 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 "PutSecretValue"; } AWS_SECRETSMANAGER_API Aws::String SerializePayload() const override; AWS_SECRETSMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline const Aws::String& GetSecretId() const{ return m_secretId; } /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline bool SecretIdHasBeenSet() const { return m_secretIdHasBeenSet; } /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline void SetSecretId(const Aws::String& value) { m_secretIdHasBeenSet = true; m_secretId = value; } /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline void SetSecretId(Aws::String&& value) { m_secretIdHasBeenSet = true; m_secretId = std::move(value); } /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline void SetSecretId(const char* value) { m_secretIdHasBeenSet = true; m_secretId.assign(value); } /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline PutSecretValueRequest& WithSecretId(const Aws::String& value) { SetSecretId(value); return *this;} /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline PutSecretValueRequest& WithSecretId(Aws::String&& value) { SetSecretId(std::move(value)); return *this;} /** *

The ARN or name of the secret to add a new version to.

For an ARN, we * recommend that you specify a complete ARN rather than a partial ARN. See Finding * a secret from a partial ARN.

If the secret doesn't already exist, use * CreateSecret instead.

*/ inline PutSecretValueRequest& WithSecretId(const char* value) { SetSecretId(value); return *this;} /** *

A unique identifier for the new version of the secret.

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 because they generate a * random UUID for you. 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 new versions and include that 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 the Lambda rotation function * processing. We recommend that you generate a UUID-type * value to ensure uniqueness 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

A unique identifier for the new version of the 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 that version's * SecretString or SecretBinary values are the same as * those in the request then the request is ignored. The operation is idempotent. *
If a version with this value already exists and the version * of the SecretString and SecretBinary values are * different from those in the request, then the request fails because you can't * modify a secret version. You can only create new versions to store new secret * values.

This value becomes the VersionId of the * new version.

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

The binary data to encrypt and store in the new version of the secret. To use * this parameter in the command-line tools, we recommend that you store your * binary data in a file and then pass the contents of the file as a parameter. *

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

You must include SecretBinary or SecretString, * but not both.

You can't access this value from the Secrets Manager * console.

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

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline const Aws::String& GetSecretString() const{ return m_secretString; } /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline bool SecretStringHasBeenSet() const { return m_secretStringHasBeenSet; } /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline void SetSecretString(const Aws::String& value) { m_secretStringHasBeenSet = true; m_secretString = value; } /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline void SetSecretString(Aws::String&& value) { m_secretStringHasBeenSet = true; m_secretString = std::move(value); } /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline void SetSecretString(const char* value) { m_secretStringHasBeenSet = true; m_secretString.assign(value); } /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline PutSecretValueRequest& WithSecretString(const Aws::String& value) { SetSecretString(value); return *this;} /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline PutSecretValueRequest& WithSecretString(Aws::String&& value) { SetSecretString(std::move(value)); return *this;} /** *

The text to encrypt and store in the new version of the secret.

You * must include SecretBinary or SecretString, but not * both.

We recommend you create the secret string as JSON key/value pairs, * as shown in the example.

*/ inline PutSecretValueRequest& WithSecretString(const char* value) { SetSecretString(value); return *this;} /** *

A list of staging labels to attach to this version of the secret. Secrets * Manager uses staging labels to track versions of a secret through the rotation * process.

If you specify a staging label that's already associated with a * different version of the same secret, then Secrets Manager removes the label * from the other version and attaches it to this version. If you specify * AWSCURRENT, and it is already attached to another version, then * Secrets Manager also moves the staging label AWSPREVIOUS to the * version that AWSCURRENT was removed from.