Class: AWSCDK::DevOpsAgent::CfnService::APIKeyDetailsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dev_ops_agent/cfn_service.rb

Overview

API key authentication details.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key_header:, api_key_name:, api_key_value:) ⇒ APIKeyDetailsProperty

Returns a new instance of APIKeyDetailsProperty.

Parameters:

  • api_key_header (String) —

    HTTP header name to send the API key.

  • api_key_name (String) —

    User friendly API key name.

  • api_key_value (String) —

    API key value.



730
731
732
733
734
735
736
737
 
# File 'dev_ops_agent/cfn_service.rb', line 730

def initialize(api_key_header:, api_key_name:, api_key_value:)
  @api_key_header = api_key_header
  Jsii::Type.check_type(@api_key_header, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeyHeader")
  @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_header ⇒ String (readonly)

HTTP header name to send the API key.

Returns:

  • (String)

See Also:



743
744
745
 
# File 'dev_ops_agent/cfn_service.rb', line 743

def api_key_header
  @api_key_header
end

#api_key_name ⇒ String (readonly)

User friendly API key name.

Returns:

  • (String)

See Also:



748
749
750
 
# File 'dev_ops_agent/cfn_service.rb', line 748

def api_key_name
  @api_key_name
end

#api_key_value ⇒ String (readonly)

API key value.

Returns:

  • (String)

See Also:



753
754
755
 
# File 'dev_ops_agent/cfn_service.rb', line 753

def api_key_value
  @api_key_value
end

Class Method Details

.jsii_properties ⇒ Object 



755
756
757
758
759
760
761
 
# File 'dev_ops_agent/cfn_service.rb', line 755

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

Instance Method Details

#to_jsii ⇒ Object 



763
764
765
766
767
768
769
770
771
 
# File 'dev_ops_agent/cfn_service.rb', line 763

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