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

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 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

The ID of the version to add the staging label to. 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)

2396
2397
2398
2399
2400
2401
2402
2403
# File 'lib/aws-sdk-secretsmanager/types.rb', line 2396

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

The 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)

2396
2397
2398
2399
2400
2401
2402
2403
# File 'lib/aws-sdk-secretsmanager/types.rb', line 2396

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

#secret_idString

The ARN or the name of the secret with the version and staging labelsto modify.

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

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

  • (String)

2396
2397
2398
2399
2400
2401
2402
2403
# File 'lib/aws-sdk-secretsmanager/types.rb', line 2396

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)

2396
2397
2398
2399
2400
2401
2402
2403
# File 'lib/aws-sdk-secretsmanager/types.rb', line 2396

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