Class IntegrationConfig

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Result of binding an Integration to a Method.

public class IntegrationConfig : IIntegrationConfig

Inheritance

object

IntegrationConfig

Implements

IIntegrationConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 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"
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

IntegrationConfig()

public IntegrationConfig()

Properties

DeploymentToken

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

public string? DeploymentToken { get; set; }

Property Value

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.

public string? IntegrationHttpMethod { get; set; }

Property Value

string

Remarks

Default: - no integration method specified.

Options

Integration options.

public IIntegrationOptions? Options { get; set; }

Property Value

IIntegrationOptions

Remarks

Default: - no integration options

Type

Specifies an API method integration type.

public IntegrationType Type { get; set; }

Property Value

IntegrationType

Uri

The Uniform Resource Identifier (URI) for the integration.

public string? Uri { get; set; }

Property Value

string

Remarks

Default: - no URI. Usually applies to MOCK integration

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