Class: Aws::SecretsManager::Types::UpdateSecretRequest

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

Overview

Note:

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

{
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  description: "DescriptionType",
  kms_key_id: "KmsKeyIdType",
  secret_binary: "data",
  secret_string: "SecretStringType",
}

Constant Summary collapse

SENSITIVE =
[:secret_binary, :secret_string]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

If you include SecretString or SecretBinary, then Secrets Manager creates a new 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 becomes the VersionId of the new version.

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

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

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

#descriptionString

The description of the secret.

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

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

#kms_key_idString

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version.

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

class UpdateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :description,
  :kms_key_id,
  :secret_binary,
  :secret_string)
  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. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

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

You can't access this parameter in the Secrets Manager console.

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

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

#secret_idString

The ARN or name of the secret.

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

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

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

#secret_stringString

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

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

Returns:

  • (String)


2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2273

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