BasicAuthenticationConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.BasicAuthenticationConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BasicAuthenticationConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information to connect to websites that require basic user authentication.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BasicAuthenticationConfiguration()

Constructors
Constructor and Description
`BasicAuthenticationConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasicAuthenticationConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCredentials()` Your secret ARN, which you can create in Secrets Manager
`String`	`getHost()` The name of the website host you want to connect to using authentication credentials.
`Integer`	`getPort()` The port number of the website host you want to connect to using authentication credentials.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCredentials(String credentials)` Your secret ARN, which you can create in Secrets Manager
`void`	`setHost(String host)` The name of the website host you want to connect to using authentication credentials.
`void`	`setPort(Integer port)` The port number of the website host you want to connect to using authentication credentials.
`String`	`toString()` Returns a string representation of this object.
`BasicAuthenticationConfiguration`	`withCredentials(String credentials)` Your secret ARN, which you can create in Secrets Manager
`BasicAuthenticationConfiguration`	`withHost(String host)` The name of the website host you want to connect to using authentication credentials.
`BasicAuthenticationConfiguration`	`withPort(Integer port)` The port number of the website host you want to connect to using authentication credentials.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasicAuthenticationConfiguration
```
public BasicAuthenticationConfiguration()
```
- Method Detail
  - setHost
```
public void setHost(String host)
```
    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".
    
    Parameters:
    
    host - 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".
  - getHost
```
public String getHost()
```
    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:
    
    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".
  - withHost
```
public BasicAuthenticationConfiguration withHost(String host)
```
    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".
    
    Parameters:
    
    host - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    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.
    
    Parameters:
    
    port - 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.
  - getPort
```
public Integer getPort()
```
    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:
    
    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.
  - withPort
```
public BasicAuthenticationConfiguration withPort(Integer port)
```
    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.
    
    Parameters:
    
    port - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCredentials
```
public void setCredentials(String credentials)
```
    Your secret ARN, which you can create in 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.
    
    Parameters:
    
    credentials - Your secret ARN, which you can create in 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.
  - getCredentials
```
public String getCredentials()
```
    Your secret ARN, which you can create in 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:
    
    Your secret ARN, which you can create in 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.
  - withCredentials
```
public BasicAuthenticationConfiguration withCredentials(String credentials)
```
    Your secret ARN, which you can create in 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.
    
    Parameters:
    
    credentials - Your secret ARN, which you can create in 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BasicAuthenticationConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BasicAuthenticationConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicAuthenticationConfiguration

Method Detail

setHost

getHost

withHost

setPort

getPort

withPort

setCredentials

getCredentials

withCredentials

toString

equals

hashCode

clone

marshall