Package 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 Details

    • 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 secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.

      If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.

      Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      Parameters:
      secretBinary - The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.

      If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.

      Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

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

    • secretString

      GetSecretValueResponse.Builder secretString(String secretString)

      The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

      If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.

      Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      Parameters:
      secretString - The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

      If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.

      Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      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. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.

      Parameters:
      createdDate - The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.