Class AuthConfig

java.lang.Object
software.amazon.awssdk.services.appintegrations.model.AuthConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AuthConfig.Builder,AuthConfig>
@Generated("software.amazon.awssdk:codegen") public final class AuthConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthConfig.Builder,AuthConfig>

Contains the authentication settings that Connect Customer uses to call an external application endpoint. The configuration includes the authentication type and credential location.

See Also:

  • Method Details

    • authType

      public final AuthType authType()

      The type of authentication used when calling the external application.

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

      Returns:
      The type of authentication used when calling the external application.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The type of authentication used when calling the external application.

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

      Returns:
      The type of authentication used when calling the external application.
      See Also:

    • credentialProviderIdentifier

      public final String credentialProviderIdentifier()

      The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.

      Returns:
      The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.

    • toBuilder

      public AuthConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AuthConfig.Builder,AuthConfig>
      Returns:
      a builder for type T

    • builder

      public static AuthConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AuthConfig.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.