Interface IWebSocketRouteIntegrationConfig
Config returned back as a result of the bind.
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IWebSocketRouteIntegrationConfig
Syntax (vb)
Public Interface IWebSocketRouteIntegrationConfig
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;
using Amazon.CDK.AWS.Apigatewayv2;
using Amazon.CDK.AWS.IAM;
Role role;
var webSocketRouteIntegrationConfig = new WebSocketRouteIntegrationConfig {
Type = WebSocketIntegrationType.AWS_PROXY,
Uri = "uri",
// the properties below are optional
ContentHandling = ContentHandling.CONVERT_TO_BINARY,
CredentialsRole = role,
Method = "method",
PassthroughBehavior = PassthroughBehavior.WHEN_NO_MATCH,
RequestParameters = new Dictionary<string, string> {
{ "requestParametersKey", "requestParameters" }
},
RequestTemplates = new Dictionary<string, string> {
{ "requestTemplatesKey", "requestTemplates" }
},
TemplateSelectionExpression = "templateSelectionExpression",
Timeout = Duration.Minutes(30)
};
Synopsis
Properties
ContentHandling | Specifies how to handle response payload content type conversions. |
CredentialsRole | Credentials role. |
Method | Integration method. |
PassthroughBehavior | Integration passthrough behaviors. |
RequestParameters | Request parameters. |
RequestTemplates | Request template. |
TemplateSelectionExpression | Template selection expression. |
Timeout | The maximum amount of time an integration will run before it returns without a response. |
Type | Integration type. |
Uri | Integration URI. |
Properties
ContentHandling
Specifies how to handle response payload content type conversions.
virtual Nullable<ContentHandling> ContentHandling { get; }
Property Value
System.Nullable<ContentHandling>
Remarks
Default: - The response payload will be passed through from the integration response to the route response or method response without modification.
CredentialsRole
Credentials role.
virtual IRole CredentialsRole { get; }
Property Value
Remarks
Default: - No role provided.
Method
Integration method.
virtual string Method { get; }
Property Value
System.String
Remarks
Default: - No integration method.
PassthroughBehavior
Integration passthrough behaviors.
virtual Nullable<PassthroughBehavior> PassthroughBehavior { get; }
Property Value
System.Nullable<PassthroughBehavior>
Remarks
Default: - No pass through bahavior.
RequestParameters
Request parameters.
virtual IDictionary<string, string> RequestParameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No request parameters provided.
RequestTemplates
Request template.
virtual IDictionary<string, string> RequestTemplates { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No request template provided.
TemplateSelectionExpression
Template selection expression.
virtual string TemplateSelectionExpression { get; }
Property Value
System.String
Remarks
Default: - No template selection expression.
Timeout
The maximum amount of time an integration will run before it returns without a response.
virtual Duration Timeout { get; }
Property Value
Remarks
Must be between 50 milliseconds and 29 seconds.
Default: Duration.seconds(29)
Type
Uri
Integration URI.
string Uri { get; }
Property Value
System.String