Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnAuthorizerMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnAuthorizerMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnAuthorizerMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAuthorizerMixinProps

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

An implementation for CfnAuthorizerMixinProps

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.cfnpropertymixins.services.apigateway.CfnAuthorizerMixinProps

CfnAuthorizerMixinProps.Builder, CfnAuthorizerMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAuthorizerMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAuthorizerMixinProps.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	getAuthorizerCredentials()	Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
final Number	getAuthorizerResultTtlInSeconds()	The TTL in seconds of cached authorizer results.
final String	getAuthorizerUri()	Specifies the authorizer's Uniform Resource Identifier (URI).
final String	getAuthType()	Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
final String	getIdentitySource()	The identity source for which authorization is requested.
final String	getIdentityValidationExpression()	A validation expression for the incoming identity token.
final String	getName()	The name of the authorizer.
final List<Object>	getProviderArns()	A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
final Object	getRestApiId()	The string identifier of the associated RestApi.
final String	getType()	The authorizer type.
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(CfnAuthorizerMixinProps.Builder builder)

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

Method Details

getAuthorizerCredentials

public final Object getAuthorizerCredentials()

Description copied from interface: CfnAuthorizerMixinProps

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.

Returns union: either String or IRoleRef

Specified by:

getAuthorizerCredentials in interface CfnAuthorizerMixinProps

See Also:

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

getAuthorizerResultTtlInSeconds

public final Number getAuthorizerResultTtlInSeconds()

Description copied from interface: CfnAuthorizerMixinProps

The TTL in seconds of cached authorizer results.

If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Specified by:

getAuthorizerResultTtlInSeconds in interface CfnAuthorizerMixinProps

See Also:

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

getAuthorizerUri

public final String getAuthorizerUri()

Description copied from interface: CfnAuthorizerMixinProps

Specifies the authorizer's Uniform Resource Identifier (URI).

For TOKEN or 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 CfnAuthorizerMixinProps

See Also:

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

getAuthType

public final String getAuthType()

Description copied from interface: CfnAuthorizerMixinProps

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Specified by:

getAuthType in interface CfnAuthorizerMixinProps

See Also:

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

getIdentitySource

public final String getIdentitySource()

Description copied from interface: CfnAuthorizerMixinProps

The identity source for which authorization is requested.

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Specified by:

getIdentitySource in interface CfnAuthorizerMixinProps

See Also:

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

getIdentityValidationExpression

public final String getIdentityValidationExpression()

Description copied from interface: CfnAuthorizerMixinProps

A validation expression for the incoming identity token.

For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Specified by:

getIdentityValidationExpression in interface CfnAuthorizerMixinProps

See Also:

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

getName

public final String getName()

Description copied from interface: CfnAuthorizerMixinProps

The name of the authorizer.

Specified by:

getName in interface CfnAuthorizerMixinProps

See Also:

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

getProviderArns

public final List<Object> getProviderArns()

Description copied from interface: CfnAuthorizerMixinProps

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.

Returns union: Listinvalid input: '<'either String or IUserPoolRef>

Specified by:

getProviderArns in interface CfnAuthorizerMixinProps

See Also:

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

getRestApiId

public final Object getRestApiId()

Description copied from interface: CfnAuthorizerMixinProps

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

Specified by:

getRestApiId in interface CfnAuthorizerMixinProps

See Also:

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

getType

public final String getType()

Description copied from interface: CfnAuthorizerMixinProps

The authorizer type.

Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Specified by:

getType in interface CfnAuthorizerMixinProps

See Also:

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

$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