Class HttpIntegrationProps

Inheritance

System.Object

HttpIntegrationProps

Implements

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class HttpIntegrationProps : Object, IHttpIntegrationProps

Syntax (vb)

Public Class HttpIntegrationProps
    Inherits Object
    Implements IHttpIntegrationProps

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 httpIntegrationProps = new HttpIntegrationProps {
    HttpMethod = "httpMethod",
    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
    },
    Proxy = false
};

Synopsis

Constructors

HttpIntegrationProps()

Properties

HttpMethod	HTTP method to use when invoking the backend URL.
Options	Integration options, such as request/resopnse mapping, content handling, etc.
Proxy	Determines whether to use proxy integration or custom integration.

Constructors

HttpIntegrationProps()

public HttpIntegrationProps()

Properties

HttpMethod

HTTP method to use when invoking the backend URL.

public string HttpMethod { get; set; }

Property Value

System.String

Remarks

Default: GET

Options

Integration options, such as request/resopnse mapping, content handling, etc.

public IIntegrationOptions Options { get; set; }

Property Value

IIntegrationOptions

Remarks

Default: defaults based on IntegrationOptions defaults

Proxy

Determines whether to use proxy integration or custom integration.

public Nullable<bool> Proxy { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

Implements

IHttpIntegrationProps