Package software.amazon.awscdk.services.apigateway

Interface CfnMethodProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMethodProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:10.422Z")
@Stability(Stable)
public interface CfnMethodProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMethod.

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.*;
 CfnMethodProps cfnMethodProps = CfnMethodProps.builder()
         .httpMethod("httpMethod")
         .resourceId("resourceId")
         .restApiId("restApiId")
         // the properties below are optional
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .integration(IntegrationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .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)
                 .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMethodProps.Builder	A builder for CfnMethodProps
static final class	CfnMethodProps.Jsii$Proxy	An implementation for CfnMethodProps

Method Summary

Modifier and Type	Method	Description
static CfnMethodProps.Builder	builder()
default Object	getApiKeyRequired()	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
default List<String>	getAuthorizationScopes()	A list of authorization scopes configured on the method.
default String	getAuthorizationType()	The method's authorization type.
default String	getAuthorizerId()	The identifier of an authorizer to use on this method.
String	getHttpMethod()	The method's HTTP verb.
default Object	getIntegration()	Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
default Object	getMethodResponses()	Gets a method response associated with a given HTTP status code.
default String	getOperationName()	A human-friendly operation identifier for the method.
default 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).
default Object	getRequestParameters()	A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
default String	getRequestValidatorId()	The identifier of a RequestValidator for request validation.
String	getResourceId()	The Resource identifier for the MethodResponse resource.
String	getRestApiId()	The string identifier of the associated RestApi.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpMethod

@Stability(Stable)
@NotNull
String getHttpMethod()

The method's HTTP verb.

See Also:

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

getResourceId

@Stability(Stable)
@NotNull
String getResourceId()

The Resource identifier for the MethodResponse resource.

See Also:

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

getRestApiId

@Stability(Stable)
@NotNull
String getRestApiId()

The string identifier of the associated RestApi.

See Also:

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

getApiKeyRequired

@Stability(Stable)
@Nullable
default Object getApiKeyRequired()

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

See Also:

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

getAuthorizationScopes

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getAuthorizationType

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getAuthorizerId

@Stability(Stable)
@Nullable
default String getAuthorizerId()

The identifier of an authorizer to use on this method.

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

See Also:

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

getIntegration

@Stability(Stable)
@Nullable
default Object getIntegration()

Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

See Also:

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

getMethodResponses

@Stability(Stable)
@Nullable
default Object getMethodResponses()

Gets a method response associated with a given HTTP status code.

See Also:

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

getOperationName

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getRequestModels

@Stability(Stable)
@Nullable
default 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).

See Also:

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

getRequestParameters

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getRequestValidatorId

@Stability(Stable)
@Nullable
default String getRequestValidatorId()

The identifier of a RequestValidator for request validation.

See Also:

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

builder

@Stability(Stable)
static CfnMethodProps.Builder builder()

Returns:

a CfnMethodProps.Builder of CfnMethodProps