Try AWS Native preview for resources not in the classic version.
aws.bedrock.AgentAgentActionGroup
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Resource for managing an AWS Agents for Amazon Bedrock Agent Action Group.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentAgentActionGroup("example", {
actionGroupName: "example",
agentId: "ABDJFOWER1",
agentVersion: "DRAFT",
skipResourceInUseCheck: true,
actionGroupExecutor: {
lambda: "arn:aws:lambda:us-east-1:123456789012:function:example-function",
},
apiSchema: {
s3: {
s3BucketName: "example-bucket",
s3ObjectKey: "path/to/schema.json",
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentAgentActionGroup("example",
action_group_name="example",
agent_id="ABDJFOWER1",
agent_version="DRAFT",
skip_resource_in_use_check=True,
action_group_executor=aws.bedrock.AgentAgentActionGroupActionGroupExecutorArgs(
lambda_="arn:aws:lambda:us-east-1:123456789012:function:example-function",
),
api_schema=aws.bedrock.AgentAgentActionGroupApiSchemaArgs(
s3=aws.bedrock.AgentAgentActionGroupApiSchemaS3Args(
s3_bucket_name="example-bucket",
s3_object_key="path/to/schema.json",
),
))
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.NewAgentAgentActionGroup(ctx, "example", &bedrock.AgentAgentActionGroupArgs{
ActionGroupName: pulumi.String("example"),
AgentId: pulumi.String("ABDJFOWER1"),
AgentVersion: pulumi.String("DRAFT"),
SkipResourceInUseCheck: pulumi.Bool(true),
ActionGroupExecutor: &bedrock.AgentAgentActionGroupActionGroupExecutorArgs{
Lambda: pulumi.String("arn:aws:lambda:us-east-1:123456789012:function:example-function"),
},
ApiSchema: &bedrock.AgentAgentActionGroupApiSchemaArgs{
S3: &bedrock.AgentAgentActionGroupApiSchemaS3Args{
S3BucketName: pulumi.String("example-bucket"),
S3ObjectKey: pulumi.String("path/to/schema.json"),
},
},
})
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.AgentAgentActionGroup("example", new()
{
ActionGroupName = "example",
AgentId = "ABDJFOWER1",
AgentVersion = "DRAFT",
SkipResourceInUseCheck = true,
ActionGroupExecutor = new Aws.Bedrock.Inputs.AgentAgentActionGroupActionGroupExecutorArgs
{
Lambda = "arn:aws:lambda:us-east-1:123456789012:function:example-function",
},
ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
{
S3 = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaS3Args
{
S3BucketName = "example-bucket",
S3ObjectKey = "path/to/schema.json",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentAgentActionGroup;
import com.pulumi.aws.bedrock.AgentAgentActionGroupArgs;
import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupActionGroupExecutorArgs;
import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupApiSchemaArgs;
import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupApiSchemaS3Args;
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 AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
.actionGroupName("example")
.agentId("ABDJFOWER1")
.agentVersion("DRAFT")
.skipResourceInUseCheck(true)
.actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
.lambda("arn:aws:lambda:us-east-1:123456789012:function:example-function")
.build())
.apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
.s3(AgentAgentActionGroupApiSchemaS3Args.builder()
.s3BucketName("example-bucket")
.s3ObjectKey("path/to/schema.json")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:bedrock:AgentAgentActionGroup
properties:
actionGroupName: example
agentId: ABDJFOWER1
agentVersion: DRAFT
skipResourceInUseCheck: true
actionGroupExecutor:
lambda: arn:aws:lambda:us-east-1:123456789012:function:example-function
apiSchema:
s3:
s3BucketName: example-bucket
s3ObjectKey: path/to/schema.json
Create AgentAgentActionGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentAgentActionGroup(name: string, args: AgentAgentActionGroupArgs, opts?: CustomResourceOptions);
@overload
def AgentAgentActionGroup(resource_name: str,
args: AgentAgentActionGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AgentAgentActionGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
action_group_name: Optional[str] = None,
agent_id: Optional[str] = None,
agent_version: Optional[str] = None,
action_group_executor: Optional[AgentAgentActionGroupActionGroupExecutorArgs] = None,
action_group_state: Optional[str] = None,
api_schema: Optional[AgentAgentActionGroupApiSchemaArgs] = None,
description: Optional[str] = None,
parent_action_group_signature: Optional[str] = None,
skip_resource_in_use_check: Optional[bool] = None)
func NewAgentAgentActionGroup(ctx *Context, name string, args AgentAgentActionGroupArgs, opts ...ResourceOption) (*AgentAgentActionGroup, error)
public AgentAgentActionGroup(string name, AgentAgentActionGroupArgs args, CustomResourceOptions? opts = null)
public AgentAgentActionGroup(String name, AgentAgentActionGroupArgs args)
public AgentAgentActionGroup(String name, AgentAgentActionGroupArgs args, CustomResourceOptions options)
type: aws:bedrock:AgentAgentActionGroup
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 AgentAgentActionGroupArgs
- 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 AgentAgentActionGroupArgs
- 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 AgentAgentActionGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentAgentActionGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentAgentActionGroupArgs
- 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 agentAgentActionGroupResource = new Aws.Bedrock.AgentAgentActionGroup("agentAgentActionGroupResource", new()
{
ActionGroupName = "string",
AgentId = "string",
AgentVersion = "string",
ActionGroupExecutor = new Aws.Bedrock.Inputs.AgentAgentActionGroupActionGroupExecutorArgs
{
Lambda = "string",
},
ActionGroupState = "string",
ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
{
Payload = "string",
S3 = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaS3Args
{
S3BucketName = "string",
S3ObjectKey = "string",
},
},
Description = "string",
ParentActionGroupSignature = "string",
SkipResourceInUseCheck = false,
});
example, err := bedrock.NewAgentAgentActionGroup(ctx, "agentAgentActionGroupResource", &bedrock.AgentAgentActionGroupArgs{
ActionGroupName: pulumi.String("string"),
AgentId: pulumi.String("string"),
AgentVersion: pulumi.String("string"),
ActionGroupExecutor: &bedrock.AgentAgentActionGroupActionGroupExecutorArgs{
Lambda: pulumi.String("string"),
},
ActionGroupState: pulumi.String("string"),
ApiSchema: &bedrock.AgentAgentActionGroupApiSchemaArgs{
Payload: pulumi.String("string"),
S3: &bedrock.AgentAgentActionGroupApiSchemaS3Args{
S3BucketName: pulumi.String("string"),
S3ObjectKey: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
ParentActionGroupSignature: pulumi.String("string"),
SkipResourceInUseCheck: pulumi.Bool(false),
})
var agentAgentActionGroupResource = new AgentAgentActionGroup("agentAgentActionGroupResource", AgentAgentActionGroupArgs.builder()
.actionGroupName("string")
.agentId("string")
.agentVersion("string")
.actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
.lambda("string")
.build())
.actionGroupState("string")
.apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
.payload("string")
.s3(AgentAgentActionGroupApiSchemaS3Args.builder()
.s3BucketName("string")
.s3ObjectKey("string")
.build())
.build())
.description("string")
.parentActionGroupSignature("string")
.skipResourceInUseCheck(false)
.build());
agent_agent_action_group_resource = aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource",
action_group_name="string",
agent_id="string",
agent_version="string",
action_group_executor=aws.bedrock.AgentAgentActionGroupActionGroupExecutorArgs(
lambda_="string",
),
action_group_state="string",
api_schema=aws.bedrock.AgentAgentActionGroupApiSchemaArgs(
payload="string",
s3=aws.bedrock.AgentAgentActionGroupApiSchemaS3Args(
s3_bucket_name="string",
s3_object_key="string",
),
),
description="string",
parent_action_group_signature="string",
skip_resource_in_use_check=False)
const agentAgentActionGroupResource = new aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource", {
actionGroupName: "string",
agentId: "string",
agentVersion: "string",
actionGroupExecutor: {
lambda: "string",
},
actionGroupState: "string",
apiSchema: {
payload: "string",
s3: {
s3BucketName: "string",
s3ObjectKey: "string",
},
},
description: "string",
parentActionGroupSignature: "string",
skipResourceInUseCheck: false,
});
type: aws:bedrock:AgentAgentActionGroup
properties:
actionGroupExecutor:
lambda: string
actionGroupName: string
actionGroupState: string
agentId: string
agentVersion: string
apiSchema:
payload: string
s3:
s3BucketName: string
s3ObjectKey: string
description: string
parentActionGroupSignature: string
skipResourceInUseCheck: false
AgentAgentActionGroup 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 AgentAgentActionGroup resource accepts the following input properties:
- Action
Group stringName - Name of the Agent Action Group.
- Agent
Id string - Id of the Agent for the Action Group.
- Agent
Version string - Version of the Agent to attach the Action Group to.
- Action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- Action
Group stringState - Api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- Description string
- Parent
Action stringGroup Signature - Skip
Resource boolIn Use Check
- Action
Group stringName - Name of the Agent Action Group.
- Agent
Id string - Id of the Agent for the Action Group.
- Agent
Version string - Version of the Agent to attach the Action Group to.
- Action
Group AgentExecutor Agent Action Group Action Group Executor Args - Configuration of the executor for the Action Group.
- Action
Group stringState - Api
Schema AgentAgent Action Group Api Schema Args - Configuration of the API Schema for the Action Group.
- Description string
- Parent
Action stringGroup Signature - Skip
Resource boolIn Use Check
- action
Group StringName - Name of the Agent Action Group.
- agent
Id String - Id of the Agent for the Action Group.
- agent
Version String - Version of the Agent to attach the Action Group to.
- action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- action
Group StringState - api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- description String
- parent
Action StringGroup Signature - skip
Resource BooleanIn Use Check
- action
Group stringName - Name of the Agent Action Group.
- agent
Id string - Id of the Agent for the Action Group.
- agent
Version string - Version of the Agent to attach the Action Group to.
- action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- action
Group stringState - api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- description string
- parent
Action stringGroup Signature - skip
Resource booleanIn Use Check
- action_
group_ strname - Name of the Agent Action Group.
- agent_
id str - Id of the Agent for the Action Group.
- agent_
version str - Version of the Agent to attach the Action Group to.
- action_
group_ Agentexecutor Agent Action Group Action Group Executor Args - Configuration of the executor for the Action Group.
- action_
group_ strstate - api_
schema AgentAgent Action Group Api Schema Args - Configuration of the API Schema for the Action Group.
- description str
- parent_
action_ strgroup_ signature - skip_
resource_ boolin_ use_ check
- action
Group StringName - Name of the Agent Action Group.
- agent
Id String - Id of the Agent for the Action Group.
- agent
Version String - Version of the Agent to attach the Action Group to.
- action
Group Property MapExecutor - Configuration of the executor for the Action Group.
- action
Group StringState - api
Schema Property Map - Configuration of the API Schema for the Action Group.
- description String
- parent
Action StringGroup Signature - skip
Resource BooleanIn Use Check
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentAgentActionGroup resource produces the following output properties:
- Action
Group stringId - Id string
- The provider-assigned unique ID for this managed resource.
- Action
Group stringId - Id string
- The provider-assigned unique ID for this managed resource.
- action
Group StringId - id String
- The provider-assigned unique ID for this managed resource.
- action
Group stringId - id string
- The provider-assigned unique ID for this managed resource.
- action_
group_ strid - id str
- The provider-assigned unique ID for this managed resource.
- action
Group StringId - id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AgentAgentActionGroup Resource
Get an existing AgentAgentActionGroup 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?: AgentAgentActionGroupState, opts?: CustomResourceOptions): AgentAgentActionGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action_group_executor: Optional[AgentAgentActionGroupActionGroupExecutorArgs] = None,
action_group_id: Optional[str] = None,
action_group_name: Optional[str] = None,
action_group_state: Optional[str] = None,
agent_id: Optional[str] = None,
agent_version: Optional[str] = None,
api_schema: Optional[AgentAgentActionGroupApiSchemaArgs] = None,
description: Optional[str] = None,
parent_action_group_signature: Optional[str] = None,
skip_resource_in_use_check: Optional[bool] = None) -> AgentAgentActionGroup
func GetAgentAgentActionGroup(ctx *Context, name string, id IDInput, state *AgentAgentActionGroupState, opts ...ResourceOption) (*AgentAgentActionGroup, error)
public static AgentAgentActionGroup Get(string name, Input<string> id, AgentAgentActionGroupState? state, CustomResourceOptions? opts = null)
public static AgentAgentActionGroup get(String name, Output<String> id, AgentAgentActionGroupState 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.
- Action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- Action
Group stringId - Action
Group stringName - Name of the Agent Action Group.
- Action
Group stringState - Agent
Id string - Id of the Agent for the Action Group.
- Agent
Version string - Version of the Agent to attach the Action Group to.
- Api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- Description string
- Parent
Action stringGroup Signature - Skip
Resource boolIn Use Check
- Action
Group AgentExecutor Agent Action Group Action Group Executor Args - Configuration of the executor for the Action Group.
- Action
Group stringId - Action
Group stringName - Name of the Agent Action Group.
- Action
Group stringState - Agent
Id string - Id of the Agent for the Action Group.
- Agent
Version string - Version of the Agent to attach the Action Group to.
- Api
Schema AgentAgent Action Group Api Schema Args - Configuration of the API Schema for the Action Group.
- Description string
- Parent
Action stringGroup Signature - Skip
Resource boolIn Use Check
- action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- action
Group StringId - action
Group StringName - Name of the Agent Action Group.
- action
Group StringState - agent
Id String - Id of the Agent for the Action Group.
- agent
Version String - Version of the Agent to attach the Action Group to.
- api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- description String
- parent
Action StringGroup Signature - skip
Resource BooleanIn Use Check
- action
Group AgentExecutor Agent Action Group Action Group Executor - Configuration of the executor for the Action Group.
- action
Group stringId - action
Group stringName - Name of the Agent Action Group.
- action
Group stringState - agent
Id string - Id of the Agent for the Action Group.
- agent
Version string - Version of the Agent to attach the Action Group to.
- api
Schema AgentAgent Action Group Api Schema - Configuration of the API Schema for the Action Group.
- description string
- parent
Action stringGroup Signature - skip
Resource booleanIn Use Check
- action_
group_ Agentexecutor Agent Action Group Action Group Executor Args - Configuration of the executor for the Action Group.
- action_
group_ strid - action_
group_ strname - Name of the Agent Action Group.
- action_
group_ strstate - agent_
id str - Id of the Agent for the Action Group.
- agent_
version str - Version of the Agent to attach the Action Group to.
- api_
schema AgentAgent Action Group Api Schema Args - Configuration of the API Schema for the Action Group.
- description str
- parent_
action_ strgroup_ signature - skip_
resource_ boolin_ use_ check
- action
Group Property MapExecutor - Configuration of the executor for the Action Group.
- action
Group StringId - action
Group StringName - Name of the Agent Action Group.
- action
Group StringState - agent
Id String - Id of the Agent for the Action Group.
- agent
Version String - Version of the Agent to attach the Action Group to.
- api
Schema Property Map - Configuration of the API Schema for the Action Group.
- description String
- parent
Action StringGroup Signature - skip
Resource BooleanIn Use Check
Supporting Types
AgentAgentActionGroupActionGroupExecutor, AgentAgentActionGroupActionGroupExecutorArgs
- Lambda string
- ARN of the Lambda that defines the business logic for the action group.
- Lambda string
- ARN of the Lambda that defines the business logic for the action group.
- lambda String
- ARN of the Lambda that defines the business logic for the action group.
- lambda string
- ARN of the Lambda that defines the business logic for the action group.
- lambda_ str
- ARN of the Lambda that defines the business logic for the action group.
- lambda String
- ARN of the Lambda that defines the business logic for the action group.
AgentAgentActionGroupApiSchema, AgentAgentActionGroupApiSchemaArgs
- Payload string
- YAML or JSON OpenAPI Schema.
- S3
Agent
Agent Action Group Api Schema S3 - Configuration of S3 schema location
- Payload string
- YAML or JSON OpenAPI Schema.
- S3
Agent
Agent Action Group Api Schema S3 - Configuration of S3 schema location
- payload String
- YAML or JSON OpenAPI Schema.
- s3
Agent
Agent Action Group Api Schema S3 - Configuration of S3 schema location
- payload string
- YAML or JSON OpenAPI Schema.
- s3
Agent
Agent Action Group Api Schema S3 - Configuration of S3 schema location
- payload str
- YAML or JSON OpenAPI Schema.
- s3
Agent
Agent Action Group Api Schema S3 - Configuration of S3 schema location
- payload String
- YAML or JSON OpenAPI Schema.
- s3 Property Map
- Configuration of S3 schema location
AgentAgentActionGroupApiSchemaS3, AgentAgentActionGroupApiSchemaS3Args
- S3Bucket
Name string - The S3 bucket name that contains the OpenAPI Schema.
- S3Object
Key string The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
- S3Bucket
Name string - The S3 bucket name that contains the OpenAPI Schema.
- S3Object
Key string The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
- s3Bucket
Name String - The S3 bucket name that contains the OpenAPI Schema.
- s3Object
Key String The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
- s3Bucket
Name string - The S3 bucket name that contains the OpenAPI Schema.
- s3Object
Key string The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
- s3_
bucket_ strname - The S3 bucket name that contains the OpenAPI Schema.
- s3_
object_ strkey The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
- s3Bucket
Name String - The S3 bucket name that contains the OpenAPI Schema.
- s3Object
Key String The S3 Object Key for the OpenAPI Schema in the S3 Bucket.
The following arguments are optional:
Import
Using pulumi import
, import Agents for Amazon Bedrock Agent Action Group using the example_id_arg
. For example:
$ pulumi import aws:bedrock/agentAgentActionGroup:AgentAgentActionGroup example ABDJFOWER1,HSKTNKANI4,DRAFT
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.
Try AWS Native preview for resources not in the classic version.