1. Packages
  2. AWS Classic
  3. API Docs
  4. bedrock
  5. AgentAgentKnowledgeBaseAssociation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi

aws.bedrock.AgentAgentKnowledgeBaseAssociation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi

    Resource for managing an AWS Agents for Amazon Bedrock Agent Knowledge Base Association.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.bedrock.AgentAgentKnowledgeBaseAssociation("example", {
        agentId: "012EXAMPLE",
        description: "Example Knowledge base",
        knowledgeBaseId: "345EXAMPLE",
        knowledgeBaseState: "ENABLED",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.bedrock.AgentAgentKnowledgeBaseAssociation("example",
        agent_id="012EXAMPLE",
        description="Example Knowledge base",
        knowledge_base_id="345EXAMPLE",
        knowledge_base_state="ENABLED")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bedrock.NewAgentAgentKnowledgeBaseAssociation(ctx, "example", &bedrock.AgentAgentKnowledgeBaseAssociationArgs{
    			AgentId:            pulumi.String("012EXAMPLE"),
    			Description:        pulumi.String("Example Knowledge base"),
    			KnowledgeBaseId:    pulumi.String("345EXAMPLE"),
    			KnowledgeBaseState: pulumi.String("ENABLED"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Bedrock.AgentAgentKnowledgeBaseAssociation("example", new()
        {
            AgentId = "012EXAMPLE",
            Description = "Example Knowledge base",
            KnowledgeBaseId = "345EXAMPLE",
            KnowledgeBaseState = "ENABLED",
        });
    
    });
    
    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.List;
    import java.util.ArrayList;
    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("012EXAMPLE")
                .description("Example Knowledge base")
                .knowledgeBaseId("345EXAMPLE")
                .knowledgeBaseState("ENABLED")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
        properties:
          agentId: 012EXAMPLE
          description: Example Knowledge base
          knowledgeBaseId: 345EXAMPLE
          knowledgeBaseState: ENABLED
    

    Create AgentAgentKnowledgeBaseAssociation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentAgentKnowledgeBaseAssociation(name: string, args: AgentAgentKnowledgeBaseAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def AgentAgentKnowledgeBaseAssociation(resource_name: str,
                                           args: AgentAgentKnowledgeBaseAssociationArgs,
                                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def AgentAgentKnowledgeBaseAssociation(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           agent_id: Optional[str] = None,
                                           description: Optional[str] = None,
                                           knowledge_base_id: Optional[str] = None,
                                           knowledge_base_state: Optional[str] = None,
                                           agent_version: Optional[str] = None)
    func NewAgentAgentKnowledgeBaseAssociation(ctx *Context, name string, args AgentAgentKnowledgeBaseAssociationArgs, opts ...ResourceOption) (*AgentAgentKnowledgeBaseAssociation, error)
    public AgentAgentKnowledgeBaseAssociation(string name, AgentAgentKnowledgeBaseAssociationArgs args, CustomResourceOptions? opts = null)
    public AgentAgentKnowledgeBaseAssociation(String name, AgentAgentKnowledgeBaseAssociationArgs args)
    public AgentAgentKnowledgeBaseAssociation(String name, AgentAgentKnowledgeBaseAssociationArgs args, CustomResourceOptions options)
    
    type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AgentAgentKnowledgeBaseAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentAgentKnowledgeBaseAssociationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentAgentKnowledgeBaseAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentAgentKnowledgeBaseAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentAgentKnowledgeBaseAssociationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var agentAgentKnowledgeBaseAssociationResource = new Aws.Bedrock.AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource", new()
    {
        AgentId = "string",
        Description = "string",
        KnowledgeBaseId = "string",
        KnowledgeBaseState = "string",
        AgentVersion = "string",
    });
    
    example, err := bedrock.NewAgentAgentKnowledgeBaseAssociation(ctx, "agentAgentKnowledgeBaseAssociationResource", &bedrock.AgentAgentKnowledgeBaseAssociationArgs{
    	AgentId:            pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	KnowledgeBaseId:    pulumi.String("string"),
    	KnowledgeBaseState: pulumi.String("string"),
    	AgentVersion:       pulumi.String("string"),
    })
    
    var agentAgentKnowledgeBaseAssociationResource = new AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource", AgentAgentKnowledgeBaseAssociationArgs.builder()        
        .agentId("string")
        .description("string")
        .knowledgeBaseId("string")
        .knowledgeBaseState("string")
        .agentVersion("string")
        .build());
    
    agent_agent_knowledge_base_association_resource = aws.bedrock.AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource",
        agent_id="string",
        description="string",
        knowledge_base_id="string",
        knowledge_base_state="string",
        agent_version="string")
    
    const agentAgentKnowledgeBaseAssociationResource = new aws.bedrock.AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource", {
        agentId: "string",
        description: "string",
        knowledgeBaseId: "string",
        knowledgeBaseState: "string",
        agentVersion: "string",
    });
    
    type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
    properties:
        agentId: string
        agentVersion: string
        description: string
        knowledgeBaseId: string
        knowledgeBaseState: string
    

    AgentAgentKnowledgeBaseAssociation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AgentAgentKnowledgeBaseAssociation resource accepts the following input properties:

    AgentId string
    The ID of the agent to associate.
    Description string
    Description of the association.
    KnowledgeBaseId string
    The ID of the Knowledge Base to associate.
    KnowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    AgentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    AgentId string
    The ID of the agent to associate.
    Description string
    Description of the association.
    KnowledgeBaseId string
    The ID of the Knowledge Base to associate.
    KnowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    AgentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    agentId String
    The ID of the agent to associate.
    description String
    Description of the association.
    knowledgeBaseId String
    The ID of the Knowledge Base to associate.
    knowledgeBaseState String

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentVersion String
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    agentId string
    The ID of the agent to associate.
    description string
    Description of the association.
    knowledgeBaseId string
    The ID of the Knowledge Base to associate.
    knowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    agent_id str
    The ID of the agent to associate.
    description str
    Description of the association.
    knowledge_base_id str
    The ID of the Knowledge Base to associate.
    knowledge_base_state str

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agent_version str
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    agentId String
    The ID of the agent to associate.
    description String
    Description of the association.
    knowledgeBaseId String
    The ID of the Knowledge Base to associate.
    knowledgeBaseState String

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentVersion String
    Agent version to associate the Knowledge Base to, currently only DRAFT.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentAgentKnowledgeBaseAssociation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AgentAgentKnowledgeBaseAssociation Resource

    Get an existing AgentAgentKnowledgeBaseAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentAgentKnowledgeBaseAssociationState, opts?: CustomResourceOptions): AgentAgentKnowledgeBaseAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            agent_id: Optional[str] = None,
            agent_version: Optional[str] = None,
            description: Optional[str] = None,
            knowledge_base_id: Optional[str] = None,
            knowledge_base_state: Optional[str] = None) -> AgentAgentKnowledgeBaseAssociation
    func GetAgentAgentKnowledgeBaseAssociation(ctx *Context, name string, id IDInput, state *AgentAgentKnowledgeBaseAssociationState, opts ...ResourceOption) (*AgentAgentKnowledgeBaseAssociation, error)
    public static AgentAgentKnowledgeBaseAssociation Get(string name, Input<string> id, AgentAgentKnowledgeBaseAssociationState? state, CustomResourceOptions? opts = null)
    public static AgentAgentKnowledgeBaseAssociation get(String name, Output<String> id, AgentAgentKnowledgeBaseAssociationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentId string
    The ID of the agent to associate.
    AgentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    Description string
    Description of the association.
    KnowledgeBaseId string
    The ID of the Knowledge Base to associate.
    KnowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    AgentId string
    The ID of the agent to associate.
    AgentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    Description string
    Description of the association.
    KnowledgeBaseId string
    The ID of the Knowledge Base to associate.
    KnowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentId String
    The ID of the agent to associate.
    agentVersion String
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    description String
    Description of the association.
    knowledgeBaseId String
    The ID of the Knowledge Base to associate.
    knowledgeBaseState String

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentId string
    The ID of the agent to associate.
    agentVersion string
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    description string
    Description of the association.
    knowledgeBaseId string
    The ID of the Knowledge Base to associate.
    knowledgeBaseState string

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agent_id str
    The ID of the agent to associate.
    agent_version str
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    description str
    Description of the association.
    knowledge_base_id str
    The ID of the Knowledge Base to associate.
    knowledge_base_state str

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    agentId String
    The ID of the agent to associate.
    agentVersion String
    Agent version to associate the Knowledge Base to, currently only DRAFT.
    description String
    Description of the association.
    knowledgeBaseId String
    The ID of the Knowledge Base to associate.
    knowledgeBaseState String

    State of the association ENABLED or DISABLED.

    The following arguments are optional:

    Import

    Using pulumi import, import Agents for Amazon Bedrock Agent Knowledge Base Association using the 012AGENTID-DRAFT-345678KBID. For example:

    $ pulumi import aws:bedrock/agentAgentKnowledgeBaseAssociation:AgentAgentKnowledgeBaseAssociation example 012AGENTID-DRAFT-345678KBID
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi