Package software.amazon.awscdk.services.bedrockagentcore

Class ApiKeyCredentialProviderOptions.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.ApiKeyCredentialProviderOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiKeyCredentialProviderOptions>

Enclosing interface:

ApiKeyCredentialProviderOptions

@Stability(Stable)
public static final class ApiKeyCredentialProviderOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ApiKeyCredentialProviderOptions>

A builder for ApiKeyCredentialProviderOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKeyCredentialProviderOptions	build()	Builds the configured instance.
ApiKeyCredentialProviderOptions.Builder	credentialLocation(ApiKeyCredentialLocation credentialLocation)	Sets the value of ApiKeyCredentialProviderOptions.getCredentialLocation()
ApiKeyCredentialProviderOptions.Builder	providerArn(String providerArn)	Sets the value of ApiKeyCredentialProviderOptions.getProviderArn()
ApiKeyCredentialProviderOptions.Builder	secretArn(String secretArn)	Sets the value of ApiKeyCredentialProviderOptions.getSecretArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

providerArn

@Stability(Stable)
public ApiKeyCredentialProviderOptions.Builder providerArn(String providerArn)

Sets the value of ApiKeyCredentialProviderOptions.getProviderArn()

Parameters:

providerArn - The API key credential provider ARN. This parameter is required. This is returned when creating the API key credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name

Returns:

this

secretArn

@Stability(Stable)
public ApiKeyCredentialProviderOptions.Builder secretArn(String secretArn)

Sets the value of ApiKeyCredentialProviderOptions.getSecretArn()

Parameters:

secretArn - The ARN of the Secrets Manager secret containing the API key. This parameter is required. This is returned when creating the API key credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name

Returns:

this

credentialLocation

@Stability(Stable)
public ApiKeyCredentialProviderOptions.Builder credentialLocation(ApiKeyCredentialLocation credentialLocation)

Sets the value of ApiKeyCredentialProviderOptions.getCredentialLocation()

Parameters:

credentialLocation - The location of the API key credential. This field specifies where in the request the API key should be placed.

Returns:

this

build

@Stability(Stable)
public ApiKeyCredentialProviderOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApiKeyCredentialProviderOptions>

Returns:

a new instance of ApiKeyCredentialProviderOptions

Throws:

NullPointerException - if any required attribute was not provided