Package software.amazon.awscdk.services.apigateway

Class CfnMethod

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnMethod
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.823Z") @Stability(Stable) public class CfnMethod extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::Method.

The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnMethod cfnMethod = CfnMethod.Builder.create(this, "MyCfnMethod")
         .httpMethod("httpMethod")
         .resourceId("resourceId")
         .restApiId("restApiId")
         // the properties below are optional
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .integration(IntegrationProperty.builder()
                 .cacheKeyParameters(List.of("cacheKeyParameters"))
                 .cacheNamespace("cacheNamespace")
                 .connectionId("connectionId")
                 .connectionType("connectionType")
                 .contentHandling("contentHandling")
                 .credentials("credentials")
                 .integrationHttpMethod("integrationHttpMethod")
                 .integrationResponses(List.of(IntegrationResponseProperty.builder()
                         .statusCode("statusCode")
                         // the properties below are optional
                         .contentHandling("contentHandling")
                         .responseParameters(Map.of(
                                 "responseParametersKey", "responseParameters"))
                         .responseTemplates(Map.of(
                                 "responseTemplatesKey", "responseTemplates"))
                         .selectionPattern("selectionPattern")
                         .build()))
                 .passthroughBehavior("passthroughBehavior")
                 .requestParameters(Map.of(
                         "requestParametersKey", "requestParameters"))
                 .requestTemplates(Map.of(
                         "requestTemplatesKey", "requestTemplates"))
                 .timeoutInMillis(123)
                 .type("type")
                 .uri("uri")
                 .build())
         .methodResponses(List.of(MethodResponseProperty.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .responseModels(Map.of(
                         "responseModelsKey", "responseModels"))
                 .responseParameters(Map.of(
                         "responseParametersKey", false))
                 .build()))
         .operationName("operationName")
         .requestModels(Map.of(
                 "requestModelsKey", "requestModels"))
         .requestParameters(Map.of(
                 "requestParametersKey", false))
         .requestValidatorId("requestValidatorId")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMethod

      protected CfnMethod(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMethod

      protected CfnMethod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMethod

      @Stability(Stable) public CfnMethod(@NotNull Construct scope, @NotNull String id, @NotNull CfnMethodProps props)
      Create a new AWS::ApiGateway::Method.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHttpMethod

      @Stability(Stable) @NotNull public String getHttpMethod()
      The method's HTTP verb.

    • setHttpMethod

      @Stability(Stable) public void setHttpMethod(@NotNull String value)
      The method's HTTP verb.

    • getResourceId

      @Stability(Stable) @NotNull public String getResourceId()
      The Resource identifier for the MethodResponse resource.

    • setResourceId

      @Stability(Stable) public void setResourceId(@NotNull String value)
      The Resource identifier for the MethodResponse resource.

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.

    • getApiKeyRequired

      @Stability(Stable) @Nullable public Object getApiKeyRequired()
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.

    • setApiKeyRequired

      @Stability(Stable) public void setApiKeyRequired(@Nullable Boolean value)
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.

    • setApiKeyRequired

      @Stability(Stable) public void setApiKeyRequired(@Nullable IResolvable value)
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.

    • getAuthorizationScopes

      @Stability(Stable) @Nullable public List<String> getAuthorizationScopes()
      A list of authorization scopes configured on the method.

      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.

    • setAuthorizationScopes

      @Stability(Stable) public void setAuthorizationScopes(@Nullable List<String> value)
      A list of authorization scopes configured on the method.

      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.

    • getAuthorizationType

      @Stability(Stable) @Nullable public String getAuthorizationType()
      The method's authorization type.

      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.

    • setAuthorizationType

      @Stability(Stable) public void setAuthorizationType(@Nullable String value)
      The method's authorization type.

      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.

    • getAuthorizerId

      @Stability(Stable) @Nullable public String getAuthorizerId()
      The identifier of an authorizer to use on this method.

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

    • setAuthorizerId

      @Stability(Stable) public void setAuthorizerId(@Nullable String value)
      The identifier of an authorizer to use on this method.

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

    • getIntegration

      @Stability(Stable) @Nullable public Object getIntegration()
      Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

    • setIntegration

      @Stability(Stable) public void setIntegration(@Nullable IResolvable value)
      Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

    • setIntegration

      @Stability(Stable) public void setIntegration(@Nullable CfnMethod.IntegrationProperty value)
      Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

    • getMethodResponses

      @Stability(Stable) @Nullable public Object getMethodResponses()
      Gets a method response associated with a given HTTP status code.

    • setMethodResponses

      @Stability(Stable) public void setMethodResponses(@Nullable IResolvable value)
      Gets a method response associated with a given HTTP status code.

    • setMethodResponses

      @Stability(Stable) public void setMethodResponses(@Nullable List<Object> value)
      Gets a method response associated with a given HTTP status code.

    • getOperationName

      @Stability(Stable) @Nullable public String getOperationName()
      A human-friendly operation identifier for the method.

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

    • setOperationName

      @Stability(Stable) public void setOperationName(@Nullable String value)
      A human-friendly operation identifier for the method.

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

    • getRequestModels

      @Stability(Stable) @Nullable public Object getRequestModels()
      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).

    • setRequestModels

      @Stability(Stable) public void setRequestModels(@Nullable IResolvable value)
      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).

    • setRequestModels

      @Stability(Stable) public void setRequestModels(@Nullable Map<String,String> value)
      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).

    • getRequestParameters

      @Stability(Stable) @Nullable public Object getRequestParameters()
      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 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.

    • setRequestParameters

      @Stability(Stable) public void setRequestParameters(@Nullable IResolvable value)
      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 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.

    • setRequestParameters

      @Stability(Stable) public void setRequestParameters(@Nullable Map<String,Object> value)
      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 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.

    • getRequestValidatorId

      @Stability(Stable) @Nullable public String getRequestValidatorId()
      The identifier of a RequestValidator for request validation.

    • setRequestValidatorId

      @Stability(Stable) public void setRequestValidatorId(@Nullable String value)
      The identifier of a RequestValidator for request validation.