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 from which you want to retrieve the OAuth2 token.

      Parameters:
      workloadIdentityToken - The identity token of the workload from which you want to retrieve the OAuth2 token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceCredentialProviderName

      GetResourceOauth2TokenRequest.Builder resourceCredentialProviderName(String resourceCredentialProviderName)

      The name of the resource's credential provider.

      Parameters:
      resourceCredentialProviderName - The name of the resource's 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 being requested.

      Parameters:
      scopes - The OAuth scopes being 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 being requested.

      Parameters:
      scopes - The OAuth scopes being 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:

    • sessionUri

      GetResourceOauth2TokenRequest.Builder sessionUri(String sessionUri)

      Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

      Parameters:
      sessionUri - Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceOauth2ReturnUrl

      GetResourceOauth2TokenRequest.Builder resourceOauth2ReturnUrl(String resourceOauth2ReturnUrl)

      The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.

      Parameters:
      resourceOauth2ReturnUrl - The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceAuthentication

      GetResourceOauth2TokenRequest.Builder forceAuthentication(Boolean forceAuthentication)

      Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.

      Parameters:
      forceAuthentication - Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customParameters

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

      A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.

      Parameters:
      customParameters - A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customState

      GetResourceOauth2TokenRequest.Builder customState(String customState)

      An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.

      Parameters:
      customState - An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.
      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.