software.amazon.awscdk.services.apigateway

Class CfnMethodProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.CfnMethodProps.Jsii$Proxy

All Implemented Interfaces:

CfnMethodProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnMethodProps

@Stability(value=Stable)
 @Internal
public static final class CfnMethodProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnMethodProps

An implementation for CfnMethodProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.CfnMethodProps

CfnMethodProps.Builder, CfnMethodProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnMethodProps.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnMethodProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Object	getApiKeyRequired() Indicates whether the method requires clients to submit a valid API key.
List<String>	getAuthorizationScopes() A list of authorization scopes configured on the method.
String	getAuthorizationType() The method's authorization type.
String	getAuthorizerId() The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method.
String	getHttpMethod() The HTTP method that clients use to call this method.
Object	getIntegration() The backend system that the method calls when it receives a request.
Object	getMethodResponses() The responses that can be sent to the client who calls the method.
String	getOperationName() A friendly operation name for the method.
Object	getRequestModels() The resources that are used for the request's content type.
Object	getRequestParameters() The request parameters that API Gateway accepts.
String	getRequestValidatorId() The ID of the associated request validator.
String	getResourceId() The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) .
String	getRestApiId() The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.apigateway.CfnMethodProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnMethodProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnMethodProps.Builder.

Method Detail

getHttpMethod

public final String getHttpMethod()

Description copied from interface: CfnMethodProps

The HTTP method that clients use to call this method.

Specified by:

getHttpMethod in interface CfnMethodProps

getResourceId

public final String getResourceId()

Description copied from interface: CfnMethodProps

The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) . For root resource methods, specify the `RestApi` root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }` .

Specified by:

getResourceId in interface CfnMethodProps

getRestApiId

public final String getRestApiId()

Description copied from interface: CfnMethodProps

The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.

Specified by:

getRestApiId in interface CfnMethodProps

getApiKeyRequired

public final Object getApiKeyRequired()

Description copied from interface: CfnMethodProps

Indicates whether the method requires clients to submit a valid API key.

Specified by:

getApiKeyRequired in interface CfnMethodProps

getAuthorizationScopes

public final List<String> getAuthorizationScopes()

Description copied from interface: CfnMethodProps

A list of authorization scopes configured on the method.

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes match a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Specified by:

getAuthorizationScopes in interface CfnMethodProps

getAuthorizationType

public final String getAuthorizationType()

Description copied from interface: CfnMethodProps

The method's authorization type.

This parameter is required. For valid values, see Method in the API Gateway API Reference .

If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.

Specified by:

getAuthorizationType in interface CfnMethodProps

getAuthorizerId

public final String getAuthorizerId()

Description copied from interface: CfnMethodProps

The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property.

Specified by:

getAuthorizerId in interface CfnMethodProps

getIntegration

public final Object getIntegration()

Description copied from interface: CfnMethodProps

The backend system that the method calls when it receives a request.

Specified by:

getIntegration in interface CfnMethodProps

getMethodResponses

public final Object getMethodResponses()

Description copied from interface: CfnMethodProps

The responses that can be sent to the client who calls the method.

Specified by:

getMethodResponses in interface CfnMethodProps

getOperationName

public final String getOperationName()

Description copied from interface: CfnMethodProps

A friendly operation name for the method.

For example, you can assign the OperationName of ListPets for the GET /pets method.

Specified by:

getOperationName in interface CfnMethodProps

getRequestModels

public final Object getRequestModels()

Description copied from interface: CfnMethodProps

The resources that are used for the request's content type.

Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.

Specified by:

getRequestModels in interface CfnMethodProps

getRequestParameters

public final Object getRequestParameters()

Description copied from interface: CfnMethodProps

The request parameters that API Gateway accepts.

Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.

Specified by:

getRequestParameters in interface CfnMethodProps

getRequestValidatorId

public final String getRequestValidatorId()

Description copied from interface: CfnMethodProps

The ID of the associated request validator.

Specified by:

getRequestValidatorId in interface CfnMethodProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object