Package software.amazon.awscdk.services.apigateway

Class CfnAuthorizerV2

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnAuthorizerV2

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.749Z")
@Stability(Deprecated)
@Deprecated
public class CfnAuthorizerV2
extends CfnResource
implements IInspectable

Deprecated.

moved to package aws-apigatewayv2

(deprecated) A CloudFormation 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.apigateway.*;
 CfnAuthorizerV2 cfnAuthorizerV2 = CfnAuthorizerV2.Builder.create(this, "MyCfnAuthorizerV2")
         .apiId("apiId")
         .authorizerType("authorizerType")
         .identitySource(List.of("identitySource"))
         .name("name")
         // the properties below are optional
         .authorizerCredentialsArn("authorizerCredentialsArn")
         .authorizerResultTtlInSeconds(123)
         .authorizerUri("authorizerUri")
         .identityValidationExpression("identityValidationExpression")
         .jwtConfiguration(JWTConfigurationProperty.builder()
                 .audience(List.of("audience"))
                 .issuer("issuer")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAuthorizerV2.Builder	Deprecated.
static interface	CfnAuthorizerV2.JWTConfigurationProperty	Deprecated. moved to package aws-apigatewayv2

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAuthorizerV2(Construct scope, String id, CfnAuthorizerV2Props props)	Deprecated.
protected	CfnAuthorizerV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)	Deprecated.
protected	CfnAuthorizerV2(software.amazon.jsii.JsiiObjectRef objRef)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getApiId()	Deprecated.
String	getAuthorizerCredentialsArn()	Deprecated.
Number	getAuthorizerResultTtlInSeconds()	Deprecated.
String	getAuthorizerType()	Deprecated.
String	getAuthorizerUri()	Deprecated.
protected Map<String,Object>	getCfnProperties()	Deprecated.
List<String>	getIdentitySource()	Deprecated.
String	getIdentityValidationExpression()	Deprecated.
Object	getJwtConfiguration()	Deprecated.
String	getName()	Deprecated.
void	inspect(TreeInspector inspector)	Deprecated.
protected Map<String,Object>	renderProperties(Map<String,Object> props)	Deprecated.
void	setApiId(String value)	Deprecated.
void	setAuthorizerCredentialsArn(String value)	Deprecated.
void	setAuthorizerResultTtlInSeconds(Number value)	Deprecated.
void	setAuthorizerType(String value)	Deprecated.
void	setAuthorizerUri(String value)	Deprecated.
void	setIdentitySource(List<String> value)	Deprecated.
void	setIdentityValidationExpression(String value)	Deprecated.
void	setJwtConfiguration(IResolvable value)	Deprecated.
void	setJwtConfiguration(CfnAuthorizerV2.JWTConfigurationProperty value)	Deprecated.
void	setName(String value)	Deprecated.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Deprecated)
@Deprecated
public static final String CFN_RESOURCE_TYPE_NAME

Deprecated.

(deprecated) The CloudFormation resource type name for this resource class.

Constructor Details

CfnAuthorizerV2

protected CfnAuthorizerV2(software.amazon.jsii.JsiiObjectRef objRef)

Deprecated.

CfnAuthorizerV2

protected CfnAuthorizerV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Deprecated.

CfnAuthorizerV2

@Stability(Deprecated)
@Deprecated
public CfnAuthorizerV2(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAuthorizerV2Props props)

Deprecated.

(deprecated) Create a new AWS::ApiGatewayV2::Authorizer.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Deprecated)
@Deprecated
public void inspect(@NotNull
 TreeInspector inspector)

Deprecated.

(deprecated) Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Deprecated)
@Deprecated
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Deprecated.

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Deprecated)
@Deprecated
@NotNull
protected Map<String,Object> getCfnProperties()

Deprecated.

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(Deprecated)
@Deprecated
@NotNull
public String getApiId()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.ApiId.

See Also:

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

setApiId

@Stability(Deprecated)
@Deprecated
public void setApiId(@NotNull
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.ApiId.

See Also:

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

getAuthorizerType

@Stability(Deprecated)
@Deprecated
@NotNull
public String getAuthorizerType()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerType.

See Also:

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

setAuthorizerType

@Stability(Deprecated)
@Deprecated
public void setAuthorizerType(@NotNull
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerType.

See Also:

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

getIdentitySource

@Stability(Deprecated)
@Deprecated
@NotNull
public List<String> getIdentitySource()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentitySource.

See Also:

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

setIdentitySource

@Stability(Deprecated)
@Deprecated
public void setIdentitySource(@NotNull
 List<String> value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentitySource.

See Also:

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

getName

@Stability(Deprecated)
@Deprecated
@NotNull
public String getName()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.Name.

See Also:

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

setName

@Stability(Deprecated)
@Deprecated
public void setName(@NotNull
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.Name.

See Also:

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

getAuthorizerCredentialsArn

@Stability(Deprecated)
@Deprecated
@Nullable
public String getAuthorizerCredentialsArn()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn.

See Also:

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

setAuthorizerCredentialsArn

@Stability(Deprecated)
@Deprecated
public void setAuthorizerCredentialsArn(@Nullable
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn.

See Also:

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

getAuthorizerResultTtlInSeconds

@Stability(Deprecated)
@Deprecated
@Nullable
public Number getAuthorizerResultTtlInSeconds()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds.

See Also:

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

setAuthorizerResultTtlInSeconds

@Stability(Deprecated)
@Deprecated
public void setAuthorizerResultTtlInSeconds(@Nullable
 Number value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds.

See Also:

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

getAuthorizerUri

@Stability(Deprecated)
@Deprecated
@Nullable
public String getAuthorizerUri()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerUri.

See Also:

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

setAuthorizerUri

@Stability(Deprecated)
@Deprecated
public void setAuthorizerUri(@Nullable
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerUri.

See Also:

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

getIdentityValidationExpression

@Stability(Deprecated)
@Deprecated
@Nullable
public String getIdentityValidationExpression()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression.

See Also:

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

setIdentityValidationExpression

@Stability(Deprecated)
@Deprecated
public void setIdentityValidationExpression(@Nullable
 String value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression.

See Also:

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

getJwtConfiguration

@Stability(Deprecated)
@Deprecated
@Nullable
public Object getJwtConfiguration()

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.JwtConfiguration.

See Also:

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

setJwtConfiguration

@Stability(Deprecated)
@Deprecated
public void setJwtConfiguration(@Nullable
 IResolvable value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.JwtConfiguration.

See Also:

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

setJwtConfiguration

@Stability(Deprecated)
@Deprecated
public void setJwtConfiguration(@Nullable
 CfnAuthorizerV2.JWTConfigurationProperty value)

Deprecated.

(deprecated) AWS::ApiGatewayV2::Authorizer.JwtConfiguration.

See Also:

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