CfnMethod (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.apigateway.CfnMethod

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.120Z")
 @Stability(value=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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnMethod.Builder` A fluent builder for `CfnMethod`.
`static interface`	`CfnMethod.IntegrationProperty` `Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.
`static interface`	`CfnMethod.IntegrationResponseProperty` `IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
`static interface`	`CfnMethod.MethodResponseProperty` `MethodResponse` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that defines the responses that can be sent to the client that calls a method.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnMethod(software.constructs.Construct scope, String id, CfnMethodProps props)` Create a new `AWS::ApiGateway::Method`.
`protected`	`CfnMethod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnMethod(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getApiKeyRequired()` Indicates whether the method requires clients to submit a valid API key.
`List<String>`	`getAuthorizationScopes()` A list of authorization scopes configured on the method.
`String`	`getAuthorizationType()` The method's authorization type.
`String`	`getAuthorizerId()` The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getHttpMethod()` The HTTP method that clients use to call this method.
`Object`	`getIntegration()` The backend system that the method calls when it receives a request.
`Object`	`getMethodResponses()` The responses that can be sent to the client who calls the method.
`String`	`getOperationName()` A friendly operation name for the method.
`Object`	`getRequestModels()` The resources that are used for the request's content type.
`Object`	`getRequestParameters()` The request parameters that API Gateway accepts.
`String`	`getRequestValidatorId()` The ID of the associated request validator.
`String`	`getResourceId()` The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) .
`String`	`getRestApiId()` The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setApiKeyRequired(Boolean value)` Indicates whether the method requires clients to submit a valid API key.
`void`	`setApiKeyRequired(IResolvable value)` Indicates whether the method requires clients to submit a valid API key.
`void`	`setAuthorizationScopes(List<String> value)` A list of authorization scopes configured on the method.
`void`	`setAuthorizationType(String value)` The method's authorization type.
`void`	`setAuthorizerId(String value)` The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method.
`void`	`setHttpMethod(String value)` The HTTP method that clients use to call this method.
`void`	`setIntegration(CfnMethod.IntegrationProperty value)` The backend system that the method calls when it receives a request.
`void`	`setIntegration(IResolvable value)` The backend system that the method calls when it receives a request.
`void`	`setMethodResponses(IResolvable value)` The responses that can be sent to the client who calls the method.
`void`	`setMethodResponses(List<Object> value)` The responses that can be sent to the client who calls the method.
`void`	`setOperationName(String value)` A friendly operation name for the method.
`void`	`setRequestModels(IResolvable value)` The resources that are used for the request's content type.
`void`	`setRequestModels(Map<String,String> value)` The resources that are used for the request's content type.
`void`	`setRequestParameters(IResolvable value)` The request parameters that API Gateway accepts.
`void`	`setRequestParameters(Map<String,Object> value)` The request parameters that API Gateway accepts.
`void`	`setRequestValidatorId(String value)` The ID of the associated request validator.
`void`	`setResourceId(String value)` The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) .
`void`	`setRestApiId(String value)` The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnMethod
```
protected CfnMethod(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnMethod
```
protected CfnMethod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnMethod
```
@Stability(value=Stable)
public CfnMethod(@NotNull
                                          software.constructs.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 Detail
  - inspect
```
@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getHttpMethod
```
@Stability(value=Stable)
 @NotNull
public String getHttpMethod()
```
    The HTTP method that clients use to call this method.
  - setHttpMethod
```
@Stability(value=Stable)
public void setHttpMethod(@NotNull
                                                   String value)
```
    The HTTP method that clients use to call this method.
  - getResourceId
```
@Stability(value=Stable)
 @NotNull
public String getResourceId()
```
    The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) . For root resource methods, specify the `RestApi` root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }` .
  - setResourceId
```
@Stability(value=Stable)
public void setResourceId(@NotNull
                                                   String value)
```
    The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) . For root resource methods, specify the `RestApi` root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }` .
  - getRestApiId
