Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnMethodPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnMethodPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.464Z")
@Stability(Stable)
public class CfnMethodPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.apigateway.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnMethodPropsMixin cfnMethodPropsMixin = CfnMethodPropsMixin.Builder.create(CfnMethodMixinProps.builder()
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .httpMethod("httpMethod")
         .integration(IntegrationProperty.builder()
                 .cacheKeyParameters(List.of("cacheKeyParameters"))
                 .cacheNamespace("cacheNamespace")
                 .connectionId("connectionId")
                 .connectionType("connectionType")
                 .contentHandling("contentHandling")
                 .credentials("credentials")
                 .integrationHttpMethod("integrationHttpMethod")
                 .integrationResponses(List.of(IntegrationResponseProperty.builder()
                         .contentHandling("contentHandling")
                         .responseParameters(Map.of(
                                 "responseParametersKey", "responseParameters"))
                         .responseTemplates(Map.of(
                                 "responseTemplatesKey", "responseTemplates"))
                         .selectionPattern("selectionPattern")
                         .statusCode("statusCode")
                         .build()))
                 .integrationTarget("integrationTarget")
                 .passthroughBehavior("passthroughBehavior")
                 .requestParameters(Map.of(
                         "requestParametersKey", "requestParameters"))
                 .requestTemplates(Map.of(
                         "requestTemplatesKey", "requestTemplates"))
                 .responseTransferMode("responseTransferMode")
                 .timeoutInMillis(123)
                 .type("type")
                 .uri("uri")
                 .build())
         .methodResponses(List.of(MethodResponseProperty.builder()
                 .responseModels(Map.of(
                         "responseModelsKey", "responseModels"))
                 .responseParameters(Map.of(
                         "responseParametersKey", false))
                 .statusCode("statusCode")
                 .build()))
         .operationName("operationName")
         .requestModels(Map.of(
                 "requestModelsKey", "requestModels"))
         .requestParameters(Map.of(
                 "requestParametersKey", false))
         .requestValidatorId("requestValidatorId")
         .resourceId("resourceId")
         .restApiId("restApiId")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnMethodPropsMixin.Builder	A fluent builder for CfnMethodPropsMixin.
static interface	CfnMethodPropsMixin.IntegrationProperty	Integration is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
static interface	CfnMethodPropsMixin.IntegrationResponseProperty	IntegrationResponse is a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
static interface	CfnMethodPropsMixin.MethodResponseProperty	Represents a method response of a given HTTP status code returned to the client.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnMethodPropsMixin(CfnMethodMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::Method.
	CfnMethodPropsMixin(CfnMethodMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::Method.
protected	CfnMethodPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMethodPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnMethodMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnMethodPropsMixin

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

CfnMethodPropsMixin

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

CfnMethodPropsMixin

@Stability(Stable)
public CfnMethodPropsMixin(@NotNull
 CfnMethodMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::Method.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnMethodPropsMixin

@Stability(Stable)
public CfnMethodPropsMixin(@NotNull
 CfnMethodMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::Method.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnMethodMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()