WebSocketAuthorizer L2 construct
An authorizer for WebSocket Apis.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const webSocketApi: apigatewayv2.WebSocketApi;
const webSocketAuthorizer = new apigatewayv2.WebSocketAuthorizer(this, 'MyWebSocketAuthorizer', {
identitySource: ['identitySource'],
type: apigatewayv2.WebSocketAuthorizerType.LAMBDA,
webSocketApi: webSocketApi,
// the properties below are optional
authorizerName: 'authorizerName',
authorizerUri: 'authorizerUri',
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2
# web_socket_api: apigatewayv2.WebSocketApi
web_socket_authorizer = apigatewayv2.WebSocketAuthorizer(self, "MyWebSocketAuthorizer",
identity_source=["identitySource"],
type=apigatewayv2.WebSocketAuthorizerType.LAMBDA,
web_socket_api=web_socket_api,
# the properties below are optional
authorizer_name="authorizerName",
authorizer_uri="authorizerUri"
)
// 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.*;
WebSocketApi webSocketApi;
WebSocketAuthorizer webSocketAuthorizer = WebSocketAuthorizer.Builder.create(this, "MyWebSocketAuthorizer")
.identitySource(List.of("identitySource"))
.type(WebSocketAuthorizerType.LAMBDA)
.webSocketApi(webSocketApi)
// the properties below are optional
.authorizerName("authorizerName")
.authorizerUri("authorizerUri")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
WebSocketApi webSocketApi;
var webSocketAuthorizer = new WebSocketAuthorizer(this, "MyWebSocketAuthorizer", new WebSocketAuthorizerProps {
IdentitySource = new [] { "identitySource" },
Type = WebSocketAuthorizerType.LAMBDA,
WebSocketApi = webSocketApi,
// the properties below are optional
AuthorizerName = "authorizerName",
AuthorizerUri = "authorizerUri"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var webSocketApi WebSocketApi
webSocketAuthorizer := awscdk.Aws_apigatewayv2.NewWebSocketAuthorizer(this, jsii.String("MyWebSocketAuthorizer"), &WebSocketAuthorizerProps{
IdentitySource: []*string{
jsii.String("identitySource"),
},
Type: awscdk.*Aws_apigatewayv2.WebSocketAuthorizerType_LAMBDA,
WebSocketApi: webSocketApi,
// the properties below are optional
AuthorizerName: jsii.String("authorizerName"),
AuthorizerUri: jsii.String("authorizerUri"),
})
Initializer
new WebSocketAuthorizer(scope: Construct, id: string, props: WebSocketAuthorizerProps)
WebSocketAuthorizer(scope: Construct, id: str, props: WebSocketAuthorizerProps)
new WebSocketAuthorizer(Construct scope, String id, WebSocketAuthorizerProps props)
new WebSocketAuthorizer(Construct scope, string id, WebSocketAuthorizerProps props)
NewWebSocketAuthorizer(Scope Construct, Id *string, Props WebSocketAuthorizerProps)
Construct Props
authorizerNamestringauthorizer_namestrauthorizerNameStringAuthorizerNamestringAuthorizerName*string= id of the WebSocketAuthorizer co…#default
Default: id of the WebSocketAuthorizer construct.
authorizerUristringauthorizer_uristrauthorizerUriStringAuthorizerUristringAuthorizerUri*string= required for Request authorizer …#For REQUEST authorizers, this must be a well-formed Lambda function URI.
default
Default: required for Request authorizer types
identitySourcestring[]identity_sourcetyping.List[str]identitySourceList<String>IdentitySourcestring[]IdentitySource*[]*stringrequired#typeWebSocketAuthorizerTypetypeWebSocketAuthorizerTypetypeWebSocketAuthorizerTypeTypeWebSocketAuthorizerTypeTypeWebSocketAuthorizerTyperequired#webSocketApiIWebSocketApiweb_socket_apiIWebSocketApiwebSocketApiIWebSocketApiWebSocketApiIWebSocketApiWebSocketApiIWebSocketApirequired#Properties
authorizerRefAuthorizerReferenceauthorizer_refAuthorizerReferenceauthorizerRefAuthorizerReferenceAuthorizerRefAuthorizerReferenceAuthorizerRefAuthorizerReferencerequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromWebSocketAuthorizerAttributes(scope: Construct, id: string, attrs: WebSocketAuthorizerAttributes): IWebSocketRouteAuthorizer@staticmethod def from_web_socket_authorizer_attributes(scope: Construct, id: str, attrs: WebSocketAuthorizerAttributes) -> IWebSocketRouteAuthorizerpublic static IWebSocketRouteAuthorizer fromWebSocketAuthorizerAttributes(Construct scope, String id, WebSocketAuthorizerAttributes attrs)public static IWebSocketRouteAuthorizer FromWebSocketAuthorizerAttributes(Construct scope, string id, WebSocketAuthorizerAttributes attrs)func FromWebSocketAuthorizerAttributes(Scope Construct, Id *string, Attrs WebSocketAuthorizerAttributes) IWebSocketRouteAuthorizerstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.