com.sunrun.cfnresponse.CfnResponseSender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cfn-response Show documentation
A utility for using Cloudformation with Java8-based lambdas as custom resources
There is a newer version: 1.2.2
package com.sunrun.cfnresponse;

import com.amazonaws.services.lambda.runtime.Context;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.HttpClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.IOException;

/**
 * Manages sending REST call to S3 endpoint to communicate with CFN service
 */
public class CfnResponseSender {

    private static final Logger LOGGER = LoggerFactory.getLogger(CfnResponseSender.class);
    private final ObjectMapper mapper = new ObjectMapper().setPropertyNamingStrategy(PropertyNamingStrategy.UPPER_CAMEL_CASE);
    private final HttpClient httpClient;

    public CfnResponseSender() {
        httpClient = HttpClientBuilder.create().build();
    }

    /**
     * Visible for testing
     *
     * @param httpClient mock for testing
     */
    CfnResponseSender(final HttpClient httpClient) {
        this.httpClient = httpClient;
    }

    /**
     * Synchronously sends response to Cloudformation S3 endpoint
     *
     * @param event              cloudformation event
     * @param status             SUCCESS or FAILURE
     * @param context            AWS lambda context
     * @param reason             custom reason to report to cfn (optional)
     * @param data               user data return object (optional)
     * @param physicalResourceId custom physical resource ID (optional)
     * @param                 type of custom user data to send in response
     * @return true if success, false if there was an error (check logs)
     */
    public  boolean send(@Nonnull final CfnRequest event, @Nonnull final Status status, @Nonnull final Context context,
                            @Nullable final String reason, @Nullable final T data, @Nullable final String physicalResourceId) {
        return send(event, status, context, reason, data, physicalResourceId, false);
    }

    /**
     * Synchronously sends response to Cloudformation S3 endpoint
     *
     * @param event              cloudformation event
     * @param status             SUCCESS or FAILURE
     * @param context            AWS lambda context
     * @param reason             custom reason to report to cfn (optional)
     * @param data               user data return object (optional)
     * @param physicalResourceId custom physical resource ID (optional)
     * @param noEcho             Indicates whether to mask the output of the custom resource when retrieved by using the Fn::GetAtt function (optional)
     * @param                 type of custom user data to send in response
     * @return true if success, false if there was an error (check logs)
     */
    public  boolean send(@Nonnull final CfnRequest event, @Nonnull final Status status, @Nonnull final Context context,
                            @Nullable final String reason, @Nullable final T data, @Nullable final String physicalResourceId,
                            final boolean noEcho) {
        // Sanitize inputs
        checkNotNull(event, "event");
        checkNotNull(status, "status");
        checkNotNull(context, "context");

        // Compose response
        final CfnResponse response = new CfnResponse<>();
        response.setData(data);
        response.setStatus(status);
        response.setLogicalResourceId(event.getLogicalResourceId());
        response.setPhysicalResourceId(physicalResourceId == null ? context.getLogStreamName() : physicalResourceId);
        response.setReason(reason == null ? "See the details in CloudWatch Log Stream: " + context.getLogStreamName() : reason);
        response.setRequestId(event.getRequestId());
        response.setStackId(event.getStackId());
        response.setNoEcho(noEcho);

        // Send response
        final HttpPut put = new HttpPut(event.getResponseURL());
        try {
            final String body = mapper.writeValueAsString(response);
            LOGGER.info(body);
            put.setEntity(new StringEntity(body));
            put.setHeader("Content-Type", "");
            httpClient.execute(put, new BasicResponseHandler());
        } catch (final IOException e) {
            LOGGER.error("Could not send response to " + event.getResponseURL(), e);
            return false;
        }
        return true;
    }

    private  void checkNotNull(final Object param, final String name) {
        if (param == null) {
            throw new IllegalArgumentException("param " + name + " cannot be null.");
        }
    }
}