Package software.amazon.awscdk.services.bedrock.alpha

Interface IAgentAlias

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IAgentAlias.Jsii$Default
All Known Implementing Classes:
AgentAlias, AgentAliasBase, IAgentAlias.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-08-06T18:14:48.065Z") @Stability(Experimental) public interface IAgentAlias extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents an Agent Alias, either created with CDK or imported.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IAgentAlias.Jsii$Default
    Internal default implementation for IAgentAlias.
    static final class 
    IAgentAlias.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    IAgent
    getAgent()
    (experimental) The underlying agent for this alias.
    String
    getAliasArn()
    (experimental) The ARN of the agent alias.
    String
    getAliasId()
    (experimental) The unique identifier of the agent alias.
    Grant
    grant(IGrantable grantee, String... actions)
    (experimental) Grant the given principal identity permissions to perform actions on this agent alias.
    Grant
    grantGet(IGrantable grantee)
    (experimental) Grant the given identity permissions to get the agent alias.
    Grant
    grantInvoke(IGrantable grantee)
    (experimental) Grant the given identity permissions to invoke the agent alias.
    Rule
    onCloudTrailEvent(String id)
    (experimental) Define an EventBridge rule that triggers when something happens to this agent alias.
    Rule
    onCloudTrailEvent(String id, OnEventOptions options)
    (experimental) Define an EventBridge rule that triggers when something happens to this agent alias.

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getAgent

      @Stability(Experimental) @NotNull IAgent getAgent()
      (experimental) The underlying agent for this alias.

    • getAliasArn

      @Stability(Experimental) @NotNull String getAliasArn()
      (experimental) The ARN of the agent alias.

    • getAliasId

      @Stability(Experimental) @NotNull String getAliasId()
      (experimental) The unique identifier of the agent alias.

    • grant

      @Stability(Experimental) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grant the given principal identity permissions to perform actions on this agent alias.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantGet

      @Stability(Experimental) @NotNull Grant grantGet(@NotNull IGrantable grantee)
      (experimental) Grant the given identity permissions to get the agent alias.

      Parameters:
      grantee - This parameter is required.

    • grantInvoke

      @Stability(Experimental) @NotNull Grant grantInvoke(@NotNull IGrantable grantee)
      (experimental) Grant the given identity permissions to invoke the agent alias.

      Parameters:
      grantee - This parameter is required.

    • onCloudTrailEvent

      @Stability(Experimental) @NotNull Rule onCloudTrailEvent(@NotNull String id, @Nullable OnEventOptions options)
      (experimental) Define an EventBridge rule that triggers when something happens to this agent alias.

      Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

      Parameters:
      id - The id of the rule. This parameter is required.
      options - Options for adding the rule.

    • onCloudTrailEvent

      @Stability(Experimental) @NotNull Rule onCloudTrailEvent(@NotNull String id)
      (experimental) Define an EventBridge rule that triggers when something happens to this agent alias.

      Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

      Parameters:
      id - The id of the rule. This parameter is required.