Show / Hide Table of Contents

Class PolicyEngineProps

(experimental) Properties for creating a PolicyEngine resource.

Inheritance
object
PolicyEngineProps
Implements
IPolicyEngineProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll
Syntax (csharp)
public class PolicyEngineProps : IPolicyEngineProps
Syntax (vb)
Public Class PolicyEngineProps Implements IPolicyEngineProps
Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples
var policyEngine = new PolicyEngine(this, "MyEngine", new PolicyEngineProps {
                 PolicyEngineName = "my_engine"
             });

             var lambdaRole = new Role(this, "LambdaRole", new RoleProps {
                 AssumedBy = new ServicePrincipal("lambda.amazonaws.com")
             });

             // Grant read permissions
             policyEngine.GrantRead(lambdaRole);

             // Grant evaluation permissions
             policyEngine.GrantEvaluate(lambdaRole);

Synopsis

Constructors

PolicyEngineProps()

(experimental) Properties for creating a PolicyEngine resource.

Properties

Description

(experimental) Optional description for the policy engine.

KmsKey

(experimental) Custom KMS key for encryption.

PolicyEngineName

(experimental) The name of the policy engine.

Tags

(experimental) Tags for the policy engine.

Constructors

PolicyEngineProps()

(experimental) Properties for creating a PolicyEngine resource.

public PolicyEngineProps()
Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples
var policyEngine = new PolicyEngine(this, "MyEngine", new PolicyEngineProps {
                 PolicyEngineName = "my_engine"
             });

             var lambdaRole = new Role(this, "LambdaRole", new RoleProps {
                 AssumedBy = new ServicePrincipal("lambda.amazonaws.com")
             });

             // Grant read permissions
             policyEngine.GrantRead(lambdaRole);

             // Grant evaluation permissions
             policyEngine.GrantEvaluate(lambdaRole);

Properties

Description

(experimental) Optional description for the policy engine.

public string? Description { get; set; }
Property Value

string

Remarks

Maximum 4,096 characters.

Default: - No description

Stability: Experimental

KmsKey

(experimental) Custom KMS key for encryption.

public IKey? KmsKey { get; set; }
Property Value

IKey

Remarks

[disable-awslint:prefer-ref-interface]

Default: - AWS owned key

Stability: Experimental

PolicyEngineName

(experimental) The name of the policy engine.

public string? PolicyEngineName { get; set; }
Property Value

string

Remarks

Valid characters: a-z, A-Z, 0-9, _ (underscore) Must start with a letter, 1-48 characters Pattern: ^[A-Za-z][A-Za-z0-9_]*$

Default: - Auto-generated unique name

Stability: Experimental

Tags

(experimental) Tags for the policy engine.

public IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

Maximum 50 tags.

Default: - No tags

Stability: Experimental

Implements

IPolicyEngineProps
Back to top Generated by DocFX