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 Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

      Parameters:
      providerArn - The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      OAuthCredentialProvider.Builder scopes(Collection<String> scopes)

      The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

      Parameters:
      scopes - The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      OAuthCredentialProvider.Builder scopes(String... scopes)

      The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

      Parameters:
      scopes - The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customParameters

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

      The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

      Parameters:
      customParameters - The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantType

      OAuthCredentialProvider.Builder grantType(String grantType)

      Specifies the kind of credentials to use for authorization:

      • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

      • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

      Parameters:
      grantType - Specifies the kind of credentials to use for authorization:

      • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

      • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • grantType

      OAuthCredentialProvider.Builder grantType(OAuthGrantType grantType)

      Specifies the kind of credentials to use for authorization:

      • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

      • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

      Parameters:
      grantType - Specifies the kind of credentials to use for authorization:

      • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

      • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultReturnUrl

      OAuthCredentialProvider.Builder defaultReturnUrl(String defaultReturnUrl)

      The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

      Parameters:
      defaultReturnUrl - The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.