Class: AWSCDK::BedrockAgentCore::CfnGatewayTarget::APIKeyCredentialProviderProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock_agent_core/cfn_gateway_target.rb

Overview

The API key credential provider for the gateway target.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider_arn:, credential_location: nil, credential_parameter_name: nil, credential_prefix: nil) ⇒ APIKeyCredentialProviderProperty

Returns a new instance of APIKeyCredentialProviderProperty.

Parameters:

  • provider_arn (String) —

    The provider ARN for the gateway target.

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

    The credential location for the gateway target.

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

    The credential parameter name for the provider for the gateway target.

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

    The API key credential provider for the gateway target.



818
819
820
821
822
823
824
825
826
827
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 818

def initialize(provider_arn:, credential_location: nil, credential_parameter_name: nil, credential_prefix: nil)
  @provider_arn = provider_arn
  Jsii::Type.check_type(@provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "providerArn")
  @credential_location = credential_location
  Jsii::Type.check_type(@credential_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialLocation") unless @credential_location.nil?
  @credential_parameter_name = credential_parameter_name
  Jsii::Type.check_type(@credential_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialParameterName") unless @credential_parameter_name.nil?
  @credential_prefix = credential_prefix
  Jsii::Type.check_type(@credential_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialPrefix") unless @credential_prefix.nil?
end

Instance Attribute Details

#credential_location ⇒ String? (readonly)

The credential location for the gateway target.

Returns:

  • (String, nil)

See Also:



838
839
840
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 838

def credential_location
  @credential_location
end

#credential_parameter_name ⇒ String? (readonly)

The credential parameter name for the provider for the gateway target.

Returns:

  • (String, nil)

See Also:



843
844
845
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 843

def credential_parameter_name
  @credential_parameter_name
end

#credential_prefix ⇒ String? (readonly)

The API key credential provider for the gateway target.

Returns:

  • (String, nil)

See Also:



848
849
850
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 848

def credential_prefix
  @credential_prefix
end

#provider_arn ⇒ String (readonly)

The provider ARN for the gateway target.

Returns:

  • (String)

See Also:



833
834
835
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 833

def provider_arn
  @provider_arn
end

Class Method Details

.jsii_properties ⇒ Object 



850
851
852
853
854
855
856
857
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 850

def self.jsii_properties
  {
    :provider_arn => "providerArn",
    :credential_location => "credentialLocation",
    :credential_parameter_name => "credentialParameterName",
    :credential_prefix => "credentialPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



859
860
861
862
863
864
865
866
867
868
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 859

def to_jsii
  result = {}
  result.merge!({
    "providerArn" => @provider_arn,
    "credentialLocation" => @credential_location,
    "credentialParameterName" => @credential_parameter_name,
    "credentialPrefix" => @credential_prefix,
  })
  result.compact
end