AgentcorePolicy class
Manages an AWS Bedrock AgentCore Policy. A Policy attaches Cedar authorization rules to a Policy Engine, which evaluates them at runtime to control agent access to resources.
Example Usage
Cedar Policy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentcorePolicy("example", {
definition: {
cedar: {
statement: "permit(principal, action == Action::\\\"Read\\\", resource);\n",
},
},
name: "example_policy",
policyEngineId: exampleAwsBedrockagentcorePolicyEngine.policyEngineId,
description: "Allow read access to example resources",
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentcorePolicy("example",
definition={
"cedar": {
"statement": "permit(principal, action == Action::\\\"Read\\\", resource);\n",
},
},
name="example_policy",
policy_engine_id=example_aws_bedrockagentcore_policy_engine["policyEngineId"],
description="Allow read access to example resources")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentcorePolicy("example", new()
{
Definition = new Aws.Bedrock.Inputs.AgentcorePolicyDefinitionArgs
{
Cedar = new Aws.Bedrock.Inputs.AgentcorePolicyDefinitionCedarArgs
{
Statement = @"permit(principal, action == Action::\""Read\"", resource);
",
},
},
Name = "example_policy",
PolicyEngineId = exampleAwsBedrockagentcorePolicyEngine.PolicyEngineId,
Description = "Allow read access to example resources",
});
});
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.NewAgentcorePolicy(ctx, "example", &bedrock.AgentcorePolicyArgs{
Definition: &bedrock.AgentcorePolicyDefinitionArgs{
Cedar: &bedrock.AgentcorePolicyDefinitionCedarArgs{
Statement: pulumi.String("permit(principal, action == Action::\\\"Read\\\", resource);\n"),
},
},
Name: pulumi.String("example_policy"),
PolicyEngineId: pulumi.Any(exampleAwsBedrockagentcorePolicyEngine.PolicyEngineId),
Description: pulumi.String("Allow read access to example resources"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_agentcorepolicy" "example" {
definition = {
cedar = {
statement = "permit(principal, action == Action::\\\"Read\\\", resource);\n"
}
}
name = "example_policy"
policy_engine_id = exampleAwsBedrockagentcorePolicyEngine.policyEngineId
description = "Allow read access to example resources"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentcorePolicy;
import com.pulumi.aws.bedrock.AgentcorePolicyArgs;
import com.pulumi.aws.bedrock.inputs.AgentcorePolicyDefinitionArgs;
import com.pulumi.aws.bedrock.inputs.AgentcorePolicyDefinitionCedarArgs;
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 AgentcorePolicy("example", AgentcorePolicyArgs.builder()
.definition(AgentcorePolicyDefinitionArgs.builder()
.cedar(AgentcorePolicyDefinitionCedarArgs.builder()
.statement("""
permit(principal, action == Action::\"Read\", resource);
""")
.build())
.build())
.name("example_policy")
.policyEngineId(exampleAwsBedrockagentcorePolicyEngine.policyEngineId())
.description("Allow read access to example resources")
.build());
}
}
resources:
example:
type: aws:bedrock:AgentcorePolicy
properties:
definition:
cedar:
statement: |
permit(principal, action == Action::\"Read\", resource);
name: example_policy
policyEngineId: ${exampleAwsBedrockagentcorePolicyEngine.policyEngineId}
description: Allow read access to example resources
Import
Identity Schema
Required
policyEngineId(String) ID of the policy engine.policyId(String) ID of the policy.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Bedrock AgentCore Policies using the policyEngineId and policyId separated by a comma. For example:
$ pulumi import aws:bedrock/agentcorePolicy:AgentcorePolicy example PolicyEngine_i2fo6-dyqwrzl954,policy_ar2c3-o_rospxr2j
Constructors
- AgentcorePolicy(String name, {AgentcorePolicyArgs? args, CustomResourceOptions? options})
-
Creates a new AgentcorePolicy.
nameThe Pulumi resource name.argsArguments used to configure this AgentcorePolicy. The set of arguments for AgentcorePolicy.optionsResource options controlling this resource's behavior. - AgentcorePolicy.reference(String urn)
- Creates a typed reference to an existing AgentcorePolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
definition
↔ Output<
AgentcorePolicyDefinition> -
Policy definition. See
definitionBlock for details.latefinal -
description
↔ Output<
String?> -
Description of the policy.
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
-
name
↔ Output<
String> -
Name of the policy. Must be 1-48 characters and match the pattern
^[A-Za-z][A-Za-z0-9_]*$. Changing this forces a new resource to be created.latefinal -
policyArn
↔ Output<
String> -
ARN of the Policy.
latefinal
-
policyEngineId
↔ Output<
String> -
Identifier of the Policy Engine that owns this policy. Changing this forces a new resource to be created.
latefinal
-
policyId
↔ Output<
String> -
Identifier of the Policy.
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<
AgentcorePolicyTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
validationMode
↔ Output<
String?> -
Controls whether validation findings cause policy creation or update to fail. Valid values:
FAIL_ON_ANY_FINDINGS,IGNORE_ALL_FINDINGS. Defaults toFAIL_ON_ANY_FINDINGS.latefinal
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, {AgentcorePolicyState? state, CustomResourceOptions? options}) → AgentcorePolicy -
Gets an existing AgentcorePolicy resource's state with the given
nameandid.