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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.753Z")
 @Stability(value=Stable)
public interface CfnMethodProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::Method`.

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()
                 .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	Interface and Description
static class	CfnMethodProps.Builder A builder for CfnMethodProps
static class	CfnMethodProps.Jsii$Proxy An implementation for CfnMethodProps

Method Summary

Modifier and Type	Method and Description
static CfnMethodProps.Builder	builder()
default Object	getApiKeyRequired() `AWS::ApiGateway::Method.ApiKeyRequired`.
default List<String>	getAuthorizationScopes() `AWS::ApiGateway::Method.AuthorizationScopes`.
default String	getAuthorizationType() `AWS::ApiGateway::Method.AuthorizationType`.
default String	getAuthorizerId() `AWS::ApiGateway::Method.AuthorizerId`.
String	getHttpMethod() `AWS::ApiGateway::Method.HttpMethod`.
default Object	getIntegration() `AWS::ApiGateway::Method.Integration`.
default Object	getMethodResponses() `AWS::ApiGateway::Method.MethodResponses`.
default String	getOperationName() `AWS::ApiGateway::Method.OperationName`.
default Object	getRequestModels() `AWS::ApiGateway::Method.RequestModels`.
default Object	getRequestParameters() `AWS::ApiGateway::Method.RequestParameters`.
default String	getRequestValidatorId() `AWS::ApiGateway::Method.RequestValidatorId`.
String	getResourceId() `AWS::ApiGateway::Method.ResourceId`.
String	getRestApiId() `AWS::ApiGateway::Method.RestApiId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiKeyRequired

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

`AWS::ApiGateway::Method.ApiKeyRequired`.

getAuthorizationScopes

@Stability(value=Stable)
 @Nullable
default List<String> getAuthorizationScopes()

`AWS::ApiGateway::Method.AuthorizationScopes`.

getAuthorizationType

@Stability(value=Stable)
 @Nullable
default String getAuthorizationType()

`AWS::ApiGateway::Method.AuthorizationType`.

getAuthorizerId

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

`AWS::ApiGateway::Method.AuthorizerId`.

getHttpMethod

@Stability(value=Stable)
 @NotNull
String getHttpMethod()

`AWS::ApiGateway::Method.HttpMethod`.

getIntegration

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

`AWS::ApiGateway::Method.Integration`.

getMethodResponses

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

`AWS::ApiGateway::Method.MethodResponses`.

getOperationName

@Stability(value=Stable)
 @Nullable
default String getOperationName()

`AWS::ApiGateway::Method.OperationName`.

getRequestModels

@Stability(value=Stable)
 @Nullable
default Object getRequestModels()

`AWS::ApiGateway::Method.RequestModels`.

getRequestParameters

@Stability(value=Stable)
 @Nullable
default Object getRequestParameters()

`AWS::ApiGateway::Method.RequestParameters`.

getRequestValidatorId

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

`AWS::ApiGateway::Method.RequestValidatorId`.

getResourceId

@Stability(value=Stable)
 @NotNull
String getResourceId()

`AWS::ApiGateway::Method.ResourceId`.

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

`AWS::ApiGateway::Method.RestApiId`.

builder

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

Returns:

a CfnMethodProps.Builder of CfnMethodProps