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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.336Z")
 @Stability(value=Stable)
public interface CfnMethodProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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	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

getHttpMethod

@Stability(value=Stable)
 @NotNull
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

getResourceId

@Stability(value=Stable)
 @NotNull
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

getRestApiId

@Stability(value=Stable)
 @NotNull
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

getApiKeyRequired

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

getAuthorizationScopes

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

getAuthorizationType

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

getAuthorizerId

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

getIntegration

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

getMethodResponses

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

getOperationName

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

getRequestModels

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

getRequestParameters

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

getRequestValidatorId

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

builder

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

Returns:

a CfnMethodProps.Builder of CfnMethodProps