aws-ag-client

This Java repo demonstrates how to make IAM authenticated call to AWS api gateway endpoint. It is setup as a maven project currently and uses the AWS java SDK under the hood to provide simple wrapper classes to make these calls.

How to use?

• Configure Application gateway client as shown below in code snippet:

       AWSSecurityTokenService stsClient = AWSSecurityTokenServiceClientBuilder.standard()
                    .withCredentials(new AWSStaticCredentialsProvider(new BasicAWSCredentials(ACCESS_KEY, SECRET_KEY)))
                    .withRegion(US_EAST_1)
                    .build();
  
       ApiGatewayClient client = new ClientBuilder()
                  .withClientConfiguration(new ClientConfiguration())
                  .withCredentials(new STSAssumeRoleSessionCredentialsProvider.Builder(ROLE_ARN, "readable-session-name")
                          .withStsClient(stsClient)
                          .withRoleSessionDurationSeconds(3600)
                          .build())
                  .withEndpoint(ENDPOINT)
                  .build();
                
   

  • ACCESS_KEY: Access key of user account on which IAM role will be assumed.
  • SECRET_KEY: Secret key of user account on which IAM role will be assumed.
  • ROLE_ARN: ARN of role that is set up to access API gateway. Ex: arn:aws:iam:::role/roleName
  • ENDPOINT: Api gateway endpoint. Ex: https://hash.execute-api.us-east-1.amazonaws.com

• Configure Request object for API call

      Request request = new RequestBuilder()
                      .withHttpMethod(HttpMethodName.GET)
                      .withBody("")
                      .withHeaders(Map.of("Content-Type", "application/json"))
                      .withResourcePath(PATH)
                      .build();
  
  

  • PATH: Path to the api call request. This will be path of API after the specified root ENDPOINT.

• Execute configured request with API gateway client object as shown below:

        try {
  
            Response response = client.execute(request);
  
        } catch (ApiGatewayException e) {
            // Handle exception as needed!
        }
      
  

  • In case of non 2XX response from the API call ApiGatewayException is thrown. Clients should handle this exception as per the needed use case.

• Sample code as described above also resides in main file here

Want to make a test run before using it?

• Prerequisites installations:

  • Maven
  • Java 11

  if you use brew to manage packages, use below commands to install maven and java 11:

          brew install maven
  
          brew tap homebrew/cask-versions
  
          brew cask install java11
  
  

• Run below command after updating variable here with correct values:

          mvn clean install
  
          java -jar  target/ag-client-1.0.jar