Class: AWSCDK::APIGatewayv2::WebSocketAuthorizerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/web_socket_authorizer_props.rb

Overview

Properties to initialize an instance of WebSocketAuthorizer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_source:, type:, web_socket_api:, authorizer_name: nil, authorizer_uri: nil) ⇒ WebSocketAuthorizerProps

Returns a new instance of WebSocketAuthorizerProps.

Parameters:

  • identity_source (Array<String>) —

    The identity source for which authorization is requested.

  • type (AWSCDK::APIGatewayv2::WebSocketAuthorizerType) —

    The type of authorizer.

  • web_socket_api (AWSCDK::APIGatewayv2::IWebSocketAPI) —

    WebSocket Api to attach the authorizer to.

  • authorizer_name (String, nil) (defaults to: nil) —

    Name of the authorizer.

  • authorizer_uri (String, nil) (defaults to: nil) —

    The authorizer's Uniform Resource Identifier (URI).



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 12

def initialize(identity_source:, type:, web_socket_api:, authorizer_name: nil, authorizer_uri: nil)
  @identity_source = identity_source
  Jsii::Type.check_type(@identity_source, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "identitySource")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldEF1dGhvcml6ZXJUeXBlIn0=")), "type")
  @web_socket_api = web_socket_api
  Jsii::Type.check_type(@web_socket_api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLklXZWJTb2NrZXRBcGkifQ==")), "webSocketApi")
  @authorizer_name = authorizer_name
  Jsii::Type.check_type(@authorizer_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerName") unless @authorizer_name.nil?
  @authorizer_uri = authorizer_uri
  Jsii::Type.check_type(@authorizer_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerUri") unless @authorizer_uri.nil?
end

Instance Attribute Details

#authorizer_name ⇒ String? (readonly)

Note:

Default: - id of the WebSocketAuthorizer construct.

Name of the authorizer.

Returns:

  • (String, nil) 


42
43
44
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 42

def authorizer_name
  @authorizer_name
end

#authorizer_uri ⇒ String? (readonly)

Note:

Default: - required for Request authorizer types

The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI.

Returns:

  • (String, nil) 


49
50
51
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 49

def authorizer_uri
  @authorizer_uri
end

#identity_source ⇒ Array<String> (readonly)

The identity source for which authorization is requested.

Returns:

  • (Array<String>)

See Also:



29
30
31
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 29

def identity_source
  @identity_source
end

#type ⇒ AWSCDK::APIGatewayv2::WebSocketAuthorizerType (readonly)

The type of authorizer.

Returns:



33
34
35
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 33

def type
  @type
end

#web_socket_api ⇒ AWSCDK::APIGatewayv2::IWebSocketAPI (readonly)

WebSocket Api to attach the authorizer to.

Returns:



37
38
39
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 37

def web_socket_api
  @web_socket_api
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 51

def self.jsii_properties
  {
    :identity_source => "identitySource",
    :type => "type",
    :web_socket_api => "webSocketApi",
    :authorizer_name => "authorizerName",
    :authorizer_uri => "authorizerUri",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'api_gatewayv2/web_socket_authorizer_props.rb', line 61

def to_jsii
  result = {}
  result.merge!({
    "identitySource" => @identity_source,
    "type" => @type,
    "webSocketApi" => @web_socket_api,
    "authorizerName" => @authorizer_name,
    "authorizerUri" => @authorizer_uri,
  })
  result.compact
end