@Generated(value="software.amazon.awssdk:codegen") public final class GetSecretValueRequest extends SecretsManagerRequest implements ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetSecretValueRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetSecretValueRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
String |
secretId()
Specifies the secret containing the version that you want to retrieve.
|
static Class<? extends GetSecretValueRequest.Builder> |
serializableBuilderClass() |
GetSecretValueRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
Specifies the unique identifier of the version of the secret that you want to retrieve.
|
String |
versionStage()
Specifies the secret version that you want to retrieve by the staging label attached to the version.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic String secretId()
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
public String versionId()
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this
parameter then don't specify VersionStage. If you don't specify either a VersionStage
or VersionId then the default is to perform the operation on the version with the
VersionStage value of AWSCURRENT.
This value is typically a UUID-type value with 32 hexadecimal digits.
VersionStage. If you don't specify either a
VersionStage or VersionId then the default is to perform the operation on the
version with the VersionStage value of AWSCURRENT.
This value is typically a UUID-type value with 32 hexadecimal digits.
public String versionStage()
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you use this
parameter then don't specify VersionId. If you don't specify either a VersionStage or
VersionId, then the default is to perform the operation on the version with the
VersionStage value of AWSCURRENT.
Staging labels are used to keep track of different versions during the rotation process. If you use this
parameter then don't specify VersionId. If you don't specify either a
VersionStage or VersionId, then the default is to perform the operation on the
version with the VersionStage value of AWSCURRENT.
public GetSecretValueRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>toBuilder in class SecretsManagerRequestpublic static GetSecretValueRequest.Builder builder()
public static Class<? extends GetSecretValueRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode in class AwsRequestpublic boolean equals(Object obj)
equals in class AwsRequestpublic boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2020. All rights reserved.