Class: AWSCDK::Events::CfnConnection::OAuthParametersProperty

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

Overview

Contains the OAuth authorization parameters to use for the connection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorization_endpoint:, client_parameters:, http_method:, o_auth_http_parameters: nil) ⇒ OAuthParametersProperty

Returns a new instance of OAuthParametersProperty.

Parameters:



976
977
978
979
980
981
982
983
984
985
 
# File 'events/cfn_connection.rb', line 976

def initialize(authorization_endpoint:, client_parameters:, http_method:, o_auth_http_parameters: nil)
  @authorization_endpoint = authorization_endpoint
  Jsii::Type.check_type(@authorization_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizationEndpoint")
  @client_parameters = client_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::ClientParametersProperty.new(**client_parameters.transform_keys(&:to_sym)) : client_parameters
  Jsii::Type.check_type(@client_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5DbGllbnRQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "clientParameters")
  @http_method = http_method
  Jsii::Type.check_type(@http_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpMethod")
  @o_auth_http_parameters = o_auth_http_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::ConnectionHttpParametersProperty.new(**o_auth_http_parameters.transform_keys(&:to_sym)) : o_auth_http_parameters
  Jsii::Type.check_type(@o_auth_http_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5Db25uZWN0aW9uSHR0cFBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "oAuthHttpParameters") unless @o_auth_http_parameters.nil?
end

Instance Attribute Details

#authorization_endpoint ⇒ String (readonly)

The URL to the authorization endpoint when OAuth is specified as the authorization type.

Returns:

  • (String)

See Also:



991
992
993
 
# File 'events/cfn_connection.rb', line 991

def authorization_endpoint
  @authorization_endpoint
end

#client_parameters ⇒ AWSCDK::IResolvable, AWSCDK::Events::CfnConnection::ClientParametersProperty (readonly)

The client parameters for OAuth authorization.

Returns:

See Also:



996
997
998
 
# File 'events/cfn_connection.rb', line 996

def client_parameters
  @client_parameters
end

#http_method ⇒ String (readonly)

The method to use for the authorization request.

Returns:

  • (String)

See Also:



1001
1002
1003
 
# File 'events/cfn_connection.rb', line 1001

def http_method
  @http_method
end

#o_auth_http_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Details about the additional parameters to use for the connection.

Returns:

See Also:



1006
1007
1008
 
# File 'events/cfn_connection.rb', line 1006

def o_auth_http_parameters
  @o_auth_http_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'events/cfn_connection.rb', line 1008

def self.jsii_properties
  {
    :authorization_endpoint => "authorizationEndpoint",
    :client_parameters => "clientParameters",
    :http_method => "httpMethod",
    :o_auth_http_parameters => "oAuthHttpParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'events/cfn_connection.rb', line 1017

def to_jsii
  result = {}
  result.merge!({
    "authorizationEndpoint" => @authorization_endpoint,
    "clientParameters" => @client_parameters,
    "httpMethod" => @http_method,
    "oAuthHttpParameters" => @o_auth_http_parameters,
  })
  result.compact
end