io.cloudshiftdev.awscdk.services.apigateway.GatewayResponse.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.apigateway

import io.cloudshiftdev.awscdk.Resource
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct

/**
 * Configure the response received by clients, produced from the API Gateway backend.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.services.apigateway.*;
 * ResponseType responseType;
 * RestApi restApi;
 * GatewayResponse gatewayResponse = GatewayResponse.Builder.create(this, "MyGatewayResponse")
 * .restApi(restApi)
 * .type(responseType)
 * // the properties below are optional
 * .responseHeaders(Map.of(
 * "responseHeadersKey", "responseHeaders"))
 * .statusCode("statusCode")
 * .templates(Map.of(
 * "templatesKey", "templates"))
 * .build();
 * ```
 */
public open class GatewayResponse(
  cdkObject: software.amazon.awscdk.services.apigateway.GatewayResponse,
) : Resource(cdkObject),
    IGatewayResponse {
  public constructor(
    scope: CloudshiftdevConstructsConstruct,
    id: String,
    props: GatewayResponseProps,
  ) :
      this(software.amazon.awscdk.services.apigateway.GatewayResponse(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
      id, props.let(GatewayResponseProps.Companion::unwrap))
  )

  public constructor(
    scope: CloudshiftdevConstructsConstruct,
    id: String,
    props: GatewayResponseProps.Builder.() -> Unit,
  ) : this(scope, id, GatewayResponseProps(props)
  )

  /**
   * A fluent builder for [io.cloudshiftdev.awscdk.services.apigateway.GatewayResponse].
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * Custom headers parameters for response.
     *
     * Default: - no headers
     *
     * @param responseHeaders Custom headers parameters for response. 
     */
    public fun responseHeaders(responseHeaders: Map)

    /**
     * Rest api resource to target.
     *
     * @param restApi Rest api resource to target. 
     */
    public fun restApi(restApi: IRestApi)

    /**
     * Http status code for response.
     *
     * Default: - standard http status code for the response type.
     *
     * @param statusCode Http status code for response. 
     */
    public fun statusCode(statusCode: String)

    /**
     * Custom templates to get mapped as response.
     *
     * Default: - Response from api will be returned without applying any transformation.
     *
     * @param templates Custom templates to get mapped as response. 
     */
    public fun templates(templates: Map)

    /**
     * Response type to associate with gateway response.
     *
     * [Documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
     * @param type Response type to associate with gateway response. 
     */
    public fun type(type: ResponseType)
  }

  private class BuilderImpl(
    scope: SoftwareConstructsConstruct,
    id: String,
  ) : Builder {
    private val cdkBuilder: software.amazon.awscdk.services.apigateway.GatewayResponse.Builder =
        software.amazon.awscdk.services.apigateway.GatewayResponse.Builder.create(scope, id)

    /**
     * Custom headers parameters for response.
     *
     * Default: - no headers
     *
     * @param responseHeaders Custom headers parameters for response. 
     */
    override fun responseHeaders(responseHeaders: Map) {
      cdkBuilder.responseHeaders(responseHeaders)
    }

    /**
     * Rest api resource to target.
     *
     * @param restApi Rest api resource to target. 
     */
    override fun restApi(restApi: IRestApi) {
      cdkBuilder.restApi(restApi.let(IRestApi.Companion::unwrap))
    }

    /**
     * Http status code for response.
     *
     * Default: - standard http status code for the response type.
     *
     * @param statusCode Http status code for response. 
     */
    override fun statusCode(statusCode: String) {
      cdkBuilder.statusCode(statusCode)
    }

    /**
     * Custom templates to get mapped as response.
     *
     * Default: - Response from api will be returned without applying any transformation.
     *
     * @param templates Custom templates to get mapped as response. 
     */
    override fun templates(templates: Map) {
      cdkBuilder.templates(templates)
    }

    /**
     * Response type to associate with gateway response.
     *
     * [Documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
     * @param type Response type to associate with gateway response. 
     */
    override fun type(type: ResponseType) {
      cdkBuilder.type(type.let(ResponseType.Companion::unwrap))
    }

    public fun build(): software.amazon.awscdk.services.apigateway.GatewayResponse =
        cdkBuilder.build()
  }

  public companion object {
    public operator fun invoke(
      scope: CloudshiftdevConstructsConstruct,
      id: String,
      block: Builder.() -> Unit = {},
    ): GatewayResponse {
      val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
      return GatewayResponse(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.services.apigateway.GatewayResponse):
        GatewayResponse = GatewayResponse(cdkObject)

    internal fun unwrap(wrapped: GatewayResponse):
        software.amazon.awscdk.services.apigateway.GatewayResponse = wrapped.cdkObject as
        software.amazon.awscdk.services.apigateway.GatewayResponse
  }
}