CfnMethodProps¶

class aws_cdk.aws_apigateway.CfnMethodProps(*, http_method, resource_id, rest_api_id, api_key_required=None, authorization_scopes=None, authorization_type=None, authorizer_id=None, integration=None, method_responses=None, operation_name=None, request_models=None, request_parameters=None, request_validator_id=None)¶

Bases: object

Properties for defining a AWS::ApiGateway::Method.

Parameters

http_method (str) – AWS::ApiGateway::Method.HttpMethod.
resource_id (str) – AWS::ApiGateway::Method.ResourceId.
rest_api_id (str) – AWS::ApiGateway::Method.RestApiId.
api_key_required (Union[bool, IResolvable, None]) – AWS::ApiGateway::Method.ApiKeyRequired.
authorization_scopes (Optional[Sequence[str]]) – AWS::ApiGateway::Method.AuthorizationScopes.
authorization_type (Optional[str]) – AWS::ApiGateway::Method.AuthorizationType.
authorizer_id (Optional[str]) – AWS::ApiGateway::Method.AuthorizerId.
integration (Union[IResolvable, IntegrationProperty, None]) – AWS::ApiGateway::Method.Integration.
method_responses (Union[IResolvable, Sequence[Union[IResolvable, MethodResponseProperty]], None]) – AWS::ApiGateway::Method.MethodResponses.
operation_name (Optional[str]) – AWS::ApiGateway::Method.OperationName.
request_models (Union[IResolvable, Mapping[str, str], None]) – AWS::ApiGateway::Method.RequestModels.
request_parameters (Union[IResolvable, Mapping[str, Union[bool, IResolvable]], None]) – AWS::ApiGateway::Method.RequestParameters.
request_validator_id (Optional[str]) – AWS::ApiGateway::Method.RequestValidatorId.

Link

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

Attributes

api_key_required¶

AWS::ApiGateway::Method.ApiKeyRequired.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
Return type: Union[bool, IResolvable, None]

authorization_scopes¶

AWS::ApiGateway::Method.AuthorizationScopes.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
Return type: Optional[List[str]]

authorization_type¶

AWS::ApiGateway::Method.AuthorizationType.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
Return type: Optional[str]

authorizer_id¶

AWS::ApiGateway::Method.AuthorizerId.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
Return type: Optional[str]

http_method¶

AWS::ApiGateway::Method.HttpMethod.

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

integration¶

AWS::ApiGateway::Method.Integration.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
Return type: Union[IResolvable, IntegrationProperty, None]

method_responses¶

AWS::ApiGateway::Method.MethodResponses.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
Return type: Union[IResolvable, List[Union[IResolvable, MethodResponseProperty]], None]

operation_name¶

AWS::ApiGateway::Method.OperationName.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
Return type: Optional[str]

request_models¶

AWS::ApiGateway::Method.RequestModels.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
Return type: Union[IResolvable, Mapping[str, str], None]

request_parameters¶

AWS::ApiGateway::Method.RequestParameters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
Return type: Union[IResolvable, Mapping[str, Union[bool, IResolvable]], None]

request_validator_id¶

AWS::ApiGateway::Method.RequestValidatorId.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
Return type: Optional[str]

resource_id¶

AWS::ApiGateway::Method.ResourceId.

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

rest_api_id¶

AWS::ApiGateway::Method.RestApiId.

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