Package com.pulumi.aws.bedrock

Class AgentFlow

  • public class AgentFlow
extends com.pulumi.resources.CustomResource
    Manages an AWS Bedrock Agents Flow. ## 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.AgentFlow;
 import com.pulumi.aws.bedrock.AgentFlowArgs;
 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 AgentFlow("example", AgentFlowArgs.builder()
             .name("example-flow")
             .executionRoleArn(exampleAwsIamRole.arn())
             .build());
 
     }
 }
    ### Default definition 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.bedrock.AgentFlow;
 import com.pulumi.aws.bedrock.AgentFlowArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionConnectionArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionConnectionConfigurationArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionConnectionConfigurationDataArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationInputArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeOutputArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfigurationArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfigurationTextArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationTextArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationTextInputVariableArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeInputArgs;
 import com.pulumi.aws.bedrock.inputs.AgentFlowDefinitionNodeConfigurationOutputArgs;
 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 AgentFlow("example", AgentFlowArgs.builder()
             .definition(AgentFlowDefinitionArgs.builder()
                 .connections(                
                     AgentFlowDefinitionConnectionArgs.builder()
                         .configuration(AgentFlowDefinitionConnectionConfigurationArgs.builder()
                             .data(AgentFlowDefinitionConnectionConfigurationDataArgs.builder()
                                 .sourceOutput("document")
                                 .targetInput("topic")
                                 .build())
                             .build())
                         .name("FlowInputNodeFlowInputNode0ToPrompt_1PromptsNode0")
                         .source("FlowInputNode")
                         .target("Prompt_1")
                         .type("Data")
                         .build(),
                     AgentFlowDefinitionConnectionArgs.builder()
                         .configuration(AgentFlowDefinitionConnectionConfigurationArgs.builder()
                             .data(AgentFlowDefinitionConnectionConfigurationDataArgs.builder()
                                 .sourceOutput("modelCompletion")
                                 .targetInput("document")
                                 .build())
                             .build())
                         .name("Prompt_1PromptsNode0ToFlowOutputNodeFlowOutputNode0")
                         .source("Prompt_1")
                         .target("FlowOutputNode")
                         .type("Data")
                         .build())
                 .nodes(                
                     AgentFlowDefinitionNodeArgs.builder()
                         .configuration(AgentFlowDefinitionNodeConfigurationArgs.builder()
                             .input(AgentFlowDefinitionNodeConfigurationInputArgs.builder()
                                 .build())
                             .build())
                         .outputs(AgentFlowDefinitionNodeOutputArgs.builder()
                             .name("document")
                             .type("String")
                             .build())
                         .name("FlowInputNode")
                         .type("Input")
                         .build(),
                     AgentFlowDefinitionNodeArgs.builder()
                         .configuration(AgentFlowDefinitionNodeConfigurationArgs.builder()
                             .prompt(AgentFlowDefinitionNodeConfigurationPromptArgs.builder()
                                 .sourceConfiguration(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationArgs.builder()
                                     .inline(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineArgs.builder()
                                         .inferenceConfiguration(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfigurationArgs.builder()
                                             .text(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfigurationTextArgs.builder()
                                                 .maxTokens(2048)
                                                 .stopSequences("User:")
                                                 .temperature(0.0)
                                                 .topP(0.8999999761581421)
                                                 .build())
                                             .build())
                                         .templateConfiguration(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationArgs.builder()
                                             .text(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationTextArgs.builder()
                                                 .inputVariables(AgentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationTextInputVariableArgs.builder()
                                                     .name("topic")
                                                     .build())
                                                 .text("Write a paragraph about {{topic}}.")
                                                 .build())
                                             .build())
                                         .modelId("amazon.titan-text-express-v1")
                                         .templateType("TEXT")
                                         .build())
                                     .build())
                                 .build())
                             .build())
                         .inputs(AgentFlowDefinitionNodeInputArgs.builder()
                             .expression("$.data")
                             .name("topic")
                             .type("String")
                             .build())
                         .outputs(AgentFlowDefinitionNodeOutputArgs.builder()
                             .name("modelCompletion")
                             .type("String")
                             .build())
                         .name("Prompt_1")
                         .type("Prompt")
                         .build(),
                     AgentFlowDefinitionNodeArgs.builder()
                         .configuration(AgentFlowDefinitionNodeConfigurationArgs.builder()
                             .output(AgentFlowDefinitionNodeConfigurationOutputArgs.builder()
                                 .build())
                             .build())
                         .inputs(AgentFlowDefinitionNodeInputArgs.builder()
                             .expression("$.data")
                             .name("document")
                             .type("String")
                             .build())
                         .name("FlowOutputNode")
                         .type("Output")
                         .build())
                 .build())
             .name("example")
             .executionRoleArn(exampleAwsIamRole.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Bedrock Agents Flow using the `id`. For example: ```sh $ pulumi import aws:bedrock/agentFlow:AgentFlow example ABCDEFGHIJ ```

    • 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
      AgentFlow​(java.lang.String name)  
      AgentFlow​(java.lang.String name, AgentFlowArgs args)  
      AgentFlow​(java.lang.String name, AgentFlowArgs 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.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerEncryptionKeyArn()  
      com.pulumi.core.Output<java.util.Optional<AgentFlowDefinition>> definition()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> executionRoleArn()  
      static AgentFlow get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentFlowState 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.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<AgentFlowTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> updatedAt()  
      com.pulumi.core.Output<java.lang.String> version()  

      • 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

      • AgentFlow

        public AgentFlow​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • AgentFlow

        public AgentFlow​(java.lang.String name,
                 AgentFlowArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • AgentFlow

        public AgentFlow​(java.lang.String name,
                 AgentFlowArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the flow.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Time at which the flow was created.

      • customerEncryptionKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerEncryptionKeyArn()
        Returns:
        ARN of the KMS key to encrypt the flow.

      • definition

        public com.pulumi.core.Output<java.util.Optional<AgentFlowDefinition>> definition()
        Returns:
        Nodes and connections between nodes in the flow. See `definition` Block for details.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the flow.

      • executionRoleArn

        public com.pulumi.core.Output<java.lang.String> executionRoleArn()
        Returns:
        ARN of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the flow. The following arguments are optional:

      • 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.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the flow.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<AgentFlowTimeouts>> timeouts()

      • updatedAt

        public com.pulumi.core.Output<java.lang.String> updatedAt()
        Returns:
        Time at which the flow was last updated.

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version of the flow.

      • get

        public static AgentFlow get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            AgentFlowState 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.