Class: Aws::SecretsManager::Types::PutSecretValueRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass PutSecretValueRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  secret_binary: "data",
  secret_string: "SecretStringType",
  version_stages: ["SecretVersionStageType"],
}

Constant Summary collapse

SENSITIVE =
[:secret_binary, :secret_string]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for the new version of the secret.

<note markdown=“1”> 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.

</note>

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

  • (String)

1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1357

class PutSecretValueRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :secret_binary,
  :secret_string,
  :version_stages)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#secret_binaryString

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.

Returns:

  • (String)

1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1357

class PutSecretValueRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :secret_binary,
  :secret_string,
  :version_stages)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#secret_idString

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.

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

Returns:

  • (String)

1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1357

class PutSecretValueRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :secret_binary,
  :secret_string,
  :version_stages)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#secret_stringString

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.

Returns:

  • (String)

1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1357

class PutSecretValueRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :secret_binary,
  :secret_string,
  :version_stages)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#version_stagesArray<String>

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.

If you don't include `VersionStages`, then Secrets Manager automatically moves the staging label `AWSCURRENT` to this version.

Returns:

  • (Array<String>)

1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1357

class PutSecretValueRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :secret_binary,
  :secret_string,
  :version_stages)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end