```
@Stability(value=Stable)
 @NotNull
public String getRestApiId()
```
    The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.
  - setRestApiId
```
@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)
```
    The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.
  - getApiKeyRequired
```
@Stability(value=Stable)
 @Nullable
public Object getApiKeyRequired()
```
    Indicates whether the method requires clients to submit a valid API key.
  - setApiKeyRequired
```
@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       Boolean value)
```
    Indicates whether the method requires clients to submit a valid API key.
  - setApiKeyRequired
```
@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       IResolvable value)
```
    Indicates whether the method requires clients to submit a valid API key.
  - getAuthorizationScopes
```
@Stability(value=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 match 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(value=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 match 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(value=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(value=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(value=Stable)
 @Nullable
public String getAuthorizerId()
```
    The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property.
  - setAuthorizerId
```
@Stability(value=Stable)
public void setAuthorizerId(@Nullable
                                                     String value)
```
    The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property.
  - getIntegration
```
@Stability(value=Stable)
 @Nullable
public Object getIntegration()
```
    The backend system that the method calls when it receives a request.
  - setIntegration
```
@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    CfnMethod.IntegrationProperty value)
```
    The backend system that the method calls when it receives a request.
  - setIntegration
```
@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    IResolvable value)
```
    The backend system that the method calls when it receives a request.
  - getMethodResponses
```
@Stability(value=Stable)
 @Nullable
public Object getMethodResponses()
```
    The responses that can be sent to the client who calls the method.
  - setMethodResponses
```
@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        IResolvable value)
```
    The responses that can be sent to the client who calls the method.
  - setMethodResponses
```
@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        List<Object> value)
```
    The responses that can be sent to the client who calls the method.
  - getOperationName
```
@Stability(value=Stable)
 @Nullable
public String getOperationName()
```
    A friendly operation name for the method.
    For example, you can assign the OperationName of ListPets for the GET /pets method.
  - setOperationName
```
@Stability(value=Stable)
public void setOperationName(@Nullable
                                                      String value)
```
    A friendly operation name for the method.
    For example, you can assign the OperationName of ListPets for the GET /pets method.
  - getRequestModels
```
@Stability(value=Stable)
 @Nullable
public Object getRequestModels()
```
    The resources that are used for the request's content type.
    Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.
  - setRequestModels
```
@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      IResolvable value)
```
    The resources that are used for the request's content type.
    Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.
  - setRequestModels
```
@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      Map<String,String> value)
```
    The resources that are used for the request's content type.
    Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.
  - getRequestParameters
```
@Stability(value=Stable)
 @Nullable
public Object getRequestParameters()
```
    The request parameters that API Gateway accepts.
    Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.
  - setRequestParameters
```
@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          IResolvable value)
```
    The request parameters that API Gateway accepts.
    Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.
  - setRequestParameters
```
@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          Map<String,Object> value)
```
    The request parameters that API Gateway accepts.
    Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.
  - getRequestValidatorId
```
@Stability(value=Stable)
 @Nullable
public String getRequestValidatorId()
```
    The ID of the associated request validator.
  - setRequestValidatorId
```
@Stability(value=Stable)
public void setRequestValidatorId(@Nullable
                                                           String value)
```
    The ID of the associated request validator.

Class CfnMethod

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnMethod

CfnMethod

CfnMethod

Method Detail

inspect

renderProperties

getCfnProperties

getHttpMethod

setHttpMethod

getResourceId

setResourceId

getRestApiId

setRestApiId

getApiKeyRequired

setApiKeyRequired

setApiKeyRequired

getAuthorizationScopes

setAuthorizationScopes

getAuthorizationType

setAuthorizationType

getAuthorizerId

setAuthorizerId

getIntegration

setIntegration

setIntegration

getMethodResponses

setMethodResponses

setMethodResponses

getOperationName

setOperationName

getRequestModels

setRequestModels

setRequestModels

getRequestParameters

setRequestParameters

setRequestParameters

getRequestValidatorId

setRequestValidatorId