Interface PolicyEngineProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
PolicyEngineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-10T17:51:40.360Z") @Stability(Stable) public interface PolicyEngineProps extends software.amazon.jsii.JsiiSerializable
Properties for creating a PolicyEngine resource.

Example:

 PolicyEngine policyEngine = PolicyEngine.Builder.create(this, "MyEngine")
         .policyEngineName("my_engine")
         .build();
 Role lambdaRole = Role.Builder.create(this, "LambdaRole")
         .assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
         .build();
 // Grant read permissions
 policyEngine.grantRead(lambdaRole);
 // Grant evaluation permissions
 policyEngine.grantEvaluate(lambdaRole);
 
  • Method Details

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Optional description for the policy engine.

      Maximum 4,096 characters.

      Default: - No description

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      Custom KMS key for encryption.

      [disable-awslint:prefer-ref-interface]

      Default: - AWS owned key

    • getPolicyEngineName

      @Stability(Stable) @Nullable default String getPolicyEngineName()
      The name of the policy engine.

      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

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      Tags for the policy engine.

      Maximum 50 tags.

      Default: - No tags

    • builder

      @Stability(Stable) static PolicyEngineProps.Builder builder()
      Returns:
      a PolicyEngineProps.Builder of PolicyEngineProps