Class: AWSCDK::Kendra::CfnDataSource::ProxyConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

Provides the configuration information for a web proxy to connect to website hosts.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host:, port:, credentials: nil) ⇒ ProxyConfigurationProperty

Returns a new instance of ProxyConfigurationProperty.

Parameters:

  • host (String) —

    The name of the website host you want to connect to via a web proxy server.

  • port (Numeric) —

    The port number of the website host you want to connect to via a web proxy server.

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

    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.



2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'kendra/cfn_data_source.rb', line 2475

def initialize(host:, port:, credentials: nil)
  @host = host
  Jsii::Type.check_type(@host, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "host")
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port")
  @credentials = credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentials") unless @credentials.nil?
end

Instance Attribute Details

#credentials ⇒ String? (readonly)

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.

You create a secret to store your credentials in AWS Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

Returns:

  • (String, nil)

See Also:



2506
2507
2508
 
# File 'kendra/cfn_data_source.rb', line 2506

def credentials
  @credentials
end

#host ⇒ String (readonly)

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

Returns:

  • (String)

See Also:



2490
2491
2492
 
# File 'kendra/cfn_data_source.rb', line 2490

def host
  @host
end

#port ⇒ Numeric (readonly)

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

Returns:

  • (Numeric)

See Also:



2497
2498
2499
 
# File 'kendra/cfn_data_source.rb', line 2497

def port
  @port
end

Class Method Details

.jsii_properties ⇒ Object 



2508
2509
2510
2511
2512
2513
2514
 
# File 'kendra/cfn_data_source.rb', line 2508

def self.jsii_properties
  {
    :host => "host",
    :port => "port",
    :credentials => "credentials",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2516
2517
2518
2519
2520
2521
2522
2523
2524
 
# File 'kendra/cfn_data_source.rb', line 2516

def to_jsii
  result = {}
  result.merge!({
    "host" => @host,
    "port" => @port,
    "credentials" => @credentials,
  })
  result.compact
end