Class: AWSCDK::Events::CfnConnection::APIKeyAuthParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Events::CfnConnection::APIKeyAuthParametersProperty

Defined in:

events/cfn_connection.rb

Overview

The API key authorization parameters for the connection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html

Instance Attribute Summary

• #api_key_name ⇒ String readonly

  The name of the API key to use for authorization.

• #api_key_value ⇒ String readonly

  The value for the API key to use for authorization.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(api_key_name:, api_key_value:) ⇒ APIKeyAuthParametersProperty constructor

  A new instance of APIKeyAuthParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(api_key_name:, api_key_value:) ⇒ APIKeyAuthParametersProperty

Returns a new instance of APIKeyAuthParametersProperty.

Parameters:

• api_key_name (String) —

  The name of the API key to use for authorization.

• api_key_value (String) —

  The value for the API key to use for authorization.

# File 'events/cfn_connection.rb', line 647

def initialize(api_key_name:, api_key_value:)
  @api_key_name = api_key_name
  Jsii::Type.check_type(@api_key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeyName")
  @api_key_value = api_key_value
  Jsii::Type.check_type(@api_key_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeyValue")
end

Instance Attribute Details

#api_key_name ⇒ String (readonly)

The name of the API key to use for authorization.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname

# File 'events/cfn_connection.rb', line 658

def api_key_name
  @api_key_name
end

#api_key_value ⇒ String (readonly)

The value for the API key to use for authorization.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue

# File 'events/cfn_connection.rb', line 663

def api_key_value
  @api_key_value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'events/cfn_connection.rb', line 665

def self.jsii_properties
  {
    :api_key_name => "apiKeyName",
    :api_key_value => "apiKeyValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'events/cfn_connection.rb', line 672

def to_jsii
  result = {}
  result.merge!({
    "apiKeyName" => @api_key_name,
    "apiKeyValue" => @api_key_value,
  })
  result.compact
end