ApiKeyCredentialProvider L2 construct
L2 construct for AWS::BedrockAgentCore::ApiKeyCredentialProvider.
Use this to register an API key identity in AgentCore Token Vault. To attach the identity to a gateway target, use {@link GatewayCredentialProvider.fromApiKeyIdentity } with this construct, or {@link ApiKeyCredentialProvider.bindForGatewayApiKeyTarget} with {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.
Example
ts
const gateway = new agentcore.Gateway(this, "MyGateway", {
gatewayName: "my-gateway",
});
// Create an API key credential provider in Token Vault
const apiKeyProvider = new agentcore.ApiKeyCredentialProvider(this, "MyApiKeyProvider", {
apiKeyCredentialProviderName: "my-apikey",
});
const bucket = s3.Bucket.fromBucketName(this, "ExistingBucket", "my-schema-bucket");
const s3mySchema = agentcore.ApiSchema.fromS3File(bucket, "schemas/myschema.yaml");
// Add an OpenAPI target using the L2 construct directly
const target = gateway.addOpenApiTarget("MyTarget", {
gatewayTargetName: "my-api-target",
description: "Target for external API integration",
apiSchema: s3mySchema,
credentialProviderConfigurations: [
agentcore.GatewayCredentialProvider.fromApiKeyIdentity(apiKeyProvider, {
credentialLocation: agentcore.ApiKeyCredentialLocation.header({
credentialParameterName: "X-API-Key",
}),
}),
],
});
// This makes sure your s3 bucket is available before target
target.node.addDependency(bucket);
python
gateway = agentcore.Gateway(self, "MyGateway",
gateway_name="my-gateway"
)
# Create an API key credential provider in Token Vault
api_key_provider = agentcore.ApiKeyCredentialProvider(self, "MyApiKeyProvider",
api_key_credential_provider_name="my-apikey"
)
bucket = s3.Bucket.from_bucket_name(self, "ExistingBucket", "my-schema-bucket")
s3my_schema = agentcore.ApiSchema.from_s3_file(bucket, "schemas/myschema.yaml")
# Add an OpenAPI target using the L2 construct directly
target = gateway.add_open_api_target("MyTarget",
gateway_target_name="my-api-target",
description="Target for external API integration",
api_schema=s3my_schema,
credential_provider_configurations=[
agentcore.GatewayCredentialProvider.from_api_key_identity(api_key_provider,
credential_location=agentcore.ApiKeyCredentialLocation.header(
credential_parameter_name="X-API-Key"
)
)
]
)
# This makes sure your s3 bucket is available before target
target.node.add_dependency(bucket)
java
Gateway gateway = Gateway.Builder.create(this, "MyGateway")
.gatewayName("my-gateway")
.build();
// Create an API key credential provider in Token Vault
ApiKeyCredentialProvider apiKeyProvider = ApiKeyCredentialProvider.Builder.create(this, "MyApiKeyProvider")
.apiKeyCredentialProviderName("my-apikey")
.build();
IBucket bucket = Bucket.fromBucketName(this, "ExistingBucket", "my-schema-bucket");
S3ApiSchema s3mySchema = ApiSchema.fromS3File(bucket, "schemas/myschema.yaml");
// Add an OpenAPI target using the L2 construct directly
GatewayTarget target = gateway.addOpenApiTarget("MyTarget", AddOpenApiTargetOptions.builder()
.gatewayTargetName("my-api-target")
.description("Target for external API integration")
.apiSchema(s3mySchema)
.credentialProviderConfigurations(List.of(GatewayCredentialProvider.fromApiKeyIdentity(apiKeyProvider, FromApiKeyIdentityOptions.builder()
.credentialLocation(ApiKeyCredentialLocation.header(ApiKeyAdditionalConfiguration.builder()
.credentialParameterName("X-API-Key")
.build()))
.build())))
.build());
// This makes sure your s3 bucket is available before target
target.node.addDependency(bucket);
csharp
// Install: dotnet add package Amazon.CDK.Lib
var gateway = new Gateway(this, "MyGateway", new GatewayProps {
GatewayName = "my-gateway"
});
// Create an API key credential provider in Token Vault
var apiKeyProvider = new ApiKeyCredentialProvider(this, "MyApiKeyProvider", new ApiKeyCredentialProviderProps {
ApiKeyCredentialProviderName = "my-apikey"
});
var bucket = Bucket.FromBucketName(this, "ExistingBucket", "my-schema-bucket");
var s3mySchema = ApiSchema.FromS3File(bucket, "schemas/myschema.yaml");
// Add an OpenAPI target using the L2 construct directly
var target = gateway.AddOpenApiTarget("MyTarget", new AddOpenApiTargetOptions {
GatewayTargetName = "my-api-target",
Description = "Target for external API integration",
ApiSchema = s3mySchema,
CredentialProviderConfigurations = new [] { GatewayCredentialProvider.FromApiKeyIdentity(apiKeyProvider, new FromApiKeyIdentityOptions {
CredentialLocation = ApiKeyCredentialLocation.Header(new ApiKeyAdditionalConfiguration {
CredentialParameterName = "X-API-Key"
})
}) }
});
// This makes sure your s3 bucket is available before target
target.Node.AddDependency(bucket);
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
gateway := agentcore.NewGateway(this, jsii.String("MyGateway"), &GatewayProps{
GatewayName: jsii.String("my-gateway"),
})
// Create an API key credential provider in Token Vault
apiKeyProvider := agentcore.NewApiKeyCredentialProvider(this, jsii.String("MyApiKeyProvider"), &ApiKeyCredentialProviderProps{
ApiKeyCredentialProviderName: jsii.String("my-apikey"),
})
bucket := s3.Bucket_FromBucketName(this, jsii.String("ExistingBucket"), jsii.String("my-schema-bucket"))
s3mySchema := agentcore.ApiSchema_FromS3File(bucket, jsii.String("schemas/myschema.yaml"))
// Add an OpenAPI target using the L2 construct directly
target := gateway.AddOpenApiTarget(jsii.String("MyTarget"), &AddOpenApiTargetOptions{
GatewayTargetName: jsii.String("my-api-target"),
Description: jsii.String("Target for external API integration"),
ApiSchema: s3mySchema,
CredentialProviderConfigurations: []ICredentialProviderConfig{
agentcore.GatewayCredentialProvider_FromApiKeyIdentity(apiKeyProvider, &FromApiKeyIdentityOptions{
CredentialLocation: agentcore.ApiKeyCredentialLocation_Header(&ApiKeyAdditionalConfiguration{
CredentialParameterName: jsii.String("X-API-Key"),
}),
}),
},
})
// This makes sure your s3 bucket is available before target
target.Node.AddDependency(bucket)
Initializer
ts
new ApiKeyCredentialProvider(scope: Construct, id: string, props?: ApiKeyCredentialProviderProps)
python
ApiKeyCredentialProvider(scope: Construct, id: str, props: typing.Optional[ApiKeyCredentialProviderProps] = None)
java
new ApiKeyCredentialProvider(Construct scope, String id, ApiKeyCredentialProviderProps props)
csharp
new ApiKeyCredentialProvider(Construct scope, string id, ApiKeyCredentialProviderProps? props = null)
go
NewApiKeyCredentialProvider(Scope Construct, Id *string, Props ApiKeyCredentialProviderProps)
Construct Props
apiKeyoptionalSecretValueapi_keyoptionalSecretValueapiKeyoptionalSecretValueApiKeyoptionalSecretValueApiKeyoptionalSecretValue#The API key value.
Default: no key in template (provider may still be created depending on service behavior)
notes
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.
apiKeyCredentialProviderNameoptionalstringapi_key_credential_provider_nameoptionalstrapiKeyCredentialProviderNameoptionalStringApiKeyCredentialProviderNameoptionalstringApiKeyCredentialProviderNameoptional*string#Name of the credential provider.
Default: a name generated by CDK
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Tags for this credential provider.
Default: no tags
Properties
apiKeyCredentialProviderNamestringapi_key_credential_provider_namestrapiKeyCredentialProviderNameStringApiKeyCredentialProviderNamestringApiKeyCredentialProviderName*string#The name of this API key credential provider.
apiKeyCredentialProviderRefApiKeyCredentialProviderReferenceapi_key_credential_provider_refApiKeyCredentialProviderReferenceapiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReference#A reference to a ApiKeyCredentialProvider resource.
apiKeySecretArnmay be undefinedstringapi_key_secret_arnmay be undefinedstrapiKeySecretArnmay be undefinedStringApiKeySecretArnmay be undefinedstringApiKeySecretArnmay be undefined*string#The ARN of the Secrets Manager secret that stores the API key after the resource is created.
May be undefined for resources imported without this attribute.
createdTimemay be undefinedstringcreated_timemay be undefinedstrcreatedTimemay be undefinedStringCreatedTimemay be undefinedstringCreatedTimemay be undefined*string#Timestamp when the credential provider was created.
credentialProviderArnstringcredential_provider_arnstrcredentialProviderArnStringCredentialProviderArnstringCredentialProviderArn*string#The ARN of this credential provider.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#The principal to grant permissions to.
lastUpdatedTimemay be undefinedstringlast_updated_timemay be undefinedstrlastUpdatedTimemay be undefinedStringLastUpdatedTimemay be undefinedstringLastUpdatedTimemay be undefined*string#Timestamp when the credential provider was last updated.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
bindForGatewayApiKeyTarget(): GatewayApiKeyIdentityBindingdef bind_for_gateway_api_key_target(self, ) -> GatewayApiKeyIdentityBindingpublic GatewayApiKeyIdentityBinding bindForGatewayApiKeyTarget()public GatewayApiKeyIdentityBinding BindForGatewayApiKeyTarget()func BindForGatewayApiKeyTarget() GatewayApiKeyIdentityBinding#ARNs for {@link GatewayCredentialProvider.fromApiKeyIdentity } / {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.
fromApiKeyCredentialProviderAttributes(scope: Construct, id: string, attrs: ApiKeyCredentialProviderAttributes): IApiKeyCredentialProvider@staticmethod def from_api_key_credential_provider_attributes(scope: Construct, id: str, attrs: ApiKeyCredentialProviderAttributes) -> IApiKeyCredentialProviderpublic static IApiKeyCredentialProvider fromApiKeyCredentialProviderAttributes(Construct scope, String id, ApiKeyCredentialProviderAttributes attrs)public static IApiKeyCredentialProvider FromApiKeyCredentialProviderAttributes(Construct scope, string id, ApiKeyCredentialProviderAttributes attrs)func FromApiKeyCredentialProviderAttributes(Scope Construct, Id *string, Attrs ApiKeyCredentialProviderAttributes) IApiKeyCredentialProviderstatic#Import an existing API key credential provider.
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#[disable-awslint:no-grants].
grantAdmin(grantee: IGrantable): Grantdef grant_admin(self, grantee: IGrantable) -> Grantpublic Grant grantAdmin(IGrantable grantee)public Grant GrantAdmin(IGrantable grantee)func GrantAdmin(Grantee IGrantable) Grant#[disable-awslint:no-grants].
grantFullAccess(grantee: IGrantable): Grantdef grant_full_access(self, grantee: IGrantable) -> Grantpublic Grant grantFullAccess(IGrantable grantee)public Grant GrantFullAccess(IGrantable grantee)func GrantFullAccess(Grantee IGrantable) Grant#[disable-awslint:no-grants].
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#[disable-awslint:no-grants].
grantUse(grantee: IGrantable): Grantdef grant_use(self, grantee: IGrantable) -> Grantpublic Grant grantUse(IGrantable grantee)public Grant GrantUse(IGrantable grantee)func GrantUse(Grantee IGrantable) Grant#[disable-awslint:no-grants].
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.