Interface GetSecretValueRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>, SdkBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder
Enclosing class:
GetSecretValueRequest
@Mutable @NotThreadSafe public static interface GetSecretValueRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>

  • Method Details

    • secretId

      GetSecretValueRequest.Builder secretId(String secretId)

      The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Parameters:
      secretId - The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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

    • versionId

      GetSecretValueRequest.Builder versionId(String versionId)

      The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

      This value is typically a UUID-type value with 32 hexadecimal digits.

      Parameters:
      versionId - The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

      This value is typically a UUID-type value with 32 hexadecimal digits.

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

    • versionStage

      GetSecretValueRequest.Builder versionStage(String versionStage)

      The staging label of the version of the secret to retrieve.

      Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.

      Parameters:
      versionStage - The staging label of the version of the secret to retrieve.

      Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId , Secrets Manager returns the AWSCURRENT version.

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

    • overrideConfiguration

      GetSecretValueRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetSecretValueRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.