Skip to content
v2.277.0

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IWorkloadIdentity Interface ​

A workload identity for Amazon Bedrock AgentCore.

Represents the stable identity of an agent within an account's agent identity directory. It ties together IAM roles, OAuth2 flows, API keys, and workload access tokens for consistent authentication across environments.

Properties ​

createdTimemay be undefinedstringcreated_timemay be undefinedstrcreatedTimemay be undefinedStringCreatedTimemay be undefinedstringCreatedTimemay be undefined*string #
Timestamp when the workload identity was created.
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 workload identity was last updated.
nodeNodenodeNodenodeNodeNodeNodeNodeNode #
The tree node.
stackStackstackStackstackStackStackStackStackStack #
The stack in which this resource is defined.
workloadIdentityArnstringworkload_identity_arnstrworkloadIdentityArnStringWorkloadIdentityArnstringWorkloadIdentityArn*string #
The ARN of this workload identity.
workloadIdentityNamestringworkload_identity_namestrworkloadIdentityNameStringWorkloadIdentityNamestringWorkloadIdentityName*string #
The name of this workload identity.
workloadIdentityRefWorkloadIdentityReferenceworkload_identity_refWorkloadIdentityReferenceworkloadIdentityRefWorkloadIdentityReferenceWorkloadIdentityRefWorkloadIdentityReferenceWorkloadIdentityRefWorkloadIdentityReference #
A reference to a WorkloadIdentity resource.

Methods ​

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).

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 #
Grants IAM actions on this workload identity, scoped to its ARN and the parent resources required by the Bedrock AgentCore authorization model.
grantAdmin(grantee: IGrantable): Grantdef grant_admin(self, grantee: IGrantable) -> Grantpublic Grant grantAdmin(IGrantable grantee)public Grant GrantAdmin(IGrantable grantee)func GrantAdmin(Grantee IGrantable) Grant #
Grant control plane permissions to manage this workload identity.
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 #
Grant read, list, admin, and use permissions.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant #
Grant `GetWorkloadIdentity` and `ListWorkloadIdentities`, scoped to this identity and parent resources required by the Bedrock AgentCore authorization model.
grantUse(grantee: IGrantable): Grantdef grant_use(self, grantee: IGrantable) -> Grantpublic Grant grantUse(IGrantable grantee)public Grant GrantUse(IGrantable grantee)func GrantUse(Grantee IGrantable) Grant #
Grant data plane permissions to mint workload access tokens (`GetWorkloadAccessToken`, `GetWorkloadAccessTokenForJWT`, `GetWorkloadAccessTokenForUserId`).
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.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining