AgentAgentKnowledgeBaseAssociation class
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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_agentagentknowledgebaseassociation" "example" {
agent_id = "GGRRAED6JP"
description = "Example Knowledge base"
knowledge_base_id = "EMDPPAYPZI"
knowledge_base_state = "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.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());
}
}
resources:
example:
type: aws:bedrock:AgentAgentKnowledgeBaseAssociation
properties:
agentId: GGRRAED6JP
description: Example Knowledge base
knowledgeBaseId: EMDPPAYPZI
knowledgeBaseState: ENABLED
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
Constructors
- AgentAgentKnowledgeBaseAssociation(String name, {AgentAgentKnowledgeBaseAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new AgentAgentKnowledgeBaseAssociation.
nameThe Pulumi resource name.argsArguments used to configure this AgentAgentKnowledgeBaseAssociation. The set of arguments for AgentAgentKnowledgeBaseAssociation.optionsResource options controlling this resource's behavior. - AgentAgentKnowledgeBaseAssociation.reference(String urn)
- Creates a typed reference to an existing AgentAgentKnowledgeBaseAssociation resource.
Properties
-
agentId
↔ Output<
String> -
Unique identifier of the agent with which you want to associate the knowledge base.
latefinal
-
agentVersion
↔ Output<
String> -
Version of the agent with which you want to associate the knowledge base. Valid values:
DRAFT.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
Description of what the agent should use the knowledge base for.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
knowledgeBaseId
↔ Output<
String> -
Unique identifier of the knowledge base to associate with the agent.
latefinal
-
knowledgeBaseState
↔ Output<
String> -
Whether to use the knowledge base when sending an InvokeAgent request. Valid values:
ENABLED,DISABLED.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeouts
↔ Output<
AgentAgentKnowledgeBaseAssociationTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {AgentAgentKnowledgeBaseAssociationState? state, CustomResourceOptions? options}) → AgentAgentKnowledgeBaseAssociation -
Gets an existing AgentAgentKnowledgeBaseAssociation resource's state with the given
nameandid.