Class: AWSCDK::Events::Authorization

Inherits:
Jsii::Object
  • Object
show all
Defined in:
events/authorization.rb

Overview

Authorization type for an API Destination Connection.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Authorization

Returns a new instance of Authorization.



8
9
10
 
# File 'events/authorization.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.api_key(api_key_name, api_key_value) ⇒ AWSCDK::Events::Authorization

Use API key authorization.

API key authorization has two components: an API key name and an API key value. What these are depends on the target of your connection.

Parameters:

Returns:

  • (AWSCDK::Events::Authorization) 


25
26
27
28
29
 
# File 'events/authorization.rb', line 25

def self.api_key(api_key_name, api_key_value)
  Jsii::Type.check_type(api_key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeyName")
  Jsii::Type.check_type(api_key_value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "apiKeyValue")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.Authorization", "apiKey", [api_key_name, api_key_value])
end

.basic(username, password) ⇒ AWSCDK::Events::Authorization

Use username and password authorization.

Parameters:

Returns:

  • (AWSCDK::Events::Authorization) 


36
37
38
39
40
 
# File 'events/authorization.rb', line 36

def self.basic(username, password)
  Jsii::Type.check_type(username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username")
  Jsii::Type.check_type(password, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "password")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.Authorization", "basic", [username, password])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
 
# File 'events/authorization.rb', line 12

def self.jsii_overridable_methods
  {
  }
end

.oauth(props) ⇒ AWSCDK::Events::Authorization

Use OAuth authorization.

Parameters:

Returns:

  • (AWSCDK::Events::Authorization) 


46
47
48
49
50
 
# File 'events/authorization.rb', line 46

def self.oauth(props)
  props = props.is_a?(Hash) ? ::AWSCDK::Events::OAuthAuthorizationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9BdXRoQXV0aG9yaXphdGlvblByb3BzIn0=")), "props")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.Authorization", "oauth", [props])
end