Class Policy.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Policy>
- Enclosing class:
Policy
Policy.-
Method Summary
Modifier and TypeMethodDescriptionbuild()static Policy.Builderdescription(String description) Optional description for the policy.policyEngine(IPolicyEngine policyEngine) The policy engine this policy belongs to.policyName(String policyName) The name of the policy.statement(PolicyStatement statement) The Cedar policy statement for this policy.validationMode(PolicyValidationMode validationMode) Validation mode for the policy.
-
Method Details
-
create
@Stability(Stable) public static Policy.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope- This parameter is required.id- This parameter is required.- Returns:
- a new instance of
Policy.Builder.
-
policyEngine
The policy engine this policy belongs to.[disable-awslint:prefer-ref-interface]
- Parameters:
policyEngine- The policy engine this policy belongs to. This parameter is required.- Returns:
this
-
statement
The Cedar policy statement for this policy.Build a type-safe statement with the
PolicyStatementfactories, which validate at synthesis time and reject values that cannot be represented safely in Cedar.For raw Cedar (features this API does not model, or migrating an existing policy), use
PolicyStatement.fromCedar('...'). That string is used exactly as given: the module does not escape, quote, or validate it, so it is treated as trusted input and you own its correctness and safety. Do not assemble it from values that come from outside your application, such as a request body or a database record.- Parameters:
statement- The Cedar policy statement for this policy. This parameter is required.- Returns:
this
-
description
Optional description for the policy.Maximum length of 4096.
Default: - No description
- Parameters:
description- Optional description for the policy. This parameter is required.- Returns:
this
-
policyName
The name of the policy.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
- Parameters:
policyName- The name of the policy. This parameter is required.- Returns:
this
-
validationMode
Validation mode for the policy.Controls how Cedar analyzer validation findings are handled.
Default: PolicyValidationMode.FAIL_ON_ANY_FINDINGS
- Parameters:
validationMode- Validation mode for the policy. This parameter is required.- Returns:
this
-
build
-