software.amazon.awscdk.services.apigateway

Class CfnMethod

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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.653Z")
 @Stability(value=Stable)
public class CfnMethod
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 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 Example:
static interface	CfnMethod.IntegrationResponseProperty Example:
static interface	CfnMethod.MethodResponseProperty Example:

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.

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

Modifier and Type	Method and Description
Object	getApiKeyRequired() `AWS::ApiGateway::Method.ApiKeyRequired`.
List<String>	getAuthorizationScopes() `AWS::ApiGateway::Method.AuthorizationScopes`.
String	getAuthorizationType() `AWS::ApiGateway::Method.AuthorizationType`.
String	getAuthorizerId() `AWS::ApiGateway::Method.AuthorizerId`.
protected Map<String,Object>	getCfnProperties()
String	getHttpMethod() `AWS::ApiGateway::Method.HttpMethod`.
Object	getIntegration() `AWS::ApiGateway::Method.Integration`.
Object	getMethodResponses() `AWS::ApiGateway::Method.MethodResponses`.
String	getOperationName() `AWS::ApiGateway::Method.OperationName`.
Object	getRequestModels() `AWS::ApiGateway::Method.RequestModels`.
Object	getRequestParameters() `AWS::ApiGateway::Method.RequestParameters`.
String	getRequestValidatorId() `AWS::ApiGateway::Method.RequestValidatorId`.
String	getResourceId() `AWS::ApiGateway::Method.ResourceId`.
String	getRestApiId() `AWS::ApiGateway::Method.RestApiId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiKeyRequired(Boolean value) `AWS::ApiGateway::Method.ApiKeyRequired`.
void	setApiKeyRequired(IResolvable value) `AWS::ApiGateway::Method.ApiKeyRequired`.
void	setAuthorizationScopes(List<String> value) `AWS::ApiGateway::Method.AuthorizationScopes`.
void	setAuthorizationType(String value) `AWS::ApiGateway::Method.AuthorizationType`.
void	setAuthorizerId(String value) `AWS::ApiGateway::Method.AuthorizerId`.
void	setHttpMethod(String value) `AWS::ApiGateway::Method.HttpMethod`.
void	setIntegration(CfnMethod.IntegrationProperty value) `AWS::ApiGateway::Method.Integration`.
void	setIntegration(IResolvable value) `AWS::ApiGateway::Method.Integration`.
void	setMethodResponses(IResolvable value) `AWS::ApiGateway::Method.MethodResponses`.
void	setMethodResponses(List<Object> value) `AWS::ApiGateway::Method.MethodResponses`.
void	setOperationName(String value) `AWS::ApiGateway::Method.OperationName`.
void	setRequestModels(IResolvable value) `AWS::ApiGateway::Method.RequestModels`.
void	setRequestModels(Map<String,String> value) `AWS::ApiGateway::Method.RequestModels`.
void	setRequestParameters(IResolvable value) `AWS::ApiGateway::Method.RequestParameters`.
void	setRequestParameters(Map<String,Object> value) `AWS::ApiGateway::Method.RequestParameters`.
void	setRequestValidatorId(String value) `AWS::ApiGateway::Method.RequestValidatorId`.
void	setResourceId(String value) `AWS::ApiGateway::Method.ResourceId`.
void	setRestApiId(String value) `AWS::ApiGateway::Method.RestApiId`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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.

getApiKeyRequired

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

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

setApiKeyRequired

@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       Boolean value)

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

setApiKeyRequired

@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       IResolvable value)

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

getAuthorizationScopes

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

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

setAuthorizationScopes

@Stability(value=Stable)
public void setAuthorizationScopes(@Nullable
                                                            List<String> value)

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

getAuthorizationType

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

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

setAuthorizationType

@Stability(value=Stable)
public void setAuthorizationType(@Nullable
                                                          String value)

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

getAuthorizerId

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

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

setAuthorizerId

@Stability(value=Stable)
public void setAuthorizerId(@Nullable
                                                     String value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHttpMethod

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

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

setHttpMethod

@Stability(value=Stable)
public void setHttpMethod(@NotNull
                                                   String value)

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

getIntegration

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

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

setIntegration

@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    CfnMethod.IntegrationProperty value)

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

setIntegration

@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    IResolvable value)

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

getMethodResponses

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

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

setMethodResponses

@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        IResolvable value)

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

setMethodResponses

@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        List<Object> value)

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

getOperationName

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

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

setOperationName

@Stability(value=Stable)
public void setOperationName(@Nullable
                                                      String value)

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

getRequestModels

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

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

setRequestModels

@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      IResolvable value)

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

setRequestModels

@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      Map<String,String> value)

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

getRequestParameters

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

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

setRequestParameters

@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          IResolvable value)

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

setRequestParameters

@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          Map<String,Object> value)

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

getRequestValidatorId

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

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

setRequestValidatorId

@Stability(value=Stable)
public void setRequestValidatorId(@Nullable
                                                           String value)

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

getResourceId

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

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

setResourceId

@Stability(value=Stable)
public void setResourceId(@NotNull
                                                   String value)

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

getRestApiId

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

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

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)

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