Class: AWSCDK::APIGateway::IdentitySource

Inherits:
Jsii::Object
  • Object
show all
Defined in:
api_gateway/identity_source.rb

Overview

Represents an identity source.

The source can be specified either as a literal value (e.g: Auth) which cannot be blank, or as an unresolved string token.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ IdentitySource

Returns a new instance of IdentitySource.



11
12
13
 
# File 'api_gateway/identity_source.rb', line 11

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

Class Method Details

.context(context) ⇒ String

Provides a properly formatted request context identity source.

Parameters:

  • context (String) —

    the name of the context variable the IdentitySource will represent.

Returns:

  • (String) —

    a request context identity source.



24
25
26
27
 
# File 'api_gateway/identity_source.rb', line 24

def self.context(context)
  Jsii::Type.check_type(context, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "context")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.IdentitySource", "context", [context])
end

.header(header_name) ⇒ String

Provides a properly formatted header identity source.

Parameters:

  • header_name (String) —

    the name of the header the IdentitySource will represent.

Returns:

  • (String) —

    a header identity source.



33
34
35
36
 
# File 'api_gateway/identity_source.rb', line 33

def self.header(header_name)
  Jsii::Type.check_type(header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.IdentitySource", "header", [header_name])
end

.jsii_overridable_methods ⇒ Object 



15
16
17
18
 
# File 'api_gateway/identity_source.rb', line 15

def self.jsii_overridable_methods
  {
  }
end

.query_string(query_string) ⇒ String

Provides a properly formatted query string identity source.

Parameters:

  • query_string (String) —

    the name of the query string the IdentitySource will represent.

Returns:

  • (String) —

    a query string identity source.



42
43
44
45
 
# File 'api_gateway/identity_source.rb', line 42

def self.query_string(query_string)
  Jsii::Type.check_type(query_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.IdentitySource", "queryString", [query_string])
end

.stage_variable(stage_variable) ⇒ String

Provides a properly formatted API Gateway stage variable identity source.

Parameters:

  • stage_variable (String) —

    the name of the stage variable the IdentitySource will represent.

Returns:

  • (String) —

    an API Gateway stage variable identity source.



51
52
53
54
 
# File 'api_gateway/identity_source.rb', line 51

def self.stage_variable(stage_variable)
  Jsii::Type.check_type(stage_variable, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageVariable")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.IdentitySource", "stageVariable", [stage_variable])
end