Interface IHttpIntegrationProps
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public interface IHttpIntegrationProps
Syntax (vb)
Public Interface IHttpIntegrationProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK;
Role role;
VpcLink vpcLink;
var httpIntegrationProps = new HttpIntegrationProps {
HttpMethod = "httpMethod",
Options = new IntegrationOptions {
CacheKeyParameters = new [] { "cacheKeyParameters" },
CacheNamespace = "cacheNamespace",
ConnectionType = ConnectionType.INTERNET,
ContentHandling = ContentHandling.CONVERT_TO_BINARY,
CredentialsPassthrough = false,
CredentialsRole = role,
IntegrationResponses = new [] { new IntegrationResponse {
StatusCode = "statusCode",
// the properties below are optional
ContentHandling = ContentHandling.CONVERT_TO_BINARY,
ResponseParameters = new Dictionary<string, string> {
{ "responseParametersKey", "responseParameters" }
},
ResponseTemplates = new Dictionary<string, string> {
{ "responseTemplatesKey", "responseTemplates" }
},
SelectionPattern = "selectionPattern"
} },
PassthroughBehavior = PassthroughBehavior.WHEN_NO_MATCH,
RequestParameters = new Dictionary<string, string> {
{ "requestParametersKey", "requestParameters" }
},
RequestTemplates = new Dictionary<string, string> {
{ "requestTemplatesKey", "requestTemplates" }
},
Timeout = Duration.Minutes(30),
VpcLink = vpcLink
},
Proxy = false
};
Synopsis
Properties
HttpMethod | HTTP method to use when invoking the backend URL. |
Options | Integration options, such as request/resopnse mapping, content handling, etc. |
Proxy | Determines whether to use proxy integration or custom integration. |
Properties
HttpMethod
HTTP method to use when invoking the backend URL.
virtual string HttpMethod { get; }
Property Value
System.String
Remarks
Default: GET
Options
Integration options, such as request/resopnse mapping, content handling, etc.
virtual IIntegrationOptions Options { get; }
Property Value
Remarks
Default: defaults based on IntegrationOptions
defaults
Proxy
Determines whether to use proxy integration or custom integration.
virtual Nullable<bool> Proxy { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true