Class: AWSCDK::APIGatewayv2::CfnAuthorizer::JWTConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGatewayv2::CfnAuthorizer::JWTConfigurationProperty

Defined in:

api_gatewayv2/cfn_authorizer.rb

Overview

The JWTConfiguration property specifies the configuration of a JWT authorizer.

Required for the JWT authorizer type. Supported only for HTTP APIs.

See Also:

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

Instance Attribute Summary

• #audience ⇒ Array<String>^? readonly

  A list of the intended recipients of the JWT.

• #issuer ⇒ String^? readonly

  The base domain of the identity provider that issues JSON Web Tokens.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(audience: nil, issuer: nil) ⇒ JWTConfigurationProperty constructor

  A new instance of JWTConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(audience: nil, issuer: nil) ⇒ JWTConfigurationProperty

Returns a new instance of JWTConfigurationProperty.

Parameters:

• audience (Array<String>, nil) (defaults to: nil) —

  A list of the intended recipients of the JWT.

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

  The base domain of the identity provider that issues JSON Web Tokens.

# File 'api_gatewayv2/cfn_authorizer.rb', line 636

def initialize(audience: nil, issuer: nil)
  @audience = audience
  Jsii::Type.check_type(@audience, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "audience") unless @audience.nil?
  @issuer = issuer
  Jsii::Type.check_type(@issuer, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "issuer") unless @issuer.nil?
end

Instance Attribute Details

#audience ⇒ Array<String>^? (readonly)

A list of the intended recipients of the JWT.

A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519 . Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

• (Array<String>, nil)

See Also:

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

# File 'api_gatewayv2/cfn_authorizer.rb', line 649

def audience
  @audience
end

#issuer ⇒ String^? (readonly)

The base domain of the identity provider that issues JSON Web Tokens.

For example, an Amazon Cognito user pool has the following format: https://cognito-idp. {region} .amazonaws.com/ {userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

• (String, nil)

See Also:

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

# File 'api_gatewayv2/cfn_authorizer.rb', line 656

def issuer
  @issuer
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gatewayv2/cfn_authorizer.rb', line 658

def self.jsii_properties
  {
    :audience => "audience",
    :issuer => "issuer",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gatewayv2/cfn_authorizer.rb', line 665

def to_jsii
  result = {}
  result.merge!({
    "audience" => @audience,
    "issuer" => @issuer,
  })
  result.compact
end