software.amazon.awscdk.services.apigateway

Class CfnAuthorizerProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnAuthorizerProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAuthorizerProps

@Stability(value=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.apigateway.CfnAuthorizerProps

CfnAuthorizerProps.Builder, CfnAuthorizerProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and 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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAuthorizerCredentials() The credentials that are required for the authorizer.
Number	getAuthorizerResultTtlInSeconds() The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results.
String	getAuthorizerUri() The authorizer's Uniform Resource Identifier (URI).
String	getAuthType() An optional customer-defined field that's used in OpenApi imports and exports without functional impact.
String	getIdentitySource() The source of the identity in an incoming request.
String	getIdentityValidationExpression() A validation expression for the incoming identity.
String	getName() The name of the authorizer.
List<String>	getProviderArns() A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer.
String	getRestApiId() The ID of the `RestApi` resource that API Gateway creates the authorizer in.
String	getType() The type of authorizer.
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.CfnAuthorizerProps

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(CfnAuthorizerProps.Builder builder)

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

Method Detail

getName

public final String getName()

Description copied from interface: CfnAuthorizerProps

The name of the authorizer.

Specified by:

getName in interface CfnAuthorizerProps

getRestApiId

public final String getRestApiId()

Description copied from interface: CfnAuthorizerProps

The ID of the `RestApi` resource that API Gateway creates the authorizer in.

Specified by:

getRestApiId in interface CfnAuthorizerProps

getType

public final String getType()

Description copied from interface: CfnAuthorizerProps

The type of authorizer. Valid values include:.

• TOKEN : A custom authorizer that uses a Lambda function.
• COGNITO_USER_POOLS : An authorizer that uses Amazon Cognito user pools.
• REQUEST : An authorizer that uses a Lambda function using incoming request parameters.

Specified by:

getType in interface CfnAuthorizerProps

getAuthorizerCredentials

public final String getAuthorizerCredentials()

Description copied from interface: CfnAuthorizerProps

The credentials that are required for the authorizer.

To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Specified by:

getAuthorizerCredentials in interface CfnAuthorizerProps

getAuthorizerResultTtlInSeconds

public final Number getAuthorizerResultTtlInSeconds()

Description copied from interface: CfnAuthorizerProps

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results.

If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour.

Specified by:

getAuthorizerResultTtlInSeconds in interface CfnAuthorizerProps

getAuthorizerUri

public final String getAuthorizerUri()

Description copied from interface: CfnAuthorizerProps

The authorizer's Uniform Resource Identifier (URI).

If you specify TOKEN for the authorizer's Type property, specify a Lambda function URI that has the form arn:aws:apigateway: *region* :lambda:path/ *path* . The path usually has the form /2015-03-31/functions/ LambdaFunctionARN /invocations.

Specified by:

getAuthorizerUri in interface CfnAuthorizerProps

getAuthType

public final String getAuthType()

Description copied from interface: CfnAuthorizerProps

An optional customer-defined field that's used in OpenApi imports and exports without functional impact.

Specified by:

getAuthType in interface CfnAuthorizerProps

getIdentitySource

public final String getIdentitySource()

Description copied from interface: CfnAuthorizerProps

The source of the identity in an incoming request.

If you specify TOKEN or COGNITO_USER_POOLS for the Type property, this property is required. Specify a header mapping expression using the form method.request.header. *name* , where name is the name of a custom authorization header that clients submit as part of their requests.

If you specify REQUEST for the Type property, this property is required when authorization caching is enabled. Specify a comma-separated string of one or more mapping expressions of the specified request parameter using the form method.request.parameter. *name* . For supported parameter types, see Configure Lambda Authorizer Using the API Gateway Console in the API Gateway Developer Guide .

Specified by:

getIdentitySource in interface CfnAuthorizerProps

getIdentityValidationExpression

public final String getIdentityValidationExpression()

Description copied from interface: CfnAuthorizerProps

A validation expression for the incoming identity.

If you specify TOKEN for the authorizer's Type property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code.

Specified by:

getIdentityValidationExpression in interface CfnAuthorizerProps

getProviderArns

public final List<String> getProviderArns()

Description copied from interface: CfnAuthorizerProps

A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer.

Required if you specify COGNITO_USER_POOLS as the authorizer Type . For more information, see Use Amazon Cognito User Pools in the API Gateway Developer Guide .

Specified by:

getProviderArns in interface CfnAuthorizerProps

$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