Skip to content
v2.278.0

HttpIntegrationProps Struct ​

Example ​

ts
declare const resource: apigateway.Resource;

// Without auto-configuration (manual setup required)
resource.addProxy({
  defaultIntegration: new apigateway.HttpIntegration('http://example.com/api/{proxy}', {
    options: {
      requestParameters: {
        'integration.request.path.proxy': 'method.request.path.proxy'
      }
    }
  }),
  defaultMethodOptions: {
    requestParameters: {
      'method.request.path.proxy': true
    }
  }
});

// With auto-configuration (simpler)
resource.addProxy({
  autoConfigurePathParameter: true,
  defaultIntegration: new apigateway.HttpIntegration('http://example.com/api/{proxy}')
});
python
# resource: apigateway.Resource


# Without auto-configuration (manual setup required)
resource.add_proxy(
    default_integration=apigateway.HttpIntegration("http://example.com/api/{proxy}",
        options=apigateway.IntegrationOptions(
            request_parameters={
                "integration.request.path.proxy": "method.request.path.proxy"
            }
        )
    ),
    default_method_options=apigateway.MethodOptions(
        request_parameters={
            "method.request.path.proxy": True
        }
    )
)

# With auto-configuration (simpler)
resource.add_proxy(
    auto_configure_path_parameter=True,
    default_integration=apigateway.HttpIntegration("http://example.com/api/{proxy}")
)
java
Resource resource;


// Without auto-configuration (manual setup required)
resource.addProxy(ProxyResourceOptions.builder()
        .defaultIntegration(HttpIntegration.Builder.create("http://example.com/api/{proxy}")
                .options(IntegrationOptions.builder()
                        .requestParameters(Map.of(
                                "integration.request.path.proxy", "method.request.path.proxy"))
                        .build())
                .build())
        .defaultMethodOptions(MethodOptions.builder()
                .requestParameters(Map.of(
                        "method.request.path.proxy", true))
                .build())
        .build());

// With auto-configuration (simpler)
resource.addProxy(ProxyResourceOptions.builder()
        .autoConfigurePathParameter(true)
        .defaultIntegration(new HttpIntegration("http://example.com/api/{proxy}"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Resource resource;


// Without auto-configuration (manual setup required)
resource.AddProxy(new ProxyResourceOptions {
    DefaultIntegration = new HttpIntegration("http://example.com/api/{proxy}", new HttpIntegrationProps {
        Options = new IntegrationOptions {
            RequestParameters = new Dictionary<string, string> {
                { "integration.request.path.proxy", "method.request.path.proxy" }
            }
        }
    }),
    DefaultMethodOptions = new MethodOptions {
        RequestParameters = new Dictionary<string, boolean> {
            { "method.request.path.proxy", true }
        }
    }
});

// With auto-configuration (simpler)
resource.AddProxy(new ProxyResourceOptions {
    AutoConfigurePathParameter = true,
    DefaultIntegration = new HttpIntegration("http://example.com/api/{proxy}")
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var resource Resource


// Without auto-configuration (manual setup required)
resource.AddProxy(&ProxyResourceOptions{
	DefaultIntegration: apigateway.NewHttpIntegration(jsii.String("http://example.com/api/{proxy}"), &HttpIntegrationProps{
		Options: &IntegrationOptions{
			RequestParameters: map[string]*string{
				"integration.request.path.proxy": jsii.String("method.request.path.proxy"),
			},
		},
	}),
	DefaultMethodOptions: &MethodOptions{
		RequestParameters: map[string]*bool{
			"method.request.path.proxy": jsii.Boolean(true),
		},
	},
})

// With auto-configuration (simpler)
resource.AddProxy(&ProxyResourceOptions{
	AutoConfigurePathParameter: jsii.Boolean(true),
	DefaultIntegration: apigateway.NewHttpIntegration(jsii.String("http://example.com/api/{proxy}")),
})

Properties ​

httpMethodoptionalstringhttp_methodoptionalstrhttpMethodoptionalStringHttpMethodoptionalstringHttpMethodoptional*string = GET #
HTTP method to use when invoking the backend URL.
optionsoptionalIntegrationOptionsoptionsoptionalIntegrationOptionsoptionsoptionalIntegrationOptionsOptionsoptionalIntegrationOptionsOptionsoptionalIntegrationOptions #
Integration options, such as request/resopnse mapping, content handling, etc.

Default: defaults based on IntegrationOptions defaults

proxyoptionalbooleanproxyoptionalboolproxyoptionalBooleanProxyoptionalboolProxyoptional*bool = true #
Determines whether to use proxy integration or custom integration.