Class: AWSCDK::AppFlow::CfnConnectorProfile::APIKeyCredentialsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::AppFlow::CfnConnectorProfile::APIKeyCredentialsProperty

Defined in:

app_flow/cfn_connector_profile.rb

Overview

The API key credentials required for API key authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html

Instance Attribute Summary

• #api_key ⇒ String readonly

  The API key required for API key authentication.

• #api_secret_key ⇒ String^? readonly

  The API secret key required for API key authentication.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(api_key:, api_secret_key: nil) ⇒ APIKeyCredentialsProperty constructor

  A new instance of APIKeyCredentialsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(api_key:, api_secret_key: nil) ⇒ APIKeyCredentialsProperty

Returns a new instance of APIKeyCredentialsProperty.

Parameters:

• api_key (String) —

  The API key required for API key authentication.

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

  The API secret key required for API key authentication.

# File 'app_flow/cfn_connector_profile.rb', line 629

def initialize(api_key:, api_secret_key: nil)
  @api_key = api_key
  Jsii::Type.check_type(@api_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKey")
  @api_secret_key = api_secret_key
  Jsii::Type.check_type(@api_secret_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiSecretKey") unless @api_secret_key.nil?
end

Instance Attribute Details

#api_key ⇒ String (readonly)

The API key required for API key authentication.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apikey

# File 'app_flow/cfn_connector_profile.rb', line 640

def api_key
  @api_key
end

#api_secret_key ⇒ String^? (readonly)

The API secret key required for API key authentication.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apisecretkey

# File 'app_flow/cfn_connector_profile.rb', line 645

def api_secret_key
  @api_secret_key
end

Class Method Details

.jsii_properties ⇒ Object

# File 'app_flow/cfn_connector_profile.rb', line 647

def self.jsii_properties
  {
    :api_key => "apiKey",
    :api_secret_key => "apiSecretKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'app_flow/cfn_connector_profile.rb', line 654

def to_jsii
  result = {}
  result.merge!({
    "apiKey" => @api_key,
    "apiSecretKey" => @api_secret_key,
  })
  result.compact
end