Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
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
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import * as cdk from 'aws-cdk-lib';
declare const secretValue: cdk.SecretValue;
const apiKeyCredentialProvider = new bedrock_agentcore_alpha.ApiKeyCredentialProvider(this, 'MyApiKeyCredentialProvider', /* all optional props */ {
apiKey: secretValue,
apiKeyCredentialProviderName: 'apiKeyCredentialProviderName',
tags: {
tagsKey: 'tags',
},
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
import aws_cdk as cdk
# secret_value: cdk.SecretValue
api_key_credential_provider = bedrock_agentcore_alpha.ApiKeyCredentialProvider(self, "MyApiKeyCredentialProvider",
api_key=secret_value,
api_key_credential_provider_name="apiKeyCredentialProviderName",
tags={
"tags_key": "tags"
}
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
import software.amazon.awscdk.*;
SecretValue secretValue;
ApiKeyCredentialProvider apiKeyCredentialProvider = ApiKeyCredentialProvider.Builder.create(this, "MyApiKeyCredentialProvider")
.apiKey(secretValue)
.apiKeyCredentialProviderName("apiKeyCredentialProviderName")
.tags(Map.of(
"tagsKey", "tags"))
.build();
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
using Amazon.CDK;
SecretValue secretValue;
var apiKeyCredentialProvider = new ApiKeyCredentialProvider(this, "MyApiKeyCredentialProvider", new ApiKeyCredentialProviderResourceProps {
ApiKey = secretValue,
ApiKeyCredentialProviderName = "apiKeyCredentialProviderName",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"
var secretValue SecretValue
apiKeyCredentialProvider := bedrock_agentcore_alpha.NewApiKeyCredentialProvider(this, jsii.String("MyApiKeyCredentialProvider"), &ApiKeyCredentialProviderResourceProps{
ApiKey: secretValue,
ApiKeyCredentialProviderName: jsii.String("apiKeyCredentialProviderName"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
Initializer
new ApiKeyCredentialProvider(scope: Construct, id: string, props?: ApiKeyCredentialProviderResourceProps)
ApiKeyCredentialProvider(scope: Construct, id: str, props: typing.Optional[ApiKeyCredentialProviderResourceProps] = None)
new ApiKeyCredentialProvider(Construct scope, String id, ApiKeyCredentialProviderResourceProps props)
new ApiKeyCredentialProvider(Construct scope, string id, ApiKeyCredentialProviderResourceProps? props = null)
NewApiKeyCredentialProvider(Scope Construct, Id *string, Props ApiKeyCredentialProviderResourceProps)
Construct Props
apiKeyoptionalSecretValueapi_keyoptionalSecretValueapiKeyoptionalSecretValueApiKeyoptionalSecretValueApiKeyoptionalSecretValue#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#Default: a name generated by CDK
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Default: no tags
Properties
apiKeyCredentialProviderNamestringapi_key_credential_provider_namestrapiKeyCredentialProviderNameStringApiKeyCredentialProviderNamestringApiKeyCredentialProviderName*stringrequired#apiKeyCredentialProviderRefApiKeyCredentialProviderReferenceapi_key_credential_provider_refApiKeyCredentialProviderReferenceapiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReferenceApiKeyCredentialProviderRefApiKeyCredentialProviderReferencerequired#apiKeySecretArnmay be undefinedstringapi_key_secret_arnmay be undefinedstrapiKeySecretArnmay be undefinedStringApiKeySecretArnmay be undefinedstringApiKeySecretArnmay be undefined*string#May be undefined for resources imported without this attribute.
createdTimemay be undefinedstringcreated_timemay be undefinedstrcreatedTimemay be undefinedStringCreatedTimemay be undefinedstringCreatedTimemay be undefined*string#credentialProviderArnstringcredential_provider_arnstrcredentialProviderArnStringCredentialProviderArnstringCredentialProviderArn*stringrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#lastUpdatedTimemay be undefinedstringlast_updated_timemay be undefinedstrlastUpdatedTimemay be undefinedStringLastUpdatedTimemay be undefinedstringLastUpdatedTimemay be undefined*string#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#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)#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)#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#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#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#grantAdmin(grantee: IGrantable): Grantdef grant_admin(self, grantee: IGrantable) -> Grantpublic Grant grantAdmin(IGrantable grantee)public Grant GrantAdmin(IGrantable grantee)func GrantAdmin(Grantee IGrantable) Grant#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#grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#grantUse(grantee: IGrantable): Grantdef grant_use(self, grantee: IGrantable) -> Grantpublic Grant grantUse(IGrantable grantee)public Grant GrantUse(IGrantable grantee)func GrantUse(Grantee IGrantable) Grant#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#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#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#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.