Class CredentialProvider

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

A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.

See Also:

  • Method Details

    • oauthCredentialProvider

      public final OAuthCredentialProvider oauthCredentialProvider()

      The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

      Returns:
      The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

    • apiKeyCredentialProvider

      public final ApiKeyCredentialProvider apiKeyCredentialProvider()

      The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

      Returns:
      The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

    • iamCredentialProvider

      public final IamCredentialProvider iamCredentialProvider()

      The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

      Returns:
      The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

    • toBuilder

      public CredentialProvider.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<CredentialProvider.Builder,CredentialProvider>
      Returns:
      a builder for type T

    • builder

      public static CredentialProvider.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CredentialProvider.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)

    • fromOauthCredentialProvider

      public static CredentialProvider fromOauthCredentialProvider(OAuthCredentialProvider oauthCredentialProvider)
      Create an instance of this class with oauthCredentialProvider() initialized to the given value.

      The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

      Parameters:
      oauthCredentialProvider - The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

    • fromOauthCredentialProvider

      public static CredentialProvider fromOauthCredentialProvider(Consumer<OAuthCredentialProvider.Builder> oauthCredentialProvider)
      Create an instance of this class with oauthCredentialProvider() initialized to the given value.

      The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

      Parameters:
      oauthCredentialProvider - The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

    • fromApiKeyCredentialProvider

      public static CredentialProvider fromApiKeyCredentialProvider(ApiKeyCredentialProvider apiKeyCredentialProvider)
      Create an instance of this class with apiKeyCredentialProvider() initialized to the given value.

      The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

      Parameters:
      apiKeyCredentialProvider - The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

    • fromApiKeyCredentialProvider

      public static CredentialProvider fromApiKeyCredentialProvider(Consumer<ApiKeyCredentialProvider.Builder> apiKeyCredentialProvider)
      Create an instance of this class with apiKeyCredentialProvider() initialized to the given value.

      The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

      Parameters:
      apiKeyCredentialProvider - The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

    • fromIamCredentialProvider

      public static CredentialProvider fromIamCredentialProvider(IamCredentialProvider iamCredentialProvider)
      Create an instance of this class with iamCredentialProvider() initialized to the given value.

      The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

      Parameters:
      iamCredentialProvider - The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

    • fromIamCredentialProvider

      public static CredentialProvider fromIamCredentialProvider(Consumer<IamCredentialProvider.Builder> iamCredentialProvider)
      Create an instance of this class with iamCredentialProvider() initialized to the given value.

      The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

      Parameters:
      iamCredentialProvider - The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

    • type

      public CredentialProvider.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CredentialProvider.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CredentialProvider.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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