import { Value } from '../../cloudformation/Value';
import { IntegrationProps } from './method/IntegrationProps';
import { MethodResponseProps } from './method/MethodResponseProps';
import { AwsResource } from '../../cloudformation/resources/AwsResource';
/**
  The <code>AWS::ApiGateway::Method</code> resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html">the AWS Docs</a>
*/
export type Method = AwsResource<'AWS::ApiGateway::Method', MethodProperties>;
export declare function method(methodProps: MethodProperties): Method;
/**
  The <code>AWS::ApiGateway::Method</code> resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html">the AWS Docs</a>
*/
export interface MethodProperties {
    /** <code>ApiKeyRequired</code>  <a name="cfn-apigateway-method-apikeyrequired"></a>
  A boolean flag specifying whether a valid ApiKey is required to invoke this method.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    apiKeyRequired?: Value<boolean>;
    /** <code>AuthorizationScopes</code>  <a name="cfn-apigateway-method-authorizationscopes"></a>
  A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    authorizationScopes?: Value<Value<string>[]>;
    /** <code>AuthorizationType</code>  <a name="cfn-apigateway-method-authorizationtype"></a>
  The method’s authorization type. This parameter is required. For valid values, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html">Method</a> in the
  API Gateway API Reference: br />
  If you specify the <code>AuthorizerId</code> property, specify <code>CUSTOM</code> or <code>COGNITO_USER_POOLS</code> for this property.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    authorizationType?: Value<string>;
    /** <code>AuthorizerId</code>  <a name="cfn-apigateway-method-authorizerid"></a>
  The identifier of an authorizer to use on this method. The method’s authorization type must be <code>CUSTOM</code> or <code>COGNITO_USER_POOLS</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    authorizerId?: Value<string>;
    /** <code>HttpMethod</code>  <a name="cfn-apigateway-method-httpmethod"></a>
  The method’s HTTP verb.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    httpMethod: Value<string>;
    /** <code>Integration</code>  <a name="cfn-apigateway-method-integration"></a>
  Represents an <code>HTTP</code>, <code>HTTP_PROXY</code>, <code>AWS</code>, <code>AWS_PROXY</code>, or Mock integration.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    integration?: IntegrationProps;
    /** <code>MethodResponses</code>  <a name="cfn-apigateway-method-methodresponses"></a>
  Gets a method response associated with a given HTTP status code.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    methodResponses?: MethodResponseProps[];
    /** <code>OperationName</code>  <a name="cfn-apigateway-method-operationname"></a>
  A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    operationName?: Value<string>;
    /** <code>RequestModels</code>  <a name="cfn-apigateway-method-requestmodels"></a>
  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).<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    requestModels?: Value<{
        [key: string]: Value<string>;
    }>;
    /** <code>RequestParameters</code>  <a name="cfn-apigateway-method-requestparameters"></a>
  A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    requestParameters?: Value<{
        [key: string]: Value<boolean>;
    }>;
    /** <code>RequestValidatorId</code>  <a name="cfn-apigateway-method-requestvalidatorid"></a>
  The identifier of a RequestValidator for request validation.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    requestValidatorId?: Value<string>;
    /** <code>ResourceId</code>  <a name="cfn-apigateway-method-resourceid"></a>
  The Resource identifier for the MethodResponse resource.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    resourceId: Value<string>;
    /** <code>RestApiId</code>  <a name="cfn-apigateway-method-restapiid"></a>
  The string identifier of the associated RestApi.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    restApiId: Value<string>;
}
