Interface OAuthCredentialProvider.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OAuthCredentialProvider.Builder,OAuthCredentialProvider>, SdkBuilder<OAuthCredentialProvider.Builder,OAuthCredentialProvider>, SdkPojo
Enclosing class:
OAuthCredentialProvider
@Mutable @NotThreadSafe public static interface OAuthCredentialProvider.Builder extends SdkPojo, CopyableBuilder<OAuthCredentialProvider.Builder,OAuthCredentialProvider>

  • Method Details

    • providerArn

      OAuthCredentialProvider.Builder providerArn(String providerArn)

      The ARN of the OAuth 2.0 credential provider in AgentCore Identity.

      Parameters:
      providerArn - The ARN of the OAuth 2.0 credential provider in AgentCore Identity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      OAuthCredentialProvider.Builder scopes(Collection<String> scopes)

      The OAuth 2.0 scopes to request when obtaining an access token.

      Parameters:
      scopes - The OAuth 2.0 scopes to request when obtaining an access token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      OAuthCredentialProvider.Builder scopes(String... scopes)

      The OAuth 2.0 scopes to request when obtaining an access token.

      Parameters:
      scopes - The OAuth 2.0 scopes to request when obtaining an access token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customParameters

      OAuthCredentialProvider.Builder customParameters(Map<String,String> customParameters)

      Additional custom parameters to include in the OAuth 2.0 token request.

      Parameters:
      customParameters - Additional custom parameters to include in the OAuth 2.0 token request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantType

      OAuthCredentialProvider.Builder grantType(String grantType)

      The OAuth 2.0 grant type to use for authentication.

      Parameters:
      grantType - The OAuth 2.0 grant type to use for authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • grantType

      OAuthCredentialProvider.Builder grantType(OAuthGrantType grantType)

      The OAuth 2.0 grant type to use for authentication.

      Parameters:
      grantType - The OAuth 2.0 grant type to use for authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultReturnUrl

      OAuthCredentialProvider.Builder defaultReturnUrl(String defaultReturnUrl)

      The default return URL for the OAuth 2.0 authorization flow.

      Parameters:
      defaultReturnUrl - The default return URL for the OAuth 2.0 authorization flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.