Class AwsSecretsManagerConfig.Builder

java.lang.Object
codes.grow.packages.awssecretsmanager.AwsSecretsManagerConfig.Builder
Enclosing class:
AwsSecretsManagerConfig

public static final class AwsSecretsManagerConfig.Builder extends Object
Builder of the configuration.

Fields that are not set explicitly take the environment (when fromEnv(EnvReader) was called, in any order) or the default.

  • Method Details

    • fromEnv

      Fills every field that is not set explicitly from the environment when build() runs: GROW_AWS_SECRETS_MANAGER_* first, then the standard AWS variables. The key id, secret key and session token are taken as one set from one layer (a GROW_* key id never pairs with an AWS_* secret). With an explicit sdkClient or credentials, credentials from the environment are ignored; with sdkClient also the region, endpoint, profile and role.
      Parameters:
      env - environment reader
      Returns:
      this builder
    • url

      Sets the endpoint override, e.g. http://localhost:5000 for an emulator. Unset: the AWS SDK resolves https://secretsmanager.<region>.amazonaws.com.
      Parameters:
      url - http or https URL
      Returns:
      this builder
    • connectTimeout

      public AwsSecretsManagerConfig.Builder connectTimeout(Duration d)
      Sets the connect timeout (default 10 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • requestTimeout

      public AwsSecretsManagerConfig.Builder requestTimeout(Duration d)
      Sets the per-attempt timeout (default 30 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • totalTimeout

      public AwsSecretsManagerConfig.Builder totalTimeout(Duration d)
      Sets the total timeout per call including retries (default 120 s).
      Parameters:
      d - positive duration
      Returns:
      this builder
    • retry

      Sets the retry policy (default RetryPolicy.defaults()).
      Parameters:
      retry - policy
      Returns:
      this builder
    • tls

      Sets the TLS options; environment TLS variables are then ignored.
      Parameters:
      tls - options
      Returns:
      this builder
    • proxy

      Sets an explicit proxy URL; environment proxies (HTTPS_PROXY) are never used.
      Parameters:
      proxy - proxy URL
      Returns:
      this builder
    • header

      public AwsSecretsManagerConfig.Builder header(String name, String value)
      Adds a header sent with every request.
      Parameters:
      name - header name
      value - header value
      Returns:
      this builder
    • userAgentSuffix

      public AwsSecretsManagerConfig.Builder userAgentSuffix(String suffix)
      Sets the text appended to the User-Agent.
      Parameters:
      suffix - suffix
      Returns:
      this builder
    • hooks

      public AwsSecretsManagerConfig.Builder hooks(Hooks hooks)
      Sets request hooks.
      Parameters:
      hooks - hooks
      Returns:
      this builder
    • logger

      public AwsSecretsManagerConfig.Builder logger(Logger logger)
      Sets the logger (default silent).
      Parameters:
      logger - logger
      Returns:
      this builder
    • region

      public AwsSecretsManagerConfig.Builder region(String region)
      Sets the AWS region.
      Parameters:
      region - region such as eu-central-1
      Returns:
      this builder
    • accessKeyId

      public AwsSecretsManagerConfig.Builder accessKeyId(String accessKeyId)
      Sets the static access key id (requires secretAccessKey(String)).
      Parameters:
      accessKeyId - key id
      Returns:
      this builder
    • secretAccessKey

      public AwsSecretsManagerConfig.Builder secretAccessKey(String secretAccessKey)
      Sets the static secret access key.
      Parameters:
      secretAccessKey - key
      Returns:
      this builder
    • secretAccessKey

      public AwsSecretsManagerConfig.Builder secretAccessKey(Secret secretAccessKey)
      Sets the static secret access key.
      Parameters:
      secretAccessKey - key
      Returns:
      this builder
    • sessionToken

      public AwsSecretsManagerConfig.Builder sessionToken(String sessionToken)
      Sets the session token of temporary credentials.
      Parameters:
      sessionToken - token
      Returns:
      this builder
    • sessionToken

      public AwsSecretsManagerConfig.Builder sessionToken(Secret sessionToken)
      Sets the session token of temporary credentials.
      Parameters:
      sessionToken - token
      Returns:
      this builder
    • profile

      public AwsSecretsManagerConfig.Builder profile(String profile)
      Selects a shared config / credentials profile.
      Parameters:
      profile - profile name
      Returns:
      this builder
    • credentials

      public AwsSecretsManagerConfig.Builder credentials(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentials)
      Uses an AWS SDK credentials provider instead of the key fields or the default chain.
      Parameters:
      credentials - provider
      Returns:
      this builder
    • roleArn

      public AwsSecretsManagerConfig.Builder roleArn(String roleArn)
      Assumes this IAM role with STS on top of the base credentials.
      Parameters:
      roleArn - role ARN
      Returns:
      this builder
    • roleSessionName

      public AwsSecretsManagerConfig.Builder roleSessionName(String name)
      Sets the STS role session name (default "grow-sdk").
      Parameters:
      name - session name
      Returns:
      this builder
    • externalId

      public AwsSecretsManagerConfig.Builder externalId(String externalId)
      Sets the STS external id.
      Parameters:
      externalId - external id
      Returns:
      this builder
    • roleDuration

      public AwsSecretsManagerConfig.Builder roleDuration(Duration duration)
      Sets the assumed-role session duration (900 s – 43 200 s; default: the role's default).
      Parameters:
      duration - duration
      Returns:
      this builder
    • recoveryWindowDays

      public AwsSecretsManagerConfig.Builder recoveryWindowDays(int days)
      Sets the recovery window of deletes in days (7–30, default 30).
      Parameters:
      days - window
      Returns:
      this builder
    • sdkClient

      public AwsSecretsManagerConfig.Builder sdkClient(software.amazon.awssdk.services.secretsmanager.SecretsManagerClient sdkClient)
      Wraps an existing AWS SDK client instead of building one. Mutually exclusive with the credential, region, profile, role and endpoint fields; close() never closes it and the Grow timeouts, retries, TLS, proxy, headers, hooks and User-Agent do not apply to it.
      Parameters:
      sdkClient - the client
      Returns:
      this builder
    • build

      public AwsSecretsManagerConfig build()
      Builds and validates the configuration.
      Returns:
      the configuration
      Throws:
      ConfigException - when a rule is violated