Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. bedrock
  5. AgentAgentKnowledgeBaseAssociation
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.bedrock.AgentAgentKnowledgeBaseAssociation

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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: "GGRRAED6JP",
    description: "Example Knowledge base",
    knowledgeBaseId: "EMDPPAYPZI",
    knowledgeBaseState: "ENABLED",
});

    import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentAgentKnowledgeBaseAssociation("example",
    agent_id="GGRRAED6JP",
    description="Example Knowledge base",
    knowledge_base_id="EMDPPAYPZI",
    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("GGRRAED6JP"),
			Description:        pulumi.String("Example Knowledge base"),
			KnowledgeBaseId:    pulumi.String("EMDPPAYPZI"),
			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 = "GGRRAED6JP",
        Description = "Example Knowledge base",
        KnowledgeBaseId = "EMDPPAYPZI",
        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("GGRRAED6JP")
            .description("Example Knowledge base")
            .knowledgeBaseId("EMDPPAYPZI")
            .knowledgeBaseState("ENABLED")
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
    properties:
      agentId: GGRRAED6JP
      description: Example Knowledge base
      knowledgeBaseId: EMDPPAYPZI
      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,
                                       timeouts: Optional[AgentAgentKnowledgeBaseAssociationTimeoutsArgs] = 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.

    Constructor 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",
    Timeouts = new Aws.Bedrock.Inputs.AgentAgentKnowledgeBaseAssociationTimeoutsArgs
    {
        Create = "string",
        Update = "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"),
	Timeouts: &bedrock.AgentAgentKnowledgeBaseAssociationTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var agentAgentKnowledgeBaseAssociationResource = new AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource", AgentAgentKnowledgeBaseAssociationArgs.builder()
    .agentId("string")
    .description("string")
    .knowledgeBaseId("string")
    .knowledgeBaseState("string")
    .agentVersion("string")
    .timeouts(AgentAgentKnowledgeBaseAssociationTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .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",
    timeouts={
        "create": "string",
        "update": "string",
    })

    const agentAgentKnowledgeBaseAssociationResource = new aws.bedrock.AgentAgentKnowledgeBaseAssociation("agentAgentKnowledgeBaseAssociationResource", {
    agentId: "string",
    description: "string",
    knowledgeBaseId: "string",
    knowledgeBaseState: "string",
    agentVersion: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
properties:
    agentId: string
    agentVersion: string
    description: string
    knowledgeBaseId: string
    knowledgeBaseState: string
    timeouts:
        create: string
        update: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AgentAgentKnowledgeBaseAssociation resource accepts the following input properties:

    AgentId string
    Unique identifier of the agent with which you want to associate the knowledge base.
    Description string
    Description of what the agent should use the knowledge base for.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    KnowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    AgentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    Timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    AgentId string
    Unique identifier of the agent with which you want to associate the knowledge base.
    Description string
    Description of what the agent should use the knowledge base for.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    KnowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    AgentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    Timeouts AgentAgentKnowledgeBaseAssociationTimeoutsArgs
    agentId String
    Unique identifier of the agent with which you want to associate the knowledge base.
    description String
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId String
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState String

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    agentVersion String
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    agentId string
    Unique identifier of the agent with which you want to associate the knowledge base.
    description string
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    agentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    agent_id str
    Unique identifier of the agent with which you want to associate the knowledge base.
    description str
    Description of what the agent should use the knowledge base for.
    knowledge_base_id str
    Unique identifier of the knowledge base to associate with the agent.
    knowledge_base_state str

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    agent_version str
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    timeouts AgentAgentKnowledgeBaseAssociationTimeoutsArgs
    agentId String
    Unique identifier of the agent with which you want to associate the knowledge base.
    description String
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId String
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState String

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    agentVersion String
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    timeouts Property Map

    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,
        timeouts: Optional[AgentAgentKnowledgeBaseAssociationTimeoutsArgs] = 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
    Unique identifier of the agent with which you want to associate the knowledge base.
    AgentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    Description string
    Description of what the agent should use the knowledge base for.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    KnowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    Timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    AgentId string
    Unique identifier of the agent with which you want to associate the knowledge base.
    AgentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    Description string
    Description of what the agent should use the knowledge base for.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    KnowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    Timeouts AgentAgentKnowledgeBaseAssociationTimeoutsArgs
    agentId String
    Unique identifier of the agent with which you want to associate the knowledge base.
    agentVersion String
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    description String
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId String
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState String

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    agentId string
    Unique identifier of the agent with which you want to associate the knowledge base.
    agentVersion string
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    description string
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId string
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState string

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    timeouts AgentAgentKnowledgeBaseAssociationTimeouts
    agent_id str
    Unique identifier of the agent with which you want to associate the knowledge base.
    agent_version str
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    description str
    Description of what the agent should use the knowledge base for.
    knowledge_base_id str
    Unique identifier of the knowledge base to associate with the agent.
    knowledge_base_state str

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    timeouts AgentAgentKnowledgeBaseAssociationTimeoutsArgs
    agentId String
    Unique identifier of the agent with which you want to associate the knowledge base.
    agentVersion String
    Version of the agent with which you want to associate the knowledge base. Valid values: DRAFT.
    description String
    Description of what the agent should use the knowledge base for.
    knowledgeBaseId String
    Unique identifier of the knowledge base to associate with the agent.
    knowledgeBaseState String

    Whether to use the knowledge base when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.

    The following arguments are optional:

    timeouts Property Map

    Supporting Types

    AgentAgentKnowledgeBaseAssociationTimeouts, AgentAgentKnowledgeBaseAssociationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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:

    $ pulumi import aws:bedrock/agentAgentKnowledgeBaseAssociation:AgentAgentKnowledgeBaseAssociation example GGRRAED6JP,DRAFT,EMDPPAYPZI

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws