Package io.deephaven.extensions.s3

Interface Credentials

All Known Subinterfaces:
AwsSdkV2Credentials
public interface Credentials

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static Credentials
    anonymous()
    Anonymous credentials.
    static Credentials
    basic(String accessKeyId, String secretAccessKey)
    Basic credentials with the specified access key id and secret access key.
    static Credentials
    defaultCredentials()
    Default credentials provider used by the AWS SDK that looks for credentials at a number of locations as described in DefaultCredentialsProvider
    static Credentials
    profile()
    Profile specific credentials that uses configuration and credentials files.
    static Credentials
    resolving()
    Default credentials provider used by Deephaven which resolves credentials in the following order: If a profile name, config file path, or credentials file path is provided, use ProfileCredentialsProvider If not, check all places mentioned in DefaultCredentialsProvider and fall back to AnonymousCredentialsProvider
    static Credentials
    session(String accessKeyId, String secretAccessKey, String sessionToken)
    Session credentials with the specified access key id, secret access key, and session token.

  • Method Details

    • resolving

      static Credentials resolving()
      Default credentials provider used by Deephaven which resolves credentials in the following order:
      1. If a profile name, config file path, or credentials file path is provided, use ProfileCredentialsProvider
      2. If not, check all places mentioned in DefaultCredentialsProvider and fall back to AnonymousCredentialsProvider
      See Also:
      • ProfileCredentialsProvider
      • DefaultCredentialsProvider
      • AnonymousCredentialsProvider

    • defaultCredentials

      static Credentials defaultCredentials()
      Default credentials provider used by the AWS SDK that looks for credentials at a number of locations as described in DefaultCredentialsProvider
      See Also:
      • DefaultCredentialsProvider

    • basic

      static Credentials basic(String accessKeyId, String secretAccessKey)
      Basic credentials with the specified access key id and secret access key.
      Parameters:
      accessKeyId - the access key id, used to identify the user
      secretAccessKey - the secret access key, used to authenticate the user

    • session

      static Credentials session(String accessKeyId, String secretAccessKey, String sessionToken)
      Session credentials with the specified access key id, secret access key, and session token. This is useful when using temporary credentials from AWS STS or similar services.
      Parameters:
      accessKeyId - the access key id, used to identify the user
      secretAccessKey - the secret access key, used to authenticate the user
      sessionToken - the session token, used for temporary credentials

    • anonymous

      static Credentials anonymous()
      Anonymous credentials. This is useful when the S3 policy has been set to allow anonymous access.

    • profile

      static Credentials profile()
      Profile specific credentials that uses configuration and credentials files.
      See Also:
      • ProfileCredentialsProvider