Class CfnMethod
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
A CloudFormation AWS::ApiGateway::Method.
public class CfnMethod : CfnResource, IInspectable- Inheritance
-
CfnMethod
- Implements
-
IInspectable
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 cfnMethod = new CfnMethod(this, "MyCfnMethod", 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"
});Remarks
The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
CloudformationResource: AWS::ApiGateway::Method
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
ExampleMetadata: fixture=_generated
Constructors
CfnMethod(Construct, string, ICfnMethodProps)
Create a new AWS::ApiGateway::Method.
public CfnMethod(Construct scope, string id, ICfnMethodProps props)Parameters
scopeConstruct- scope in which this resource is defined.
idstring- scoped id of the resource.
propsICfnMethodProps- resource properties.
Properties
ApiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
public virtual object? ApiKeyRequired { get; set; }Property Value
Remarks
AuthorizationScopes
A list of authorization scopes configured on the method.
public virtual string[]? AuthorizationScopes { get; set; }Property Value
- 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.
AuthorizationType
The method's authorization type.
public virtual string? AuthorizationType { get; set; }Property Value
Remarks
This parameter is required. For valid values, see Method in the API Gateway API Reference .
If you specify the <code>AuthorizerId</code> property, specify <code>CUSTOM</code> or <code>COGNITO_USER_POOLS</code> for this property.
AuthorizerId
The identifier of an authorizer to use on this method.
public virtual string? AuthorizerId { get; set; }Property Value
Remarks
The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
HttpMethod
The method's HTTP verb.
public virtual string HttpMethod { get; set; }Property Value
Remarks
Integration
Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
public virtual object? Integration { get; set; }Property Value
Remarks
MethodResponses
Gets a method response associated with a given HTTP status code.
public virtual object? MethodResponses { get; set; }Property Value
Remarks
OperationName
A human-friendly operation identifier for the method.
public virtual string? OperationName { get; set; }Property Value
Remarks
For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
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).
public virtual object? RequestModels { get; set; }Property Value
Remarks
RequestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
public virtual object? RequestParameters { get; set; }Property Value
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.
RequestValidatorId
The identifier of a RequestValidator for request validation.
public virtual string? RequestValidatorId { get; set; }Property Value
Remarks
ResourceId
The Resource identifier for the MethodResponse resource.
public virtual string ResourceId { get; set; }Property Value
Remarks
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
inspectorTreeInspector- tree inspector to collect and process attributes.
RenderProperties(IDictionary<string, object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
propsIDictionary<string, object>