Class AgentcorePolicyEngine


  • public class AgentcorePolicyEngine
    extends com.pulumi.resources.CustomResource
    Manages an AWS Bedrock AgentCore Policy Engine. A Policy Engine controls what actions and resources an agent runtime can use. ## 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.AgentcorePolicyEngine;
     import com.pulumi.aws.bedrock.AgentcorePolicyEngineArgs;
     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 AgentcorePolicyEngine("example", AgentcorePolicyEngineArgs.builder()
                 .name("example_policy_engine")
                 .build());
     
         }
     }
     
     
    ### With Description
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.bedrock.AgentcorePolicyEngine;
     import com.pulumi.aws.bedrock.AgentcorePolicyEngineArgs;
     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 AgentcorePolicyEngine("example", AgentcorePolicyEngineArgs.builder()
                 .name("example_policy_engine")
                 .description("Policy engine for customer service agent")
                 .build());
     
         }
     }
     
     
    ### With Custom Encryption
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.bedrock.AgentcorePolicyEngine;
     import com.pulumi.aws.bedrock.AgentcorePolicyEngineArgs;
     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 Key("example", KeyArgs.builder()
                 .description("KMS key for Bedrock AgentCore Policy Engine")
                 .deletionWindowInDays(7)
                 .build());
     
             var exampleAgentcorePolicyEngine = new AgentcorePolicyEngine("exampleAgentcorePolicyEngine", AgentcorePolicyEngineArgs.builder()
                 .name("example_policy_engine")
                 .description("Policy engine for customer service agent")
                 .encryptionKeyArn(example.arn())
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `policyEngineId` (String) Policy engine ID. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import a Bedrock AgentCore Policy Engine by policy engine ID. For example: ```sh $ pulumi import aws:bedrock/agentcorePolicyEngine:AgentcorePolicyEngine example policy-engine-id-12345678 ```
    • 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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> encryptionKeyArn()  
      static AgentcorePolicyEngine get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentcorePolicyEngineState 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> policyEngineArn()  
      com.pulumi.core.Output<java.lang.String> policyEngineId()  
      com.pulumi.core.Output<java.lang.String> region()  
      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<AgentcorePolicyEngineTimeouts>> 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

      • AgentcorePolicyEngine

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

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

        public AgentcorePolicyEngine​(java.lang.String name,
                                     @Nullable
                                     AgentcorePolicyEngineArgs 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

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the policy engine.
      • encryptionKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> encryptionKeyArn()
        Returns:
        ARN of the KMS key used to encrypt the policy engine. If not set, the policy engine is encrypted with an AWS owned key.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the policy engine. Must start with a letter and contain only letters, numbers, and underscores. Maximum length of 48 characters. The following arguments are optional:
      • policyEngineArn

        public com.pulumi.core.Output<java.lang.String> policyEngineArn()
        Returns:
        ARN of the Policy Engine.
      • policyEngineId

        public com.pulumi.core.Output<java.lang.String> policyEngineId()
        Returns:
        Unique identifier of the Policy Engine.
      • 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.
      • 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.
      • get

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