Class WorkloadIdentity
(experimental) L2 construct for AWS::BedrockAgentCore::WorkloadIdentity.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll
Syntax (csharp)
public class WorkloadIdentity : Resource, IWorkloadIdentity, IResource, IGrantable, IWorkloadIdentityRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class WorkloadIdentity Inherits Resource Implements IWorkloadIdentity, IResource, IGrantable, IWorkloadIdentityRef, IConstruct, IDependable, IEnvironmentAware
Remarks
A workload identity is the stable identity of an agent in an AWS account. It ties together IAM roles, OAuth2 flows, API keys, and workload access tokens for consistent authentication across environments.
Stability: Experimental
Resource: AWS::BedrockAgentCore::WorkloadIdentity
ExampleMetadata: fixture=default infused
Examples
new WorkloadIdentity(this, "MyWorkloadIdentity", new WorkloadIdentityProps {
WorkloadIdentityName = "customer-support-agent-prod",
AllowedResourceOauth2ReturnUrls = new [] { "https://app.example.com/oauth/callback" },
Tags = new Dictionary<string, string> { { "team", "agents" }, { "env", "prod" } }
});
Synopsis
Constructors
| WorkloadIdentity(Construct, string, IWorkloadIdentityProps?) | (experimental) L2 construct for |
Properties
| CreatedTime | (experimental) Timestamp when the workload identity was created. |
| GrantPrincipal | (experimental) The principal to grant permissions to. |
| LastUpdatedTime | (experimental) Timestamp when the workload identity was last updated. |
| PROPERTY_INJECTION_ID | (experimental) Uniquely identifies this class. |
| WorkloadIdentityArn | (experimental) The ARN of this workload identity. |
| WorkloadIdentityName | (experimental) The name of this workload identity. |
| WorkloadIdentityRef | (experimental) A reference to a WorkloadIdentity resource. |
Methods
| FromWorkloadIdentityAttributes(Construct, string, IWorkloadIdentityAttributes) | (experimental) Import an existing workload identity. |
| Grant(IGrantable, params string[]) | (experimental) [disable-awslint:no-grants]. |
| GrantAdmin(IGrantable) | (experimental) [disable-awslint:no-grants]. |
| GrantFullAccess(IGrantable) | (experimental) [disable-awslint:no-grants]. |
| GrantRead(IGrantable) | (experimental) [disable-awslint:no-grants]. |
| GrantUse(IGrantable) | (experimental) [disable-awslint:no-grants]. |
Constructors
WorkloadIdentity(Construct, string, IWorkloadIdentityProps?)
(experimental) L2 construct for AWS::BedrockAgentCore::WorkloadIdentity.
public WorkloadIdentity(Construct scope, string id, IWorkloadIdentityProps? props = null)
Parameters
- scope Construct
- id string
- props IWorkloadIdentityProps
Remarks
Stability: Experimental
Properties
CreatedTime
(experimental) Timestamp when the workload identity was created.
public virtual string? CreatedTime { get; }
Property Value
Remarks
Stability: Experimental
GrantPrincipal
(experimental) The principal to grant permissions to.
public virtual IPrincipal GrantPrincipal { get; }
Property Value
Remarks
Stability: Experimental
LastUpdatedTime
(experimental) Timestamp when the workload identity was last updated.
public virtual string? LastUpdatedTime { get; }
Property Value
Remarks
Stability: Experimental
PROPERTY_INJECTION_ID
(experimental) Uniquely identifies this class.
public static string PROPERTY_INJECTION_ID { get; }
Property Value
Remarks
Stability: Experimental
WorkloadIdentityArn
(experimental) The ARN of this workload identity.
public virtual string WorkloadIdentityArn { get; }
Property Value
Remarks
Stability: Experimental
WorkloadIdentityName
(experimental) The name of this workload identity.
public virtual string WorkloadIdentityName { get; }
Property Value
Remarks
Stability: Experimental
WorkloadIdentityRef
(experimental) A reference to a WorkloadIdentity resource.
public virtual IWorkloadIdentityReference WorkloadIdentityRef { get; }
Property Value
Remarks
Stability: Experimental
Methods
FromWorkloadIdentityAttributes(Construct, string, IWorkloadIdentityAttributes)
(experimental) Import an existing workload identity.
public static IWorkloadIdentity FromWorkloadIdentityAttributes(Construct scope, string id, IWorkloadIdentityAttributes attrs)
Parameters
- scope Construct
- id string
- attrs IWorkloadIdentityAttributes
Returns
Remarks
Stability: Experimental
Grant(IGrantable, params string[])
(experimental) [disable-awslint:no-grants].
public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
- actions string[]
Returns
Remarks
Stability: Experimental
GrantAdmin(IGrantable)
(experimental) [disable-awslint:no-grants].
public virtual Grant GrantAdmin(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental
GrantFullAccess(IGrantable)
(experimental) [disable-awslint:no-grants].
public virtual Grant GrantFullAccess(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental
GrantRead(IGrantable)
(experimental) [disable-awslint:no-grants].
public virtual Grant GrantRead(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental
GrantUse(IGrantable)
(experimental) [disable-awslint:no-grants].
public virtual Grant GrantUse(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental