Interface IIntegrationConfig

Result of binding an Integration to a Method.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IIntegrationConfig

Syntax (vb)

Public Interface IIntegrationConfig

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.APIGateway;
using Amazon.CDK.AWS.IAM;

Role role;
VpcLink vpcLink;

var integrationConfig = new IntegrationConfig {
    Type = IntegrationType.AWS,

    // the properties below are optional
    DeploymentToken = "deploymentToken",
    IntegrationHttpMethod = "integrationHttpMethod",
    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
    },
    Uri = "uri"
};

Synopsis

Properties

DeploymentToken	This value is included in computing the Deployment's fingerprint.
IntegrationHttpMethod	The integration's HTTP method type.
Options	Integration options.
Type	Specifies an API method integration type.
Uri	The Uniform Resource Identifier (URI) for the integration.

Properties

DeploymentToken

This value is included in computing the Deployment's fingerprint.

virtual string DeploymentToken { get; }

Property Value

System.String

Remarks

When the fingerprint changes, a new deployment is triggered. This property should contain values associated with the Integration that upon changing should trigger a fresh the Deployment needs to be refreshed.

Default: undefined deployments are not triggered for any change to this integration.

IntegrationHttpMethod

The integration's HTTP method type.

virtual string IntegrationHttpMethod { get; }

Property Value

System.String

Remarks

Required unless you use a MOCK integration.

Default: - no integration method specified.

Options

Integration options.

virtual IIntegrationOptions Options { get; }

Property Value

IIntegrationOptions

Remarks

Default: - no integration options

Type

Specifies an API method integration type.

IntegrationType Type { get; }

Property Value

IntegrationType

Uri

The Uniform Resource Identifier (URI) for the integration.

virtual string Uri { get; }

Property Value

System.String

Remarks

Default: - no URI. Usually applies to MOCK integration

See: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri