Class CfnIntegrationResponse
A CloudFormation AWS::ApiGatewayV2::IntegrationResponse
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnIntegrationResponse : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIntegrationResponse
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::IntegrationResponse
resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide .
CloudformationResource: AWS::ApiGatewayV2::IntegrationResponse
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.APIGatewayv2;
var responseParameters;
var responseTemplates;
var cfnIntegrationResponse = new CfnIntegrationResponse(this, "MyCfnIntegrationResponse", new CfnIntegrationResponseProps {
ApiId = "apiId",
IntegrationId = "integrationId",
IntegrationResponseKey = "integrationResponseKey",
// the properties below are optional
ContentHandlingStrategy = "contentHandlingStrategy",
ResponseParameters = responseParameters,
ResponseTemplates = responseTemplates,
TemplateSelectionExpression = "templateSelectionExpression"
});
Synopsis
Constructors
CfnIntegrationResponse(Construct, String, ICfnIntegrationResponseProps) | Create a new |
CfnIntegrationResponse(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIntegrationResponse(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The API identifier. |
AttrIntegrationResponseId | The integration response ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContentHandlingStrategy | Supported only for WebSocket APIs. |
IntegrationId | The integration ID. |
IntegrationResponseKey | The integration response key. |
ResponseParameters | A key-value map specifying response parameters that are passed to the method response from the backend. |
ResponseTemplates | The collection of response templates for the integration response as a string-to-string map of key-value pairs. |
TemplateSelectionExpression | The template selection expression for the integration response. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIntegrationResponse(Construct, String, ICfnIntegrationResponseProps)
Create a new AWS::ApiGatewayV2::IntegrationResponse
.
public CfnIntegrationResponse(Construct scope, string id, ICfnIntegrationResponseProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnIntegrationResponseProps
- resource properties.
CfnIntegrationResponse(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIntegrationResponse(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIntegrationResponse(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIntegrationResponse(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
AttrIntegrationResponseId
The integration response ID.
public virtual string AttrIntegrationResponseId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IntegrationResponseId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContentHandlingStrategy
Supported only for WebSocket APIs.
public virtual string ContentHandlingStrategy { get; set; }
Property Value
System.String
Remarks
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IntegrationId
The integration ID.
public virtual string IntegrationId { get; set; }
Property Value
System.String
Remarks
IntegrationResponseKey
The integration response key.
public virtual string IntegrationResponseKey { get; set; }
Property Value
System.String
Remarks
ResponseParameters
A key-value map specifying response parameters that are passed to the method response from the backend.
public virtual object ResponseParameters { get; set; }
Property Value
System.Object
Remarks
The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header. {name}
, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header. {name}
or integration.response.body. {JSON-expression}
, where {name}
is a valid and unique response header name and {JSON-expression}
is a valid JSON expression without the $
prefix.
ResponseTemplates
The collection of response templates for the integration response as a string-to-string map of key-value pairs.
public virtual object ResponseTemplates { get; set; }
Property Value
System.Object
Remarks
Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
TemplateSelectionExpression
The template selection expression for the integration response.
public virtual string TemplateSelectionExpression { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>