Package 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(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	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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getApiKeyRequired()	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
final List<String>	getAuthorizationScopes()	A list of authorization scopes configured on the method.
final String	getAuthorizationType()	The method's authorization type.
final String	getAuthorizerId()	The identifier of an authorizer to use on this method.
final String	getHttpMethod()	The method's HTTP verb.
final Object	getIntegration()	Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.
final Object	getMethodResponses()	Gets a method response associated with a given HTTP status code.
final String	getOperationName()	A human-friendly operation identifier for the method.
final Object	getRequestModels()	A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
final Object	getRequestParameters()	A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
final String	getRequestValidatorId()	The identifier of a RequestValidator for request validation.
final String	getResourceId()	The Resource identifier for the MethodResponse resource.
final String	getRestApiId()	The string identifier of the associated RestApi.
final 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

Constructor Details

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 Details

getHttpMethod

public final String getHttpMethod()

Description copied from interface: CfnMethodProps

The method's HTTP verb.

Specified by:

getHttpMethod in interface CfnMethodProps

See Also:

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

getResourceId

public final String getResourceId()

Description copied from interface: CfnMethodProps

The Resource identifier for the MethodResponse resource.

Specified by:

getResourceId in interface CfnMethodProps

See Also:

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

getRestApiId

public final String getRestApiId()

Description copied from interface: CfnMethodProps

The string identifier of the associated RestApi.

Specified by:

getRestApiId in interface CfnMethodProps

See Also:

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

getApiKeyRequired

public final Object getApiKeyRequired()

Description copied from interface: CfnMethodProps

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Returns union: either Boolean or IResolvable

Specified by:

getApiKeyRequired in interface CfnMethodProps

See Also:

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

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 matches 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

See Also:

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

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

See Also:

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

getAuthorizerId

public final String getAuthorizerId()

Description copied from interface: CfnMethodProps

The identifier of an authorizer to use on this method.

The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .

Specified by:

getAuthorizerId in interface CfnMethodProps

See Also:

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

getIntegration

public final Object getIntegration()

Description copied from interface: CfnMethodProps

Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

Returns union: either IResolvable or CfnMethod.IntegrationProperty

Specified by:

getIntegration in interface CfnMethodProps

See Also:

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

getMethodResponses

public final Object getMethodResponses()

Description copied from interface: CfnMethodProps

Gets a method response associated with a given HTTP status code.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMethod.MethodResponseProperty>

Specified by:

getMethodResponses in interface CfnMethodProps

See Also:

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

getOperationName

public final String getOperationName()

Description copied from interface: CfnMethodProps

A human-friendly operation identifier for the method.

For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Specified by:

getOperationName in interface CfnMethodProps

See Also:

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

getRequestModels

public final Object getRequestModels()

Description copied from interface: CfnMethodProps

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

Specified by:

getRequestModels in interface CfnMethodProps

See Also:

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

getRequestParameters

public final Object getRequestParameters()

Description copied from interface: CfnMethodProps

A key-value map defining required or optional method request parameters that can be accepted by API Gateway.

A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Returns union: either IResolvable or Mapinvalid input: '<'String, either Boolean or IResolvable>

Specified by:

getRequestParameters in interface CfnMethodProps

See Also:

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

getRequestValidatorId

public final String getRequestValidatorId()

Description copied from interface: CfnMethodProps

The identifier of a RequestValidator for request validation.

Specified by:

getRequestValidatorId in interface CfnMethodProps

See Also:

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

$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