Interface UpdateApiKeyCredentialProviderRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>, SdkBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateApiKeyCredentialProviderRequest

@Mutable
@NotThreadSafe
public static interface UpdateApiKeyCredentialProviderRequest.Builder
extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>

Method Summary

Modifier and Type	Method	Description
UpdateApiKeyCredentialProviderRequest.Builder	apiKey(String apiKey)	The new API key to use for authentication.
default UpdateApiKeyCredentialProviderRequest.Builder	apiKeySecretConfig(Consumer<SecretReference.Builder> apiKeySecretConfig)	A reference to the Amazon Web Services Secrets Manager secret that stores the API key.
UpdateApiKeyCredentialProviderRequest.Builder	apiKeySecretConfig(SecretReference apiKeySecretConfig)	A reference to the Amazon Web Services Secrets Manager secret that stores the API key.
UpdateApiKeyCredentialProviderRequest.Builder	apiKeySecretSource(String apiKeySecretSource)	The source type of the API key secret.
UpdateApiKeyCredentialProviderRequest.Builder	apiKeySecretSource(SecretSourceType apiKeySecretSource)	The source type of the API key secret.
UpdateApiKeyCredentialProviderRequest.Builder	name(String name)	The name of the API key credential provider to update.
UpdateApiKeyCredentialProviderRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateApiKeyCredentialProviderRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest.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

name

UpdateApiKeyCredentialProviderRequest.Builder name(String name)

The name of the API key credential provider to update.

Parameters:

name - The name of the API key credential provider to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiKey

UpdateApiKeyCredentialProviderRequest.Builder apiKey(String apiKey)

The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

Parameters:

apiKey - The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiKeySecretConfig

UpdateApiKeyCredentialProviderRequest.Builder apiKeySecretConfig(SecretReference apiKeySecretConfig)

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

Parameters:

apiKeySecretConfig - A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiKeySecretConfig

default UpdateApiKeyCredentialProviderRequest.Builder apiKeySecretConfig(Consumer<SecretReference.Builder> apiKeySecretConfig)

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

This is a convenience method that creates an instance of the SecretReference.Builder avoiding the need to create one manually via SecretReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to apiKeySecretConfig(SecretReference).

Parameters:

apiKeySecretConfig - a consumer that will call methods on SecretReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• apiKeySecretConfig(SecretReference)

apiKeySecretSource

UpdateApiKeyCredentialProviderRequest.Builder apiKeySecretSource(String apiKeySecretSource)

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Parameters:

apiKeySecretSource - The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SecretSourceType
• SecretSourceType

apiKeySecretSource

UpdateApiKeyCredentialProviderRequest.Builder apiKeySecretSource(SecretSourceType apiKeySecretSource)

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Parameters:

apiKeySecretSource - The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SecretSourceType
• SecretSourceType

overrideConfiguration

UpdateApiKeyCredentialProviderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateApiKeyCredentialProviderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.