AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SecretsManager::Types::UpdateSecretVersionStageRequest

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 UpdateSecretVersionStageRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  version_stage: "SecretVersionStageType", # required
  remove_from_version_id: "SecretVersionIdType",
  move_to_version_id: "SecretVersionIdType",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#move_to_version_idString

(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2368

class UpdateSecretVersionStageRequest < Struct.new(
  :secret_id,
  :version_stage,
  :remove_from_version_id,
  :move_to_version_id)
  SENSITIVE = []
  include Aws::Structure
end

#remove_from_version_idString

Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2368

class UpdateSecretVersionStageRequest < Struct.new(
  :secret_id,
  :version_stage,
  :remove_from_version_id,
  :move_to_version_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_idString

Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2368

class UpdateSecretVersionStageRequest < Struct.new(
  :secret_id,
  :version_stage,
  :remove_from_version_id,
  :move_to_version_id)
  SENSITIVE = []
  include Aws::Structure
end

#version_stageString

The staging label to add to this version.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2368

class UpdateSecretVersionStageRequest < Struct.new(
  :secret_id,
  :version_stage,
  :remove_from_version_id,
  :move_to_version_id)
  SENSITIVE = []
  include Aws::Structure
end