Package software.amazon.awscdk.services.apigatewayv2

Class CfnAuthorizerProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.CfnAuthorizerProps.Jsii$Proxy

All Implemented Interfaces:

CfnAuthorizerProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAuthorizerProps

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

An implementation for CfnAuthorizerProps

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.apigatewayv2.CfnAuthorizerProps

CfnAuthorizerProps.Builder, CfnAuthorizerProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAuthorizerProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAuthorizerProps.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 String	getApiId()	The API identifier.
final String	getAuthorizerCredentialsArn()	Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
final String	getAuthorizerPayloadFormatVersion()	Specifies the format of the payload sent to an HTTP API Lambda authorizer.
final Number	getAuthorizerResultTtlInSeconds()	The time to live (TTL) for cached authorizer results, in seconds.
final String	getAuthorizerType()	The authorizer type.
final String	getAuthorizerUri()	The authorizer's Uniform Resource Identifier (URI).
final Object	getEnableSimpleResponses()	Specifies whether a Lambda authorizer returns a response in a simple format.
final List<String>	getIdentitySource()	The identity source for which authorization is requested.
final String	getIdentityValidationExpression()	This parameter is not used.
final Object	getJwtConfiguration()	The JWTConfiguration property specifies the configuration of a JWT authorizer.
final String	getName()	The name of the authorizer.
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(CfnAuthorizerProps.Builder builder)

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

Method Details

getApiId

public final String getApiId()

Description copied from interface: CfnAuthorizerProps

The API identifier.

Specified by:

getApiId in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid

getAuthorizerType

public final String getAuthorizerType()

Description copied from interface: CfnAuthorizerProps

The authorizer type.

Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Specified by:

getAuthorizerType in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype

getName

public final String getName()

Description copied from interface: CfnAuthorizerProps

The name of the authorizer.

Specified by:

getName in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name

getAuthorizerCredentialsArn

public final String getAuthorizerCredentialsArn()

Description copied from interface: CfnAuthorizerProps

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

Specified by:

getAuthorizerCredentialsArn in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn

getAuthorizerPayloadFormatVersion

public final String getAuthorizerPayloadFormatVersion()

Description copied from interface: CfnAuthorizerProps

Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0 . To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

Specified by:

getAuthorizerPayloadFormatVersion in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerpayloadformatversion

getAuthorizerResultTtlInSeconds

public final Number getAuthorizerResultTtlInSeconds()

Description copied from interface: CfnAuthorizerProps

The time to live (TTL) for cached authorizer results, in seconds.

If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

Specified by:

getAuthorizerResultTtlInSeconds in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds

getAuthorizerUri

public final String getAuthorizerUri()

Description copied from interface: CfnAuthorizerProps

The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: *{account_id}* :function: *{lambda_function_name}* /invocations . In general, the URI has this form: arn:aws:apigateway: *{region}* :lambda:path/ *{service_api}* , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations .

Specified by:

getAuthorizerUri in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri

getEnableSimpleResponses

public final Object getEnableSimpleResponses()

Description copied from interface: CfnAuthorizerProps

Specifies whether a Lambda authorizer returns a response in a simple format.

By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

Returns union: either Boolean or IResolvable

Specified by:

getEnableSimpleResponses in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-enablesimpleresponses

getIdentitySource

public final List<String> getIdentitySource()

Description copied from interface: CfnAuthorizerProps

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $ , for example, $request.header.Auth , $request.querystring.Name . These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

For JWT , a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization .

Specified by:

getIdentitySource in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

getIdentityValidationExpression

public final String getIdentityValidationExpression()

Description copied from interface: CfnAuthorizerProps

This parameter is not used.

Specified by:

getIdentityValidationExpression in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression

getJwtConfiguration

public final Object getJwtConfiguration()

Description copied from interface: CfnAuthorizerProps

The JWTConfiguration property specifies the configuration of a JWT authorizer.

Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns union: either IResolvable or CfnAuthorizer.JWTConfigurationProperty

Specified by:

getJwtConfiguration in interface CfnAuthorizerProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration

$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