Class OAuthConfiguration.Builder
java.lang.Object
software.amazon.awscdk.services.bedrockagentcore.OAuthConfiguration.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<OAuthConfiguration>
- Enclosing interface:
OAuthConfiguration
@Stability(Stable)
public static final class OAuthConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<OAuthConfiguration>
A builder for
OAuthConfiguration-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.customParameters(Map<String, String> customParameters) Sets the value ofOAuthConfiguration.getCustomParameters()providerArn(String providerArn) Sets the value ofOAuthConfiguration.getProviderArn()Sets the value ofOAuthConfiguration.getScopes()Sets the value ofOAuthConfiguration.getSecretArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
providerArn
Sets the value ofOAuthConfiguration.getProviderArn()- Parameters:
providerArn- The OAuth credential provider ARN. This parameter is required. This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/oauth2credentialprovider/name Required: Yes- Returns:
this
-
scopes
Sets the value ofOAuthConfiguration.getScopes()- Parameters:
scopes- The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider. This parameter is required. Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes- Returns:
this
-
secretArn
Sets the value ofOAuthConfiguration.getSecretArn()- Parameters:
secretArn- The ARN of the Secrets Manager secret containing OAuth credentials (client ID and secret). This parameter is required. This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name Required: Yes- Returns:
this
-
customParameters
@Stability(Stable) public OAuthConfiguration.Builder customParameters(Map<String, String> customParameters) Sets the value ofOAuthConfiguration.getCustomParameters()- Parameters:
customParameters- Custom parameters for the OAuth flow.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<OAuthConfiguration>- Returns:
- a new instance of
OAuthConfiguration - Throws:
NullPointerException- if any required attribute was not provided
-