@Generated(value="software.amazon.awssdk:codegen") public final class UpdateSecretVersionStageRequest extends SecretsManagerRequest implements ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateSecretVersionStageRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateSecretVersionStageRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
moveToVersionId()
(Optional) The secret version ID that you want to add the staging labels to.
|
String |
removeFromVersionId()
(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
|
String |
secretId()
Specifies the secret with the version whose list of staging labels you want to modify.
|
static Class<? extends UpdateSecretVersionStageRequest.Builder> |
serializableBuilderClass() |
UpdateSecretVersionStageRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
versionStage()
The list of staging labels to add to this version.
|
overrideConfiguration
copy
public 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.
public String versionStage()
The list of staging labels to add to this version.
public 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.
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.
public 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.
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.
public UpdateSecretVersionStageRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>
toBuilder
in class SecretsManagerRequest
public static UpdateSecretVersionStageRequest.Builder builder()
public static Class<? extends UpdateSecretVersionStageRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.