io.cloudshiftdev.awscdk.services.apigateway.MockIntegration.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.apigateway
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.services.iam.IRole
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* This type of integration lets API Gateway return a response without sending the request further
* to the backend.
*
* This is useful for API testing because it
* can be used to test the integration set up without incurring charges for
* using the backend and to enable collaborative development of an API. In
* collaborative development, a team can isolate their development effort by
* setting up simulations of API components owned by other teams by using the
* MOCK integrations. It is also used to return CORS-related headers to ensure
* that the API method permits CORS access. In fact, the API Gateway console
* integrates the OPTIONS method to support CORS with a mock integration.
* Gateway responses are other examples of mock integrations.
*
* Example:
*
* ```
* import path.*;
* import io.cloudshiftdev.awscdk.services.lambda.*;
* import io.cloudshiftdev.awscdk.App;
* import io.cloudshiftdev.awscdk.Stack;
* import io.cloudshiftdev.awscdk.services.apigateway.MockIntegration;
* import io.cloudshiftdev.awscdk.services.apigateway.PassthroughBehavior;
* import io.cloudshiftdev.awscdk.services.apigateway.RestApi;
* import io.cloudshiftdev.awscdk.services.apigateway.RequestAuthorizer;
* import io.cloudshiftdev.awscdk.services.apigateway.IdentitySource;
* // Against the RestApi endpoint from the stack output, run
* // `curl -s -o /dev/null -w "%{http_code}" <url>` should return 401
* // `curl -s -o /dev/null -w "%{http_code}" -H 'Authorization: deny' <url>?allow=yes` should
* return 403
* // `curl -s -o /dev/null -w "%{http_code}" -H 'Authorization: allow' <url>?allow=yes`
* should return 200
* App app = new App();
* Stack stack = new Stack(app, "RequestAuthorizerInteg");
* Function authorizerFn = Function.Builder.create(stack, "MyAuthorizerFunction")
* .runtime(Runtime.NODEJS_LATEST)
* .handler("index.handler")
* .code(AssetCode.fromAsset(join(__dirname, "integ.request-authorizer.handler")))
* .build();
* RestApi restapi = RestApi.Builder.create(stack, "MyRestApi").cloudWatchRole(true).build();
* RequestAuthorizer authorizer = RequestAuthorizer.Builder.create(stack, "MyAuthorizer")
* .handler(authorizerFn)
* .identitySources(List.of(IdentitySource.header("Authorization"),
* IdentitySource.queryString("allow")))
* .build();
* RequestAuthorizer secondAuthorizer = RequestAuthorizer.Builder.create(stack,
* "MySecondAuthorizer")
* .handler(authorizerFn)
* .identitySources(List.of(IdentitySource.header("Authorization"),
* IdentitySource.queryString("allow")))
* .build();
* restapi.root.addMethod("ANY", MockIntegration.Builder.create()
* .integrationResponses(List.of(IntegrationResponse.builder().statusCode("200").build()))
* .passthroughBehavior(PassthroughBehavior.NEVER)
* .requestTemplates(Map.of(
* "application/json", "{ \"statusCode\": 200 }"))
* .build(), MethodOptions.builder()
* .methodResponses(List.of(MethodResponse.builder().statusCode("200").build()))
* .authorizer(authorizer)
* .build());
* restapi.root.resourceForPath("auth").addMethod("ANY", MockIntegration.Builder.create()
* .integrationResponses(List.of(IntegrationResponse.builder().statusCode("200").build()))
* .passthroughBehavior(PassthroughBehavior.NEVER)
* .requestTemplates(Map.of(
* "application/json", "{ \"statusCode\": 200 }"))
* .build(), MethodOptions.builder()
* .methodResponses(List.of(MethodResponse.builder().statusCode("200").build()))
* .authorizer(secondAuthorizer)
* .build());
* ```
*/
public open class MockIntegration(
cdkObject: software.amazon.awscdk.services.apigateway.MockIntegration,
) : Integration(cdkObject) {
public constructor() : this(software.amazon.awscdk.services.apigateway.MockIntegration()
)
public constructor(options: IntegrationOptions) :
this(software.amazon.awscdk.services.apigateway.MockIntegration(options.let(IntegrationOptions.Companion::unwrap))
)
public constructor(options: IntegrationOptions.Builder.() -> Unit) :
this(IntegrationOptions(options)
)
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.apigateway.MockIntegration].
*/
@CdkDslMarker
public interface Builder {
/**
* A list of request parameters whose values are to be cached.
*
* It determines
* request parameters that will make it into the cache key.
*
* @param cacheKeyParameters A list of request parameters whose values are to be cached.
*/
public fun cacheKeyParameters(cacheKeyParameters: List)
/**
* A list of request parameters whose values are to be cached.
*
* It determines
* request parameters that will make it into the cache key.
*
* @param cacheKeyParameters A list of request parameters whose values are to be cached.
*/
public fun cacheKeyParameters(vararg cacheKeyParameters: String)
/**
* An API-specific tag group of related cached parameters.
*
* @param cacheNamespace An API-specific tag group of related cached parameters.
*/
public fun cacheNamespace(cacheNamespace: String)
/**
* The type of network connection to the integration endpoint.
*
* Default: - ConnectionType.VPC_LINK if `vpcLink` property is configured;
* ConnectionType.Internet otherwise.
*
* @param connectionType The type of network connection to the integration endpoint.
*/
public fun connectionType(connectionType: ConnectionType)
/**
* Specifies how to handle request payload content type conversions.
*
* Default: none if this property isn't defined, the request payload is passed
* through from the method request to the integration request without
* modification, provided that the `passthroughBehaviors` property is
* configured to support payload pass-through.
*
* @param contentHandling Specifies how to handle request payload content type conversions.
*/
public fun contentHandling(contentHandling: ContentHandling)
/**
* Requires that the caller's identity be passed through from the request.
*
* Default: Caller identity is not passed through
*
* @param credentialsPassthrough Requires that the caller's identity be passed through from the
* request.
*/
public fun credentialsPassthrough(credentialsPassthrough: Boolean)
/**
* An IAM role that API Gateway assumes.
*
* Mutually exclusive with `credentialsPassThrough`.
*
* Default: A role is not assumed
*
* @param credentialsRole An IAM role that API Gateway assumes.
*/
public fun credentialsRole(credentialsRole: IRole)
/**
* The response that API Gateway provides after a method's backend completes processing a
* request.
*
* API Gateway intercepts the response from the
* backend so that you can control how API Gateway surfaces backend
* responses. For example, you can map the backend status codes to codes
* that you define.
*
* @param integrationResponses The response that API Gateway provides after a method's backend
* completes processing a request.
*/
public fun integrationResponses(integrationResponses: List)
/**
* The response that API Gateway provides after a method's backend completes processing a
* request.
*
* API Gateway intercepts the response from the
* backend so that you can control how API Gateway surfaces backend
* responses. For example, you can map the backend status codes to codes
* that you define.
*
* @param integrationResponses The response that API Gateway provides after a method's backend
* completes processing a request.
*/
public fun integrationResponses(vararg integrationResponses: IntegrationResponse)
/**
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in
* the request, and the available mapping templates specified as the requestTemplates property on
* the Integration resource.
*
* There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
* NEVER.
*
* @param passthroughBehavior Specifies the pass-through behavior for incoming requests based on
* the Content-Type header in the request, and the available mapping templates specified as the
* requestTemplates property on the Integration resource.
*/
public fun passthroughBehavior(passthroughBehavior: PassthroughBehavior)
/**
* The request parameters that API Gateway sends with the backend request.
*
* Specify request parameters as key-value pairs (string-to-string
* mappings), with a destination as the key and a source as the value.
*
* Specify the destination by using the following pattern
* integration.request.location.name, where location is querystring, path,
* or header, and name is a valid, unique parameter name.
*
* The source must be an existing method request parameter or a static
* value. You must enclose static values in single quotation marks and
* pre-encode these values based on their destination in the request.
*
* @param requestParameters The request parameters that API Gateway sends with the backend
* request.
*/
public fun requestParameters(requestParameters: Map)
/**
* A map of Apache Velocity templates that are applied on the request payload.
*
* The template that API Gateway uses is based on the value of the
* Content-Type header that's sent by the client. The content type value is
* the key, and the template is the value (specified as a string), such as
* the following snippet:
*
* ```
* { "application/json": "{ \"statusCode\": 200 }" }
* ```
*
* [Documentation](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html)
* @param requestTemplates A map of Apache Velocity templates that are applied on the request
* payload.
*/
public fun requestTemplates(requestTemplates: Map)
/**
* The maximum amount of time an integration will run before it returns without a response.
*
* By default, the value must be between 50 milliseconds and 29 seconds.
* The upper bound can be increased for regional and private Rest APIs only,
* via a quota increase request for your acccount.
* This increase might require a reduction in your account-level throttle quota limit.
* See [https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html Amazon API
* Gateway quotas] for more details.
*
* Default: Duration.seconds(29)
*
* @param timeout The maximum amount of time an integration will run before it returns without a
* response.
*/
public fun timeout(timeout: Duration)
/**
* The VpcLink used for the integration.
*
* Required if connectionType is VPC_LINK
*
* @param vpcLink The VpcLink used for the integration.
*/
public fun vpcLink(vpcLink: IVpcLink)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.apigateway.MockIntegration.Builder =
software.amazon.awscdk.services.apigateway.MockIntegration.Builder.create()
/**
* A list of request parameters whose values are to be cached.
*
* It determines
* request parameters that will make it into the cache key.
*
* @param cacheKeyParameters A list of request parameters whose values are to be cached.
*/
override fun cacheKeyParameters(cacheKeyParameters: List) {
cdkBuilder.cacheKeyParameters(cacheKeyParameters)
}
/**
* A list of request parameters whose values are to be cached.
*
* It determines
* request parameters that will make it into the cache key.
*
* @param cacheKeyParameters A list of request parameters whose values are to be cached.
*/
override fun cacheKeyParameters(vararg cacheKeyParameters: String): Unit =
cacheKeyParameters(cacheKeyParameters.toList())
/**
* An API-specific tag group of related cached parameters.
*
* @param cacheNamespace An API-specific tag group of related cached parameters.
*/
override fun cacheNamespace(cacheNamespace: String) {
cdkBuilder.cacheNamespace(cacheNamespace)
}
/**
* The type of network connection to the integration endpoint.
*
* Default: - ConnectionType.VPC_LINK if `vpcLink` property is configured;
* ConnectionType.Internet otherwise.
*
* @param connectionType The type of network connection to the integration endpoint.
*/
override fun connectionType(connectionType: ConnectionType) {
cdkBuilder.connectionType(connectionType.let(ConnectionType.Companion::unwrap))
}
/**
* Specifies how to handle request payload content type conversions.
*
* Default: none if this property isn't defined, the request payload is passed
* through from the method request to the integration request without
* modification, provided that the `passthroughBehaviors` property is
* configured to support payload pass-through.
*
* @param contentHandling Specifies how to handle request payload content type conversions.
*/
override fun contentHandling(contentHandling: ContentHandling) {
cdkBuilder.contentHandling(contentHandling.let(ContentHandling.Companion::unwrap))
}
/**
* Requires that the caller's identity be passed through from the request.
*
* Default: Caller identity is not passed through
*
* @param credentialsPassthrough Requires that the caller's identity be passed through from the
* request.
*/
override fun credentialsPassthrough(credentialsPassthrough: Boolean) {
cdkBuilder.credentialsPassthrough(credentialsPassthrough)
}
/**
* An IAM role that API Gateway assumes.
*
* Mutually exclusive with `credentialsPassThrough`.
*
* Default: A role is not assumed
*
* @param credentialsRole An IAM role that API Gateway assumes.
*/
override fun credentialsRole(credentialsRole: IRole) {
cdkBuilder.credentialsRole(credentialsRole.let(IRole.Companion::unwrap))
}
/**
* The response that API Gateway provides after a method's backend completes processing a
* request.
*
* API Gateway intercepts the response from the
* backend so that you can control how API Gateway surfaces backend
* responses. For example, you can map the backend status codes to codes
* that you define.
*
* @param integrationResponses The response that API Gateway provides after a method's backend
* completes processing a request.
*/
override fun integrationResponses(integrationResponses: List) {
cdkBuilder.integrationResponses(integrationResponses.map(IntegrationResponse.Companion::unwrap))
}
/**
* The response that API Gateway provides after a method's backend completes processing a
* request.
*
* API Gateway intercepts the response from the
* backend so that you can control how API Gateway surfaces backend
* responses. For example, you can map the backend status codes to codes
* that you define.
*
* @param integrationResponses The response that API Gateway provides after a method's backend
* completes processing a request.
*/
override fun integrationResponses(vararg integrationResponses: IntegrationResponse): Unit =
integrationResponses(integrationResponses.toList())
/**
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in
* the request, and the available mapping templates specified as the requestTemplates property on
* the Integration resource.
*
* There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
* NEVER.
*
* @param passthroughBehavior Specifies the pass-through behavior for incoming requests based on
* the Content-Type header in the request, and the available mapping templates specified as the
* requestTemplates property on the Integration resource.
*/
override fun passthroughBehavior(passthroughBehavior: PassthroughBehavior) {
cdkBuilder.passthroughBehavior(passthroughBehavior.let(PassthroughBehavior.Companion::unwrap))
}
/**
* The request parameters that API Gateway sends with the backend request.
*
* Specify request parameters as key-value pairs (string-to-string
* mappings), with a destination as the key and a source as the value.
*
* Specify the destination by using the following pattern
* integration.request.location.name, where location is querystring, path,
* or header, and name is a valid, unique parameter name.
*
* The source must be an existing method request parameter or a static
* value. You must enclose static values in single quotation marks and
* pre-encode these values based on their destination in the request.
*
* @param requestParameters The request parameters that API Gateway sends with the backend
* request.
*/
override fun requestParameters(requestParameters: Map) {
cdkBuilder.requestParameters(requestParameters)
}
/**
* A map of Apache Velocity templates that are applied on the request payload.
*
* The template that API Gateway uses is based on the value of the
* Content-Type header that's sent by the client. The content type value is
* the key, and the template is the value (specified as a string), such as
* the following snippet:
*
* ```
* { "application/json": "{ \"statusCode\": 200 }" }
* ```
*
* [Documentation](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html)
* @param requestTemplates A map of Apache Velocity templates that are applied on the request
* payload.
*/
override fun requestTemplates(requestTemplates: Map) {
cdkBuilder.requestTemplates(requestTemplates)
}
/**
* The maximum amount of time an integration will run before it returns without a response.
*
* By default, the value must be between 50 milliseconds and 29 seconds.
* The upper bound can be increased for regional and private Rest APIs only,
* via a quota increase request for your acccount.
* This increase might require a reduction in your account-level throttle quota limit.
* See [https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html Amazon API
* Gateway quotas] for more details.
*
* Default: Duration.seconds(29)
*
* @param timeout The maximum amount of time an integration will run before it returns without a
* response.
*/
override fun timeout(timeout: Duration) {
cdkBuilder.timeout(timeout.let(Duration.Companion::unwrap))
}
/**
* The VpcLink used for the integration.
*
* Required if connectionType is VPC_LINK
*
* @param vpcLink The VpcLink used for the integration.
*/
override fun vpcLink(vpcLink: IVpcLink) {
cdkBuilder.vpcLink(vpcLink.let(IVpcLink.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.apigateway.MockIntegration =
cdkBuilder.build()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): MockIntegration {
val builderImpl = BuilderImpl()
return MockIntegration(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.apigateway.MockIntegration):
MockIntegration = MockIntegration(cdkObject)
internal fun unwrap(wrapped: MockIntegration):
software.amazon.awscdk.services.apigateway.MockIntegration = wrapped.cdkObject as
software.amazon.awscdk.services.apigateway.MockIntegration
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy