software.amazon.awssdk.services.secretsmanager.model

Class GetSecretValueResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

software.amazon.awssdk.services.secretsmanager.model.GetSecretValueResponse

All Implemented Interfaces:

ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSecretValueResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSecretValueResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the secret.
static GetSecretValueResponse.Builder	builder()
Instant	createdDate() The date and time that this version of the secret was created.
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 SdkResponse.
int	hashCode()
String	name() The friendly name of the secret.
SdkBytes	secretBinary() The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
String	secretString() The decrypted part of the protected secret information that was originally provided as a string.
static Class<? extends GetSecretValueResponse.Builder>	serializableBuilderClass()
GetSecretValueResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionId() The unique identifier of this version of the secret.
List<String>	versionStages() A list of all of the staging labels currently attached to this version of the secret.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public String arn()

The ARN of the secret.

Returns:

The ARN of the secret.

name

public String name()

The friendly name of the secret.

Returns:

The friendly name of the secret.

versionId

public String versionId()

The unique identifier of this version of the secret.

Returns:

The unique identifier of this version of the secret.

secretBinary

public SdkBytes secretBinary()

The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

This parameter is not used if the secret is created by the Secrets Manager console.

If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.

Returns:

The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

This parameter is not used if the secret is created by the Secrets Manager console.

If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.

secretString

public String secretString()

The decrypted part of the protected secret information that was originally provided as a string.

If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.

Returns:

The decrypted part of the protected secret information that was originally provided as a string.

If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.

versionStages

public List<String> versionStages()

A list of all of the staging labels currently attached to this version of the secret.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of all of the staging labels currently attached to this version of the secret.

createdDate

public Instant createdDate()

The date and time that this version of the secret was created.

Returns:

The date and time that this version of the secret was created.

toBuilder

public GetSecretValueResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetSecretValueResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSecretValueResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value