Interface GetResourceOauth2TokenRequest.Builder

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

  • Method Details

    • workloadIdentityToken

      GetResourceOauth2TokenRequest.Builder workloadIdentityToken(String workloadIdentityToken)

      The identity token of the workload you want to retrive the Oauth2 Token of.

      Parameters:
      workloadIdentityToken - The identity token of the workload you want to retrive the Oauth2 Token of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      GetResourceOauth2TokenRequest.Builder userId(String userId)

      The user ID of the user you're retrieving the token on behalf of.

      Parameters:
      userId - The user ID of the user you're retrieving the token on behalf of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceCredentialProviderName

      GetResourceOauth2TokenRequest.Builder resourceCredentialProviderName(String resourceCredentialProviderName)

      Reference to the credential provider

      Parameters:
      resourceCredentialProviderName - Reference to the credential provider
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      GetResourceOauth2TokenRequest.Builder scopes(Collection<String> scopes)

      The OAuth scopes requested

      Parameters:
      scopes - The OAuth scopes requested
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      GetResourceOauth2TokenRequest.Builder scopes(String... scopes)

      The OAuth scopes requested

      Parameters:
      scopes - The OAuth scopes requested
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oauth2Flow

      GetResourceOauth2TokenRequest.Builder oauth2Flow(String oauth2Flow)

      The type of flow to be performed

      Parameters:
      oauth2Flow - The type of flow to be performed
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • oauth2Flow

      GetResourceOauth2TokenRequest.Builder oauth2Flow(Oauth2FlowType oauth2Flow)

      The type of flow to be performed

      Parameters:
      oauth2Flow - The type of flow to be performed
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceOauth2ReturnUrl

      GetResourceOauth2TokenRequest.Builder resourceOauth2ReturnUrl(String resourceOauth2ReturnUrl)

      Callback url to redirect after token retrieval completes. Should be one of the provideded urls during WorkloadIdentity creation

      Parameters:
      resourceOauth2ReturnUrl - Callback url to redirect after token retrieval completes. Should be one of the provideded urls during WorkloadIdentity creation
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceAuthentication

      GetResourceOauth2TokenRequest.Builder forceAuthentication(Boolean forceAuthentication)

      If true, always initiate a new 3LO flow

      Parameters:
      forceAuthentication - If true, always initiate a new 3LO flow
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customParameters

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

      Gives the ability to send extra/custom parameters to the resource credentials provider during the authorization process. Standard OAuth2 flow parameters will not be overriden.

      Parameters:
      customParameters - Gives the ability to send extra/custom parameters to the resource credentials provider during the authorization process. Standard OAuth2 flow parameters will not be overriden.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetResourceOauth2TokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetResourceOauth2TokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.