Interface AwsCommonConfiguration

public interface AwsCommonConfiguration
Common configuration interface for all AWS components.

Each AWS component's Configuration class should implement this interface to enable use of the common AwsClientBuilderUtil for client creation.

  • Method Details

    • getAccessKey

      String getAccessKey()
      Amazon AWS Access Key.

    • getSecretKey

      String getSecretKey()
      Amazon AWS Secret Key.

    • getSessionToken

      String getSessionToken()
      Amazon AWS Session Token used when the user needs to assume an IAM role.

    • isUseDefaultCredentialsProvider

      boolean isUseDefaultCredentialsProvider()
      Set whether the client should expect to load credentials through a default credentials provider.

    • isUseProfileCredentialsProvider

      boolean isUseProfileCredentialsProvider()
      Set whether the client should expect to load credentials through a profile credentials provider.

    • isUseSessionCredentials

      boolean isUseSessionCredentials()
      Set whether the client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role.

    • getProfileCredentialsName

      String getProfileCredentialsName()
      If using a profile credentials provider, this parameter specifies the profile name.

    • getProxyProtocol

      software.amazon.awssdk.core.Protocol getProxyProtocol()
      To define a proxy protocol when instantiating the client.

    • getProxyHost

      String getProxyHost()
      To define a proxy host when instantiating the client.

    • getProxyPort

      Integer getProxyPort()
      Specify a proxy port to be used inside the client definition.

    • getRegion

      String getRegion()
      The region in which the client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1).

    • isOverrideEndpoint

      boolean isOverrideEndpoint()
      Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option.

    • getUriEndpointOverride

      String getUriEndpointOverride()
      Set the overriding URI endpoint. This option needs to be used in combination with overrideEndpoint option.

    • isTrustAllCertificates

      boolean isTrustAllCertificates()
      If we want to trust all certificates in case of overriding the endpoint.