Package org.nuxeo.runtime.aws

Interface AWSConfigurationService

All Known Implementing Classes:
AWSConfigurationServiceImpl
public interface AWSConfigurationService
The service providing AWS configuration.
Since:
10.3

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    configureProxy(com.amazonaws.ClientConfiguration config)
    Enriches the given ClientConfiguration with default proxy configuration.
    default void
    configureSSL(com.amazonaws.ClientConfiguration config)
    Enriches the given client configuration with an SSL socket factory from the default configuration.
    void
    configureSSL(String id, com.amazonaws.ClientConfiguration config)
    Enriches the given client configuration with an SSL socket factory from the given configuration.
    default com.amazonaws.auth.AWSCredentials
    getAWSCredentials()
    Gets the AWS Credentials for the default configuration.
    com.amazonaws.auth.AWSCredentials
    getAWSCredentials(String id)
    Gets the AWS Credentials for the given configuration.
    default String
    getAWSRegion()
    Gets the AWS Region for the default configuration.
    String
    getAWSRegion(String id)
    Gets the AWS Region for the given configuration.

  • Method Details

    • getAWSCredentials

      default com.amazonaws.auth.AWSCredentials getAWSCredentials()
      Gets the AWS Credentials for the default configuration.
      Returns:
      the AWS credentials, or null if not defined

    • getAWSCredentials

      com.amazonaws.auth.AWSCredentials getAWSCredentials(String id)
      Gets the AWS Credentials for the given configuration.
      Parameters:
      id - the configuration id, or null for the default
      Returns:
      the AWS credentials, or null if not defined
      Since:
      11.1

    • configureSSL

      default void configureSSL(com.amazonaws.ClientConfiguration config)
      Enriches the given client configuration with an SSL socket factory from the default configuration.
      Parameters:
      config - the configuration to enrich
      Since:
      2021.10

    • configureSSL

      void configureSSL(String id, com.amazonaws.ClientConfiguration config)
      Enriches the given client configuration with an SSL socket factory from the given configuration.
      Parameters:
      id - the custom configuration id
      config - the configuration to enrich
      Since:
      2021.10

    • configureProxy

      default void configureProxy(com.amazonaws.ClientConfiguration config)
      Enriches the given ClientConfiguration with default proxy configuration.
      Parameters:
      config - the configuration to enrich
      Since:
      2023.4

    • getAWSRegion

      default String getAWSRegion()
      Gets the AWS Region for the default configuration.
      Returns:
      the AWS Region, or null if not defined

    • getAWSRegion

      String getAWSRegion(String id)
      Gets the AWS Region for the given configuration.
      Parameters:
      id - the configuration id, or null for the default
      Returns:
      the AWS Region, or null if not defined
      Since:
      11.1