software.amazon.awscdk.services.apigatewayv2

Interface CfnAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.859Z")
 @Stability(value=Stable)
public interface CfnAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGatewayV2::Authorizer`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 CfnAuthorizerProps cfnAuthorizerProps = CfnAuthorizerProps.builder()
         .apiId("apiId")
         .authorizerType("authorizerType")
         .name("name")
         // the properties below are optional
         .authorizerCredentialsArn("authorizerCredentialsArn")
         .authorizerPayloadFormatVersion("authorizerPayloadFormatVersion")
         .authorizerResultTtlInSeconds(123)
         .authorizerUri("authorizerUri")
         .enableSimpleResponses(false)
         .identitySource(List.of("identitySource"))
         .identityValidationExpression("identityValidationExpression")
         .jwtConfiguration(JWTConfigurationProperty.builder()
                 .audience(List.of("audience"))
                 .issuer("issuer")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAuthorizerProps.Builder A builder for CfnAuthorizerProps
static class	CfnAuthorizerProps.Jsii$Proxy An implementation for CfnAuthorizerProps

Method Summary

Modifier and Type	Method and Description
static CfnAuthorizerProps.Builder	builder()
String	getApiId() `AWS::ApiGatewayV2::Authorizer.ApiId`.
default String	getAuthorizerCredentialsArn() `AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn`.
default String	getAuthorizerPayloadFormatVersion() `AWS::ApiGatewayV2::Authorizer.AuthorizerPayloadFormatVersion`.
default Number	getAuthorizerResultTtlInSeconds() `AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds`.
String	getAuthorizerType() `AWS::ApiGatewayV2::Authorizer.AuthorizerType`.
default String	getAuthorizerUri() `AWS::ApiGatewayV2::Authorizer.AuthorizerUri`.
default Object	getEnableSimpleResponses() `AWS::ApiGatewayV2::Authorizer.EnableSimpleResponses`.
default List<String>	getIdentitySource() `AWS::ApiGatewayV2::Authorizer.IdentitySource`.
default String	getIdentityValidationExpression() `AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression`.
default Object	getJwtConfiguration() `AWS::ApiGatewayV2::Authorizer.JwtConfiguration`.
String	getName() `AWS::ApiGatewayV2::Authorizer.Name`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

@Stability(value=Stable)
 @NotNull
String getApiId()

`AWS::ApiGatewayV2::Authorizer.ApiId`.

getAuthorizerCredentialsArn

@Stability(value=Stable)
 @Nullable
default String getAuthorizerCredentialsArn()

`AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn`.

getAuthorizerPayloadFormatVersion

@Stability(value=Stable)
 @Nullable
default String getAuthorizerPayloadFormatVersion()

`AWS::ApiGatewayV2::Authorizer.AuthorizerPayloadFormatVersion`.

getAuthorizerResultTtlInSeconds

@Stability(value=Stable)
 @Nullable
default Number getAuthorizerResultTtlInSeconds()

`AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds`.

getAuthorizerType

@Stability(value=Stable)
 @NotNull
String getAuthorizerType()

`AWS::ApiGatewayV2::Authorizer.AuthorizerType`.

getAuthorizerUri

@Stability(value=Stable)
 @Nullable
default String getAuthorizerUri()

`AWS::ApiGatewayV2::Authorizer.AuthorizerUri`.

getEnableSimpleResponses

@Stability(value=Stable)
 @Nullable
default Object getEnableSimpleResponses()

`AWS::ApiGatewayV2::Authorizer.EnableSimpleResponses`.

getIdentitySource

@Stability(value=Stable)
 @Nullable
default List<String> getIdentitySource()

`AWS::ApiGatewayV2::Authorizer.IdentitySource`.

getIdentityValidationExpression

@Stability(value=Stable)
 @Nullable
default String getIdentityValidationExpression()

`AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression`.

getJwtConfiguration

@Stability(value=Stable)
 @Nullable
default Object getJwtConfiguration()

`AWS::ApiGatewayV2::Authorizer.JwtConfiguration`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::ApiGatewayV2::Authorizer.Name`.

builder

@Stability(value=Stable)
static CfnAuthorizerProps.Builder builder()

Returns:

a CfnAuthorizerProps.Builder of CfnAuthorizerProps