Package software.amazon.awscdk.services.bedrockagentcore

Class ApiKeyCredentialProvider.Builder

java.lang.Object
software.amazon.awscdk.services.bedrockagentcore.ApiKeyCredentialProvider.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ApiKeyCredentialProvider>
Enclosing class:
ApiKeyCredentialProvider
@Stability(Stable) public static final class ApiKeyCredentialProvider.Builder extends Object implements software.amazon.jsii.Builder<ApiKeyCredentialProvider>
A fluent builder for ApiKeyCredentialProvider.

  • Method Details

    • create

      @Stability(Stable) public static ApiKeyCredentialProvider.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of ApiKeyCredentialProvider.Builder.

    • apiKey

      @Stability(Stable) public ApiKeyCredentialProvider.Builder apiKey(SecretValue apiKey)
      The API key value.

      NOTE: The API key will be included in the CloudFormation template as part of synthesis. The service stores the key in Secrets Manager after creation, but the value is visible in the template and deployment history. Use SecretValue.unsafePlainText() to explicitly acknowledge plaintext, or pass a reference from another construct to avoid embedding the literal value.

      If omitted, you can supply the key through another mechanism supported by the service.

      Default: - no key in template (provider may still be created depending on service behavior)

      Parameters:
      apiKey - The API key value. This parameter is required.
      Returns:
      this

    • apiKeyCredentialProviderName

      @Stability(Stable) public ApiKeyCredentialProvider.Builder apiKeyCredentialProviderName(String apiKeyCredentialProviderName)
      Name of the credential provider.

      Default: a name generated by CDK

      Parameters:
      apiKeyCredentialProviderName - Name of the credential provider. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public ApiKeyCredentialProvider.Builder tags(Map<String,String> tags)
      Tags for this credential provider.

      Default: - no tags

      Parameters:
      tags - Tags for this credential provider. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public ApiKeyCredentialProvider build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ApiKeyCredentialProvider>
      Returns:
      a newly built instance of ApiKeyCredentialProvider.