Class AuthenticationConfigurationInput

    • Method Detail

      • authenticationType

        public final AuthenticationType authenticationType()

        A structure containing the authentication configuration in the CreateConnection request.

        If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

        Returns:
        A structure containing the authentication configuration in the CreateConnection request.
        See Also:
        AuthenticationType
      • authenticationTypeAsString

        public final String authenticationTypeAsString()

        A structure containing the authentication configuration in the CreateConnection request.

        If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

        Returns:
        A structure containing the authentication configuration in the CreateConnection request.
        See Also:
        AuthenticationType
      • oAuth2Properties

        public final OAuth2PropertiesInput oAuth2Properties()

        The properties for OAuth2 authentication in the CreateConnection request.

        Returns:
        The properties for OAuth2 authentication in the CreateConnection request.
      • secretArn

        public final String secretArn()

        The secret manager ARN to store credentials in the CreateConnection request.

        Returns:
        The secret manager ARN to store credentials in the CreateConnection request.
      • kmsKeyArn

        public final String kmsKeyArn()

        The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

        Returns:
        The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.
      • basicAuthenticationCredentials

        public final BasicAuthenticationCredentials basicAuthenticationCredentials()

        The credentials used when the authentication type is basic authentication.

        Returns:
        The credentials used when the authentication type is basic authentication.
      • hasCustomAuthenticationCredentials

        public final boolean hasCustomAuthenticationCredentials()
        For responses, this returns true if the service returned a value for the CustomAuthenticationCredentials property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • customAuthenticationCredentials

        public final Map<String,​String> customAuthenticationCredentials()

        The credentials used when the authentication type is custom authentication.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomAuthenticationCredentials() method.

        Returns:
        The credentials used when the authentication type is custom authentication.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)