Class CfnDataSource.WebCrawlerBasicAuthenticationProperty

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

Inheritance
object
CfnDataSource.WebCrawlerBasicAuthenticationProperty
Inherited Members
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSource.WebCrawlerBasicAuthenticationProperty : CfnDataSource.IWebCrawlerBasicAuthenticationProperty
Syntax (vb)
Public Class CfnDataSource.WebCrawlerBasicAuthenticationProperty Implements CfnDataSource.IWebCrawlerBasicAuthenticationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var webCrawlerBasicAuthenticationProperty = new WebCrawlerBasicAuthenticationProperty {
                 Credentials = "credentials",
                 Host = "host",
                 Port = 123
             };

Synopsis

Constructors

WebCrawlerBasicAuthenticationProperty()

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

Properties

Credentials

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

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

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

Constructors

WebCrawlerBasicAuthenticationProperty()

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

public WebCrawlerBasicAuthenticationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var webCrawlerBasicAuthenticationProperty = new WebCrawlerBasicAuthenticationProperty {
                 Credentials = "credentials",
                 Host = "host",
                 Port = 123
             };

Properties

Credentials

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

public string Credentials { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-credentials

Host

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

public string Host { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-host

Port

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

public double Port { get; set; }
Property Value

double

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-port

Implements