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

Interface IAgent.Jsii$Default

All Superinterfaces:
IAgent, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IAgent.Jsii$Proxy
Enclosing interface:
IAgent
@Internal public static interface IAgent.Jsii$Default extends IAgent, IResource.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IAgent.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.bedrock.alpha.IAgent

    IAgent.Jsii$Default, IAgent.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

    IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default String
    getAgentArn()
    (experimental) The ARN of the agent.
    default String
    getAgentId()
    (experimental) The ID of the Agent.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default IPrincipal
    getGrantPrincipal()
    The principal to grant permissions to.
    default IKey
    getKmsKey()
    (experimental) Optional KMS encryption key associated with this agent.
    default String
    getLastUpdated()
    (experimental) When this agent was last updated.
    default software.constructs.Node
    getNode()
    The tree node.
    default IRole
    getRole()
    (experimental) The IAM role associated to the agent.
    default Stack
    getStack()
    The stack in which this resource is defined.
    default Grant
    grantInvoke(IGrantable grantee)
    (experimental) Grant invoke permissions on this agent to an IAM principal.
    default Metric
    metricCount(MetricOptions props)
    (experimental) Return the CloudWatch metric for agent count.
    default Rule
    onEvent(String id, OnEventOptions options)
    (experimental) Defines a CloudWatch event rule triggered by agent events.

    Methods inherited from interface software.amazon.awscdk.services.bedrock.alpha.IAgent

    metricCount, onEvent

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getGrantPrincipal

      @Stability(Stable) @NotNull default IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in interface IGrantable.Jsii$Default

    • getAgentArn

      @Stability(Experimental) @NotNull default String getAgentArn()
      (experimental) The ARN of the agent.
      Specified by:
      getAgentArn in interface IAgent

    • getAgentId

      @Stability(Experimental) @NotNull default String getAgentId()
      (experimental) The ID of the Agent.
      Specified by:
      getAgentId in interface IAgent

    • getRole

      @Stability(Experimental) @NotNull default IRole getRole()
      (experimental) The IAM role associated to the agent.
      Specified by:
      getRole in interface IAgent

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this agent.
      Specified by:
      getKmsKey in interface IAgent

    • getLastUpdated

      @Stability(Experimental) @Nullable default String getLastUpdated()
      (experimental) When this agent was last updated.
      Specified by:
      getLastUpdated in interface IAgent

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

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

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grantInvoke

      @Stability(Experimental) @NotNull default Grant grantInvoke(@NotNull IGrantable grantee)
      (experimental) Grant invoke permissions on this agent to an IAM principal.

      Note: This grant will only work when the grantee is in the same AWS account where the agent is defined. Cross-account invocation is not supported.

      Specified by:
      grantInvoke in interface IAgent
      Parameters:
      grantee - This parameter is required.

    • metricCount

      @Stability(Experimental) @NotNull default Metric metricCount(@Nullable MetricOptions props)
      (experimental) Return the CloudWatch metric for agent count.

      Specified by:
      metricCount in interface IAgent
      Parameters:
      props -

    • onEvent

      @Stability(Experimental) @NotNull default Rule onEvent(@NotNull String id, @Nullable OnEventOptions options)
      (experimental) Defines a CloudWatch event rule triggered by agent events.

      Specified by:
      onEvent in interface IAgent
      Parameters:
      id - This parameter is required.
      options -