Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnApiKeyCredentialProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiKeyCredentialProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-07-02T13:32:33.859Z")
@Stability(Stable)
public interface CfnApiKeyCredentialProviderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApiKeyCredentialProvider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrockagentcore.*;
 CfnApiKeyCredentialProviderProps cfnApiKeyCredentialProviderProps = CfnApiKeyCredentialProviderProps.builder()
         .name("name")
         // the properties below are optional
         .apiKey("apiKey")
         .apiKeySecretConfig(SecretReferenceProperty.builder()
                 .jsonKey("jsonKey")
                 .secretId("secretId")
                 .build())
         .apiKeySecretSource("apiKeySecretSource")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiKeyCredentialProviderProps.Builder	A builder for CfnApiKeyCredentialProviderProps
static final class	CfnApiKeyCredentialProviderProps.Jsii$Proxy	An implementation for CfnApiKeyCredentialProviderProps

Method Summary

Modifier and Type	Method	Description
static CfnApiKeyCredentialProviderProps.Builder	builder()
default String	getApiKey()	The API key to use for authentication.
default Object	getApiKeySecretConfig()	A reference to a customer-provided secret stored in AWS Secrets Manager.
default String	getApiKeySecretSource()	The source of the API key secret.
String	getName()	The name of the API key credential provider.
default List<CfnTag>	getTags()	Tags to assign to the API key credential provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the API key credential provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-name

getApiKey

@Stability(Stable)
@Nullable
default String getApiKey()

The API key to use for authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikey

getApiKeySecretConfig

@Stability(Stable)
@Nullable
default Object getApiKeySecretConfig()

A reference to a customer-provided secret stored in AWS Secrets Manager.

Returns union: either IResolvable or CfnApiKeyCredentialProvider.SecretReferenceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretconfig

getApiKeySecretSource

@Stability(Stable)
@Nullable
default String getApiKeySecretSource()

The source of the API key secret.

Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretsource

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to assign to the API key credential provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-tags

builder

@Stability(Stable)
static CfnApiKeyCredentialProviderProps.Builder builder()

Returns:

a CfnApiKeyCredentialProviderProps.Builder of CfnApiKeyCredentialProviderProps