Class: AWSCDK::Events::CfnConnection::AuthParametersProperty

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

Overview

Tthe authorization parameters to use for the connection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key_auth_parameters: nil, basic_auth_parameters: nil, connectivity_parameters: nil, invocation_http_parameters: nil, o_auth_parameters: nil) ⇒ AuthParametersProperty

Returns a new instance of AuthParametersProperty.

Parameters:



693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'events/cfn_connection.rb', line 693

def initialize(api_key_auth_parameters: nil, basic_auth_parameters: nil, connectivity_parameters: nil, invocation_http_parameters: nil, o_auth_parameters: nil)
  @api_key_auth_parameters = api_key_auth_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::APIKeyAuthParametersProperty.new(**api_key_auth_parameters.transform_keys(&:to_sym)) : api_key_auth_parameters
  Jsii::Type.check_type(@api_key_auth_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5BcGlLZXlBdXRoUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "apiKeyAuthParameters") unless @api_key_auth_parameters.nil?
  @basic_auth_parameters = basic_auth_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::BasicAuthParametersProperty.new(**basic_auth_parameters.transform_keys(&:to_sym)) : basic_auth_parameters
  Jsii::Type.check_type(@basic_auth_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5CYXNpY0F1dGhQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "basicAuthParameters") unless @basic_auth_parameters.nil?
  @connectivity_parameters = connectivity_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::ConnectivityParametersProperty.new(**connectivity_parameters.transform_keys(&:to_sym)) : connectivity_parameters
  Jsii::Type.check_type(@connectivity_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5Db25uZWN0aXZpdHlQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "connectivityParameters") unless @connectivity_parameters.nil?
  @invocation_http_parameters = invocation_http_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::ConnectionHttpParametersProperty.new(**invocation_http_parameters.transform_keys(&:to_sym)) : invocation_http_parameters
  Jsii::Type.check_type(@invocation_http_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5Db25uZWN0aW9uSHR0cFBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "invocationHttpParameters") unless @invocation_http_parameters.nil?
  @o_auth_parameters = o_auth_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::OAuthParametersProperty.new(**o_auth_parameters.transform_keys(&:to_sym)) : o_auth_parameters
  Jsii::Type.check_type(@o_auth_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5PQXV0aFBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "oAuthParameters") unless @o_auth_parameters.nil?
end

Instance Attribute Details

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

The API Key parameters to use for authorization.

Returns:

See Also:



710
711
712
 
# File 'events/cfn_connection.rb', line 710

def api_key_auth_parameters
  @api_key_auth_parameters
end

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

The authorization parameters for Basic authorization.

Returns:

See Also:



715
716
717
 
# File 'events/cfn_connection.rb', line 715

def basic_auth_parameters
  @basic_auth_parameters
end

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

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

Returns:

See Also:



722
723
724
 
# File 'events/cfn_connection.rb', line 722

def connectivity_parameters
  @connectivity_parameters
end

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

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

Returns:

See Also:



727
728
729
 
# File 'events/cfn_connection.rb', line 727

def invocation_http_parameters
  @invocation_http_parameters
end

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

The OAuth parameters to use for authorization.

Returns:

See Also:



732
733
734
 
# File 'events/cfn_connection.rb', line 732

def o_auth_parameters
  @o_auth_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



734
735
736
737
738
739
740
741
742
 
# File 'events/cfn_connection.rb', line 734

def self.jsii_properties
  {
    :api_key_auth_parameters => "apiKeyAuthParameters",
    :basic_auth_parameters => "basicAuthParameters",
    :connectivity_parameters => "connectivityParameters",
    :invocation_http_parameters => "invocationHttpParameters",
    :o_auth_parameters => "oAuthParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



744
745
746
747
748
749
750
751
752
753
754
 
# File 'events/cfn_connection.rb', line 744

def to_jsii
  result = {}
  result.merge!({
    "apiKeyAuthParameters" => @api_key_auth_parameters,
    "basicAuthParameters" => @basic_auth_parameters,
    "connectivityParameters" => @connectivity_parameters,
    "invocationHttpParameters" => @invocation_http_parameters,
    "oAuthParameters" => @o_auth_parameters,
  })
  result.compact
end