Class CfnIntegration
The AWS::ApiGatewayV2::Integration
resource creates an integration for an API.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIntegration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnIntegration
Inherits CfnResource
Implements IInspectable
Remarks
CloudformationResource: AWS::ApiGatewayV2::Integration
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 requestParameters;
var requestTemplates;
var responseParameters;
var cfnIntegration = new CfnIntegration(this, "MyCfnIntegration", new CfnIntegrationProps {
ApiId = "apiId",
IntegrationType = "integrationType",
// the properties below are optional
ConnectionId = "connectionId",
ConnectionType = "connectionType",
ContentHandlingStrategy = "contentHandlingStrategy",
CredentialsArn = "credentialsArn",
Description = "description",
IntegrationMethod = "integrationMethod",
IntegrationSubtype = "integrationSubtype",
IntegrationUri = "integrationUri",
PassthroughBehavior = "passthroughBehavior",
PayloadFormatVersion = "payloadFormatVersion",
RequestParameters = requestParameters,
RequestTemplates = requestTemplates,
ResponseParameters = responseParameters,
TemplateSelectionExpression = "templateSelectionExpression",
TimeoutInMillis = 123,
TlsConfig = new TlsConfigProperty {
ServerNameToVerify = "serverNameToVerify"
}
});
Synopsis
Constructors
CfnIntegration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIntegration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIntegration(Construct, String, ICfnIntegrationProps) |
Properties
ApiId | The API identifier. |
AttrId | The identifier. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConnectionId | The ID of the VPC link for a private integration. |
ConnectionType | The type of the network connection to the integration endpoint. |
ContentHandlingStrategy | Supported only for WebSocket APIs. |
CredentialsArn | Specifies the credentials required for the integration, if any. |
Description | The description of the integration. |
IntegrationMethod | Specifies the integration's HTTP method type. |
IntegrationSubtype | Supported only for HTTP API |
IntegrationType | The integration type of an integration. |
IntegrationUri | For a Lambda integration, specify the URI of a Lambda function. |
PassthroughBehavior | Specifies the pass-through behavior for incoming requests based on the |
PayloadFormatVersion | Specifies the format of the payload sent to an integration. |
RequestParameters | For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. |
RequestTemplates | Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. |
ResponseParameters | Supported only for HTTP APIs. |
TemplateSelectionExpression | The template selection expression for the integration. |
TimeoutInMillis | Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. |
TlsConfig | The TLS configuration for a private integration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIntegration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIntegration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIntegration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIntegration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIntegration(Construct, String, ICfnIntegrationProps)
public CfnIntegration(Construct scope, string id, ICfnIntegrationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnIntegrationProps
Resource properties.
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
AttrId
The identifier.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
ConnectionId
The ID of the VPC link for a private integration.
public virtual string ConnectionId { get; set; }
Property Value
System.String
ConnectionType
The type of the network connection to the integration endpoint.
public virtual string ConnectionType { get; set; }
Property Value
System.String
ContentHandlingStrategy
Supported only for WebSocket APIs.
public virtual string ContentHandlingStrategy { get; set; }
Property Value
System.String
CredentialsArn
Specifies the credentials required for the integration, if any.
public virtual string CredentialsArn { get; set; }
Property Value
System.String
Description
The description of the integration.
public virtual string Description { get; set; }
Property Value
System.String
IntegrationMethod
Specifies the integration's HTTP method type.
public virtual string IntegrationMethod { get; set; }
Property Value
System.String
IntegrationSubtype
Supported only for HTTP API AWS_PROXY
integrations.
public virtual string IntegrationSubtype { get; set; }
Property Value
System.String
IntegrationType
The integration type of an integration.
public virtual string IntegrationType { get; set; }
Property Value
System.String
Remarks
One of the following:.
IntegrationUri
For a Lambda integration, specify the URI of a Lambda function.
public virtual string IntegrationUri { get; set; }
Property Value
System.String
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 virtual string PassthroughBehavior { get; set; }
Property Value
System.String
PayloadFormatVersion
Specifies the format of the payload sent to an integration.
public virtual string PayloadFormatVersion { get; set; }
Property Value
System.String
RequestParameters
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
public virtual object RequestParameters { get; set; }
Property Value
System.Object
RequestTemplates
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
public virtual object RequestTemplates { get; set; }
Property Value
System.Object
ResponseParameters
Supported only for HTTP APIs.
public virtual object ResponseParameters { get; set; }
Property Value
System.Object
TemplateSelectionExpression
The template selection expression for the integration.
public virtual string TemplateSelectionExpression { get; set; }
Property Value
System.String
TimeoutInMillis
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
public virtual Nullable<double> TimeoutInMillis { get; set; }
Property Value
System.Nullable<System.Double>
TlsConfig
The TLS configuration for a private integration.
public virtual object TlsConfig { get; set; }
Property Value
System.Object
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>