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 Details

    • Builder

      public Builder()
  • Method Details

    • providerArn

      @Stability(Stable) public OAuthConfiguration.Builder providerArn(String providerArn)
      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

      @Stability(Stable) public OAuthConfiguration.Builder scopes(List<String> scopes)
      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

      @Stability(Stable) public OAuthConfiguration.Builder secretArn(String secretArn)
      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)
      Parameters:
      customParameters - Custom parameters for the OAuth flow.
      Returns:
      this
    • build

      @Stability(Stable) public OAuthConfiguration build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<OAuthConfiguration>
      Returns:
      a new instance of OAuthConfiguration
      Throws:
      NullPointerException - if any required attribute was not provided