Package com.pulumi.aws.bedrock

Class AgentAgentKnowledgeBaseAssociation

  • public class AgentAgentKnowledgeBaseAssociation
extends com.pulumi.resources.CustomResource
    Manages an AWS Agents for Amazon Bedrock Agent Knowledge Base Association. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.bedrock.AgentAgentKnowledgeBaseAssociation;
 import com.pulumi.aws.bedrock.AgentAgentKnowledgeBaseAssociationArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new AgentAgentKnowledgeBaseAssociation("example", AgentAgentKnowledgeBaseAssociationArgs.builder()
             .agentId("GGRRAED6JP")
             .description("Example Knowledge base")
             .knowledgeBaseId("EMDPPAYPZI")
             .knowledgeBaseState("ENABLED")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Agents for Amazon Bedrock Agent Knowledge Base Association using the agent ID, the agent version, and the knowledge base ID separated by `,`. For example: ```sh $ pulumi import aws:bedrock/agentAgentKnowledgeBaseAssociation:AgentAgentKnowledgeBaseAssociation example GGRRAED6JP,DRAFT,EMDPPAYPZI ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> agentId()  
      com.pulumi.core.Output<java.lang.String> agentVersion()  
      com.pulumi.core.Output<java.lang.String> description()  
      static AgentAgentKnowledgeBaseAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentAgentKnowledgeBaseAssociationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> knowledgeBaseId()  
      com.pulumi.core.Output<java.lang.String> knowledgeBaseState()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<AgentAgentKnowledgeBaseAssociationTimeouts>> timeouts()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AgentAgentKnowledgeBaseAssociation

        public AgentAgentKnowledgeBaseAssociation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • AgentAgentKnowledgeBaseAssociation

        public AgentAgentKnowledgeBaseAssociation​(java.lang.String name,
                                          AgentAgentKnowledgeBaseAssociationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • AgentAgentKnowledgeBaseAssociation

        public AgentAgentKnowledgeBaseAssociation​(java.lang.String name,
                                          AgentAgentKnowledgeBaseAssociationArgs args,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • agentId

        public com.pulumi.core.Output<java.lang.String> agentId()
        Returns:
        Unique identifier of the agent with which you want to associate the knowledge base.

      • agentVersion

        public com.pulumi.core.Output<java.lang.String> agentVersion()
        Returns:
        Version of the agent with which you want to associate the knowledge base. Valid values: `DRAFT`. Defaults to `DRAFT`.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description of what the agent should use the knowledge base for.

      • knowledgeBaseId

        public com.pulumi.core.Output<java.lang.String> knowledgeBaseId()
        Returns:
        Unique identifier of the knowledge base to associate with the agent.

      • knowledgeBaseState

        public com.pulumi.core.Output<java.lang.String> knowledgeBaseState()
        Returns:
        Whether to use the knowledge base when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Valid values: `ENABLED`, `DISABLED`. The following arguments are optional:

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static AgentAgentKnowledgeBaseAssociation get​(java.lang.String name,
                                                     com.pulumi.core.Output<java.lang.String> id,
                                                     @Nullable
                                                     AgentAgentKnowledgeBaseAssociationState state,
                                                     @Nullable
                                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.