Class: AWSCDK::Kendra::CfnDataSource::WebCrawlerBasicAuthenticationProperty

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

Overview

Provides the configuration information to connect to websites that require basic user authentication.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials:, host:, port:) ⇒ WebCrawlerBasicAuthenticationProperty

Returns a new instance of WebCrawlerBasicAuthenticationProperty.

Parameters:

  • credentials (String) —

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

  • host (String) —

    The name of the website host you want to connect to using authentication credentials.

  • port (Numeric) —

    The port number of the website host you want to connect to using authentication credentials.



3737
3738
3739
3740
3741
3742
3743
3744
 
# File 'kendra/cfn_data_source.rb', line 3737

def initialize(credentials:, host:, port:)
  @credentials = credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentials")
  @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")
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

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

Returns:

  • (String)

See Also:



3754
3755
3756
 
# File 'kendra/cfn_data_source.rb', line 3754

def credentials
  @credentials
end

#host ⇒ String (readonly)

The name of the website host you want to connect to using authentication credentials.

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

Returns:

  • (String)

See Also:



3761
3762
3763
 
# File 'kendra/cfn_data_source.rb', line 3761

def host
  @host
end

#port ⇒ Numeric (readonly)

The port number of the website host you want to connect to using authentication credentials.

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

Returns:

  • (Numeric)

See Also:



3768
3769
3770
 
# File 'kendra/cfn_data_source.rb', line 3768

def port
  @port
end

Class Method Details

.jsii_properties ⇒ Object 



3770
3771
3772
3773
3774
3775
3776
 
# File 'kendra/cfn_data_source.rb', line 3770

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

Instance Method Details

#to_jsii ⇒ Object 



3778
3779
3780
3781
3782
3783
3784
3785
3786
 
# File 'kendra/cfn_data_source.rb', line 3778

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