CfnMethod (software.amazon.awscdk:monocdk 1.75.0.DEVPREVIEW API)

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

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
```
@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.334Z")
 @Stability(value=Stable)
public class CfnMethod
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::ApiGateway::Method`.

See Also:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnMethod.Builder` A fluent builder for `CfnMethod`.
`static interface`	`CfnMethod.IntegrationProperty`
`static interface`	`CfnMethod.IntegrationResponseProperty`
`static interface`	`CfnMethod.MethodResponseProperty`

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
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(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()` `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)` (experimental) 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.core.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.core.CfnRefElement
getRef

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

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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
                                          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=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)
```
    (experimental) 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()
```
    `AWS::ApiGateway::Method.HttpMethod`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
  - setHttpMethod
```
@Stability(value=Stable)
public void setHttpMethod(@NotNull
                                                   String value)
```
    `AWS::ApiGateway::Method.HttpMethod`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
  - getResourceId
```
@Stability(value=Stable)
 @NotNull
public String getResourceId()
```
    `AWS::ApiGateway::Method.ResourceId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
  - setResourceId
```
@Stability(value=Stable)
public void setResourceId(@NotNull
                                                   String value)
```
    `AWS::ApiGateway::Method.ResourceId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
  - getRestApiId
```
@Stability(value=Stable)
 @NotNull
public String getRestApiId()
```
    `AWS::ApiGateway::Method.RestApiId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
  - setRestApiId
```
@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)
```
    `AWS::ApiGateway::Method.RestApiId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
  - getApiKeyRequired
```
@Stability(value=Stable)
 @Nullable
public Object getApiKeyRequired()
```
    `AWS::ApiGateway::Method.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
  - setApiKeyRequired
```
@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       Boolean value)
```
    `AWS::ApiGateway::Method.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
  - setApiKeyRequired
```
@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       IResolvable value)
```
    `AWS::ApiGateway::Method.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
  - getAuthorizationScopes
```
@Stability(value=Stable)
 @Nullable
public List<String> getAuthorizationScopes()
```
    `AWS::ApiGateway::Method.AuthorizationScopes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
  - setAuthorizationScopes
```
@Stability(value=Stable)
public void setAuthorizationScopes(@Nullable
                                                            List<String> value)
```
    `AWS::ApiGateway::Method.AuthorizationScopes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
  - getAuthorizationType
```
@Stability(value=Stable)
 @Nullable
public String getAuthorizationType()
```
    `AWS::ApiGateway::Method.AuthorizationType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
  - setAuthorizationType
```
@Stability(value=Stable)
public void setAuthorizationType(@Nullable
                                                          String value)
```
    `AWS::ApiGateway::Method.AuthorizationType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
  - getAuthorizerId
```
@Stability(value=Stable)
 @Nullable
public String getAuthorizerId()
```
    `AWS::ApiGateway::Method.AuthorizerId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
  - setAuthorizerId
```
@Stability(value=Stable)
public void setAuthorizerId(@Nullable
                                                     String value)
```
    `AWS::ApiGateway::Method.AuthorizerId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
  - getIntegration
```
@Stability(value=Stable)
 @Nullable
public Object getIntegration()
```
    `AWS::ApiGateway::Method.Integration`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
  - setIntegration
```
@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    CfnMethod.IntegrationProperty value)
```
    `AWS::ApiGateway::Method.Integration`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
  - setIntegration
```
@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    IResolvable value)
```
    `AWS::ApiGateway::Method.Integration`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
  - getMethodResponses
```
@Stability(value=Stable)
 @Nullable
public Object getMethodResponses()
```
    `AWS::ApiGateway::Method.MethodResponses`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
  - setMethodResponses
```
@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        IResolvable value)
```
    `AWS::ApiGateway::Method.MethodResponses`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
  - setMethodResponses
```
@Stability(value=Stable)
public void setMethodResponses(@Nullable
                                                        List<Object> value)
```
    `AWS::ApiGateway::Method.MethodResponses`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
  - getOperationName
```
@Stability(value=Stable)
 @Nullable
public String getOperationName()
```
    `AWS::ApiGateway::Method.OperationName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
  - setOperationName
```
@Stability(value=Stable)
public void setOperationName(@Nullable
                                                      String value)
```
    `AWS::ApiGateway::Method.OperationName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
  - getRequestModels
```
@Stability(value=Stable)
 @Nullable
public Object getRequestModels()
```
    `AWS::ApiGateway::Method.RequestModels`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
  - setRequestModels
```
@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      IResolvable value)
```
    `AWS::ApiGateway::Method.RequestModels`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
  - setRequestModels
```
@Stability(value=Stable)
public void setRequestModels(@Nullable
                                                      Map<String,String> value)
```
    `AWS::ApiGateway::Method.RequestModels`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
  - getRequestParameters
```
@Stability(value=Stable)
 @Nullable
public Object getRequestParameters()
```
    `AWS::ApiGateway::Method.RequestParameters`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
  - setRequestParameters
```
@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          IResolvable value)
```
    `AWS::ApiGateway::Method.RequestParameters`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
  - setRequestParameters
```
@Stability(value=Stable)
public void setRequestParameters(@Nullable
                                                          Map<String,Object> value)
```
    `AWS::ApiGateway::Method.RequestParameters`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
  - getRequestValidatorId
```
@Stability(value=Stable)
 @Nullable
public String getRequestValidatorId()
```
    `AWS::ApiGateway::Method.RequestValidatorId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
  - setRequestValidatorId
```
@Stability(value=Stable)
public void setRequestValidatorId(@Nullable
                                                           String value)
```
    `AWS::ApiGateway::Method.RequestValidatorId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid

Class CfnMethod

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.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