Interface ICfnMethodProps

Properties for defining a CfnMethod.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMethodProps

Syntax (vb)

Public Interface ICfnMethodProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

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.APIGateway;

var cfnMethodProps = new CfnMethodProps {
    HttpMethod = "httpMethod",
    ResourceId = "resourceId",
    RestApiId = "restApiId",

    // the properties below are optional
    ApiKeyRequired = false,
    AuthorizationScopes = new [] { "authorizationScopes" },
    AuthorizationType = "authorizationType",
    AuthorizerId = "authorizerId",
    Integration = new IntegrationProperty {
        CacheKeyParameters = new [] { "cacheKeyParameters" },
        CacheNamespace = "cacheNamespace",
        ConnectionId = "connectionId",
        ConnectionType = "connectionType",
        ContentHandling = "contentHandling",
        Credentials = "credentials",
        IntegrationHttpMethod = "integrationHttpMethod",
        IntegrationResponses = new [] { new IntegrationResponseProperty {
            StatusCode = "statusCode",

            // the properties below are optional
            ContentHandling = "contentHandling",
            ResponseParameters = new Dictionary<string, string> {
                { "responseParametersKey", "responseParameters" }
            },
            ResponseTemplates = new Dictionary<string, string> {
                { "responseTemplatesKey", "responseTemplates" }
            },
            SelectionPattern = "selectionPattern"
        } },
        PassthroughBehavior = "passthroughBehavior",
        RequestParameters = new Dictionary<string, string> {
            { "requestParametersKey", "requestParameters" }
        },
        RequestTemplates = new Dictionary<string, string> {
            { "requestTemplatesKey", "requestTemplates" }
        },
        TimeoutInMillis = 123,
        Type = "type",
        Uri = "uri"
    },
    MethodResponses = new [] { new MethodResponseProperty {
        StatusCode = "statusCode",

        // the properties below are optional
        ResponseModels = new Dictionary<string, string> {
            { "responseModelsKey", "responseModels" }
        },
        ResponseParameters = new Dictionary<string, object> {
            { "responseParametersKey", false }
        }
    } },
    OperationName = "operationName",
    RequestModels = new Dictionary<string, string> {
        { "requestModelsKey", "requestModels" }
    },
    RequestParameters = new Dictionary<string, object> {
        { "requestParametersKey", false }
    },
    RequestValidatorId = "requestValidatorId"
};

Synopsis

Properties

ApiKeyRequired	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
AuthorizationScopes	A list of authorization scopes configured on the method.
AuthorizationType	The method's authorization type.
AuthorizerId	The identifier of an authorizer to use on this method.
HttpMethod	The method's HTTP verb.
Integration	Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
MethodResponses	Gets a method response associated with a given HTTP status code.
OperationName	A human-friendly operation identifier for the method.
RequestModels	A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
RequestParameters	A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
RequestValidatorId	The identifier of a RequestValidator for request validation.
ResourceId	The Resource identifier for the MethodResponse resource.
RestApiId	The string identifier of the associated RestApi.

Properties

ApiKeyRequired

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

virtual object ApiKeyRequired { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired

AuthorizationScopes

A list of authorization scopes configured on the method.

virtual string[] AuthorizationScopes { get; }

Property Value

System.String[]

Remarks

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes

AuthorizationType

The method's authorization type.

virtual string AuthorizationType { get; }

Property Value

System.String

Remarks

This parameter is required. For valid values, see Method in the API Gateway API Reference .

If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype

AuthorizerId

The identifier of an authorizer to use on this method.

virtual string AuthorizerId { get; }

Property Value

System.String

Remarks

The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid

HttpMethod

The method's HTTP verb.

string HttpMethod { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod

Integration

Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

virtual object Integration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration

MethodResponses

Gets a method response associated with a given HTTP status code.

virtual object MethodResponses { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses

OperationName

A human-friendly operation identifier for the method.

virtual string OperationName { get; }

Property Value

System.String

Remarks

For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname

RequestModels

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

virtual object RequestModels { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels

RequestParameters

A key-value map defining required or optional method request parameters that can be accepted by API Gateway.

virtual object RequestParameters { get; }

Property Value

System.Object

Remarks

A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters

RequestValidatorId

The identifier of a RequestValidator for request validation.

virtual string RequestValidatorId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid

ResourceId

The Resource identifier for the MethodResponse resource.

string ResourceId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid

RestApiId

The string identifier of the associated RestApi.

string RestApiId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid