java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.bedrock.AgentAgentActionGroup

public class AgentAgentActionGroup
extends com.pulumi.resources.CustomResource

Manages an AWS Agents for Amazon Bedrock Agent Action Group. ## 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.AgentAgentActionGroup;
 import com.pulumi.aws.bedrock.AgentAgentActionGroupArgs;
 import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupActionGroupExecutorArgs;
 import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupApiSchemaArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 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 AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
             .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
                 .lambda("arn:aws:lambda:us-west-2:123456789012:function:example-function")
                 .build())
             .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
                 .payload(StdFunctions.file(FileArgs.builder()
                     .input("path/to/schema.yaml")
                     .build()).result())
                 .build())
             .actionGroupName("example")
             .agentId("GGRRAED6JP")
             .agentVersion("DRAFT")
             .skipResourceInUseCheck(true)
             .build());
 
     }
 }

### API Schema in S3 Bucket

 
 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.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 AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
             .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
                 .lambda("arn:aws:lambda:us-west-2:123456789012:function:example-function")
                 .build())
             .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
                 .s3(AgentAgentActionGroupApiSchemaS3Args.builder()
                     .s3BucketName("example-bucket")
                     .s3ObjectKey("path/to/schema.json")
                     .build())
                 .build())
             .actionGroupName("example")
             .agentId("GGRRAED6JP")
             .agentVersion("DRAFT")
             .skipResourceInUseCheck(true)
             .build());
 
     }
 }

### Function Schema (Simplified Schema)

 
 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.AgentAgentActionGroupFunctionSchemaArgs;
 import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs;
 import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs;
 import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs;
 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 AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
             .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
                 .lambda("arn:aws:lambda:us-west-2:123456789012:function:example-function")
                 .build())
             .functionSchema(AgentAgentActionGroupFunctionSchemaArgs.builder()
                 .memberFunctions(AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs.builder()
                     .functions(AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs.builder()
                         .parameters(                        
                             AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs.builder()
                                 .mapBlockKey("param1")
                                 .type("string")
                                 .description("The first parameter")
                                 .required(true)
                                 .build(),
                             AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs.builder()
                                 .mapBlockKey("param2")
                                 .type("integer")
                                 .description("The second parameter")
                                 .required(false)
                                 .build())
                         .name("example-function")
                         .description("Example function")
                         .build())
                     .build())
                 .build())
             .actionGroupName("example")
             .agentId("GGRRAED6JP")
             .agentVersion("DRAFT")
             .skipResourceInUseCheck(true)
             .build());
 
     }
 }

### Return of Control

 
 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.std.StdFunctions;
 import com.pulumi.std.inputs.FileArgs;
 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 AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
             .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
                 .customControl("RETURN_CONTROL")
                 .build())
             .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
                 .payload(StdFunctions.file(FileArgs.builder()
                     .input("path/to/schema.yaml")
                     .build()).result())
                 .build())
             .actionGroupName("example")
             .agentId("GGRRAED6JP")
             .agentVersion("DRAFT")
             .skipResourceInUseCheck(true)
             .build());
 
     }
 }

## Import Using `pulumi import`, import Agents for Amazon Bedrock Agent Action Group using the action group ID, the agent ID, and the agent version separated by `,`. For example: ```sh $ pulumi import aws:bedrock/agentAgentActionGroup:AgentAgentActionGroup example MMAUDBZTH4,GGRRAED6JP,DRAFT ```

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

Constructor Summary

Constructors
Constructor	Description
`AgentAgentActionGroup(java.lang.String name)`
`AgentAgentActionGroup(java.lang.String name, AgentAgentActionGroupArgs args)`
`AgentAgentActionGroup(java.lang.String name, AgentAgentActionGroupArgs args, com.pulumi.resources.CustomResourceOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupActionGroupExecutor>>`	`actionGroupExecutor()`
`com.pulumi.core.Output<java.lang.String>`	`actionGroupId()`
`com.pulumi.core.Output<java.lang.String>`	`actionGroupName()`
`com.pulumi.core.Output<java.lang.String>`	`actionGroupState()`
`com.pulumi.core.Output<java.lang.String>`	`agentId()`
`com.pulumi.core.Output<java.lang.String>`	`agentVersion()`
`com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupApiSchema>>`	`apiSchema()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`description()`
`com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupFunctionSchema>>`	`functionSchema()`
`static AgentAgentActionGroup`	`get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentAgentActionGroupState 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.util.Optional<java.lang.String>>`	`parentActionGroupSignature()`
`com.pulumi.core.Output<java.lang.Boolean>`	`prepareAgent()`
`com.pulumi.core.Output<java.lang.String>`	`region()`
`com.pulumi.core.Output<java.lang.Boolean>`	`skipResourceInUseCheck()`
`com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupTimeouts>>`	`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
  - AgentAgentActionGroup
```
public AgentAgentActionGroup(java.lang.String name)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
  - AgentAgentActionGroup
```
public AgentAgentActionGroup(java.lang.String name,
                             AgentAgentActionGroupArgs args)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
  - AgentAgentActionGroup
```
public AgentAgentActionGroup(java.lang.String name,
                             AgentAgentActionGroupArgs 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
  - actionGroupExecutor
```
public com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupActionGroupExecutor>> actionGroupExecutor()
```
    Returns:
    
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See `actionGroupExecutor` Block for details.
  - actionGroupId
```
public com.pulumi.core.Output<java.lang.String> actionGroupId()
```
    Returns:
    
    Unique identifier of the action group.
  - actionGroupName
```
public com.pulumi.core.Output<java.lang.String> actionGroupName()
```
    Returns:
    
    Name of the action group.
  - actionGroupState
```
public com.pulumi.core.Output<java.lang.String> actionGroupState()
```
    Returns:
    
    Whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Valid values: `ENABLED`, `DISABLED`.
  - agentId
```
public com.pulumi.core.Output<java.lang.String> agentId()
```
    Returns:
    
    Unique identifier of the agent for which to create the action group.
  - agentVersion
```
public com.pulumi.core.Output<java.lang.String> agentVersion()
```
    Returns:
    
    Version of the agent for which to create the action group. Valid values: `DRAFT`. The following arguments are optional:
  - apiSchema
```
public com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupApiSchema>> apiSchema()
```
    Returns:
    
    Either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). See `apiSchema` Block for details.
  - description
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
```
    Returns:
    
    Description of the action group.
  - functionSchema
```
public com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupFunctionSchema>> functionSchema()
```
    Returns:
    
    Function schema for the action group. Each function represents an action in an action group. See `functionSchema` Block for details.
  - parentActionGroupSignature
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> parentActionGroupSignature()
```
    Returns:
    
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to `AMAZON.UserInput`. You must leave the `description`, `apiSchema`, and `actionGroupExecutor` arguments blank for this action group. Valid values: `AMAZON.UserInput`.
  - prepareAgent
```
public com.pulumi.core.Output<java.lang.Boolean> prepareAgent()
```
    Returns:
    
    Whether to prepare the agent after creation or modification. Defaults to `true`.
  - 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.
  - skipResourceInUseCheck
```
public com.pulumi.core.Output<java.lang.Boolean> skipResourceInUseCheck()
```
    Returns:
    
    Whether to skip the in-use check when deleting the action group. Defaults to `false`.
  - timeouts
```
public com.pulumi.core.Output<java.util.Optional<AgentAgentActionGroupTimeouts>> timeouts()
```
  - get
```
public static AgentAgentActionGroup get(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        AgentAgentActionGroupState 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.

Class AgentAgentActionGroup

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

AgentAgentActionGroup

AgentAgentActionGroup

AgentAgentActionGroup

Method Detail

actionGroupExecutor

actionGroupId

actionGroupName

actionGroupState

agentId

agentVersion

apiSchema

description

functionSchema

parentActionGroupSignature

prepareAgent

region

skipResourceInUseCheck

timeouts

get