software.amazon.awssdk.services.secretsmanager.model

Interface UpdateSecretVersionStageRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateSecretVersionStageRequest

public static interface UpdateSecretVersionStageRequest.Builder
extends SecretsManagerRequest.Builder, SdkPojo, 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 label.
UpdateSecretVersionStageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateSecretVersionStageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateSecretVersionStageRequest.Builder	removeFromVersionId(String removeFromVersionId) Specifies the secret version ID of the version that the staging label is to be removed from.
UpdateSecretVersionStageRequest.Builder	secretId(String secretId) Specifies the secret with the version with the list of staging labels you want to modify.
UpdateSecretVersionStageRequest.Builder	versionStage(String versionStage) The staging label 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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

secretId

UpdateSecretVersionStageRequest.Builder secretId(String secretId)

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.

Parameters:

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

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

versionStage

UpdateSecretVersionStageRequest.Builder versionStage(String versionStage)

The staging label to add to this version.

Parameters:

versionStage - The staging label 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)

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.

Parameters:

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

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

Parameters:

moveToVersionId - (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:

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

overrideConfiguration

UpdateSecretVersionStageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateSecretVersionStageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.