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
[List
[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
,List
[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
.
- See
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
Attributes
-
api_key_required
¶ AWS::ApiGateway::Method.ApiKeyRequired
.
AWS::ApiGateway::Method.AuthorizationScopes
.- See
- Return type
Optional
[List
[str
]]
AWS::ApiGateway::Method.AuthorizationType
.
AWS::ApiGateway::Method.AuthorizerId
.
-
http_method
¶ AWS::ApiGateway::Method.HttpMethod
.
-
integration
¶ AWS::ApiGateway::Method.Integration
.
-
method_responses
¶ AWS::ApiGateway::Method.MethodResponses
.- See
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,MethodResponseProperty
]],None
]
-
operation_name
¶ AWS::ApiGateway::Method.OperationName
.
-
request_models
¶ AWS::ApiGateway::Method.RequestModels
.- See
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]
-
request_parameters
¶ AWS::ApiGateway::Method.RequestParameters
.- See
- Return type
Union
[IResolvable
,Mapping
[str
,Union
[bool
,IResolvable
]],None
]
-
request_validator_id
¶ AWS::ApiGateway::Method.RequestValidatorId
.
-
resource_id
¶ AWS::ApiGateway::Method.ResourceId
.
-
rest_api_id
¶ AWS::ApiGateway::Method.RestApiId
.