Interface GetResourceOauth2TokenRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BedrockAgentCoreRequest.Builder
,Buildable
,CopyableBuilder<GetResourceOauth2TokenRequest.Builder,
,GetResourceOauth2TokenRequest> SdkBuilder<GetResourceOauth2TokenRequest.Builder,
,GetResourceOauth2TokenRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetResourceOauth2TokenRequest
-
Method Summary
Modifier and TypeMethodDescriptioncustomParameters
(Map<String, String> customParameters) A map of custom parameters to include in the authorization request to the resource credential provider.forceAuthentication
(Boolean forceAuthentication) Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.oauth2Flow
(String oauth2Flow) The type of flow to be performed.oauth2Flow
(Oauth2FlowType oauth2Flow) The type of flow to be performed.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceCredentialProviderName
(String resourceCredentialProviderName) The name of the resource's credential provider.resourceOauth2ReturnUrl
(String resourceOauth2ReturnUrl) The callback URL to redirect to after the OAuth 2.0 token retrieval is complete.The OAuth scopes being requested.scopes
(Collection<String> scopes) The OAuth scopes being requested.workloadIdentityToken
(String workloadIdentityToken) The identity token of the workload from which you want to retrieve the OAuth2 token.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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.
-
overrideConfiguration
GetResourceOauth2TokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-