software.amazon.awssdk.services.secretsmanager.model

Interface GetSecretValueResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>, SdkBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>, SdkPojo, SdkResponse.Builder, SecretsManagerResponse.Builder

Enclosing class:

GetSecretValueResponse

public static interface GetSecretValueResponse.Builder
extends SecretsManagerResponse.Builder, SdkPojo, CopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Method Summary

Modifier and Type	Method and Description
GetSecretValueResponse.Builder	arn(String arn) The ARN of the secret.
GetSecretValueResponse.Builder	createdDate(Instant createdDate) The date and time that this version of the secret was created.
GetSecretValueResponse.Builder	name(String name) The friendly name of the secret.
GetSecretValueResponse.Builder	secretBinary(SdkBytes secretBinary) The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
GetSecretValueResponse.Builder	secretString(String secretString) The decrypted part of the protected secret information that was originally provided as a string.
GetSecretValueResponse.Builder	versionId(String versionId) The unique identifier of this version of the secret.
GetSecretValueResponse.Builder	versionStages(Collection<String> versionStages) A list of all of the staging labels currently attached to this version of the secret.
GetSecretValueResponse.Builder	versionStages(String... versionStages) A list of all of the staging labels currently attached to this version of the secret.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

arn

GetSecretValueResponse.Builder arn(String arn)

The ARN of the secret.

Parameters:

arn - The ARN of the secret.

Returns:

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

name

GetSecretValueResponse.Builder name(String name)

The friendly name of the secret.

Parameters:

name - The friendly name of the secret.

Returns:

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

versionId

GetSecretValueResponse.Builder versionId(String versionId)

The unique identifier of this version of the secret.

Parameters:

versionId - The unique identifier of this version of the secret.

Returns:

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

secretBinary

GetSecretValueResponse.Builder secretBinary(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.

Parameters:

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:

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

secretString

GetSecretValueResponse.Builder secretString(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.

Parameters:

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:

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

versionStages

GetSecretValueResponse.Builder versionStages(Collection<String> versionStages)

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

Parameters:

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

Returns:

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

versionStages

GetSecretValueResponse.Builder versionStages(String... versionStages)

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

Parameters:

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

Returns:

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

createdDate

GetSecretValueResponse.Builder createdDate(Instant createdDate)

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

Parameters:

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

Returns:

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