software.amazon.awssdk.services.secretsmanager.model

Interface UpdateSecretVersionStageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>, SdkBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>, SdkRequest.Builder, SecretsManagerRequest.Builder

Enclosing class:

UpdateSecretVersionStageRequest

public static interface UpdateSecretVersionStageRequest.Builder
extends SecretsManagerRequest.Builder, CopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>

Method Summary

Modifier and Type	Method and Description
UpdateSecretVersionStageRequest.Builder	moveToVersionId(String moveToVersionId) (Optional) The secret version ID that you want to add the staging labels to.
UpdateSecretVersionStageRequest.Builder	removeFromVersionId(String removeFromVersionId) (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
UpdateSecretVersionStageRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
UpdateSecretVersionStageRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
UpdateSecretVersionStageRequest.Builder	secretId(String secretId) Specifies the secret with the version whose list of staging labels you want to modify.
UpdateSecretVersionStageRequest.Builder	versionStage(String versionStage) The list of staging labels to add to this version.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

secretId

UpdateSecretVersionStageRequest.Builder secretId(String secretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

versionStage

UpdateSecretVersionStageRequest.Builder versionStage(String versionStage)

The list of staging labels to add to this version.

Parameters:

versionStage - The list of staging labels to add to this version.

Returns:

Returns a reference to this object so that method calls can be chained together.

removeFromVersionId

UpdateSecretVersionStageRequest.Builder removeFromVersionId(String removeFromVersionId)

(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Parameters:

removeFromVersionId - (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Returns:

Returns a reference to this object so that method calls can be chained together.

moveToVersionId

UpdateSecretVersionStageRequest.Builder moveToVersionId(String moveToVersionId)

(Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Parameters:

moveToVersionId - (Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

UpdateSecretVersionStageRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

UpdateSecretVersionStageRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.