Interface IPolicy
- All Superinterfaces:
software.constructs.IConstruct,software.constructs.IDependable,IEnvironmentAware,IGrantable,IPolicyRef,IResource,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IPolicy.Jsii$Default
- All Known Implementing Classes:
IPolicy.Jsii$Proxy,Policy,PolicyBase
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
date="2026-09-10T17:51:40.286Z")
@Stability(Stable)
public interface IPolicy
extends software.amazon.jsii.JsiiSerializable, IResource, IPolicyRef, IGrantable
Minimal reference interface for Policy resources.
Used for resource identification and ARN construction.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceInternal default implementation forIPolicy.static final classA proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptiondefault StringThe description of the policy.The ARN of the policy resource.The policy engine this policy belongs to.The ID of the policy.The name of the policy.default PolicyValidationModeThe validation mode for the policy.grant(IGrantable grantee, String... actions) Grants IAM actions to the IAM Principal.grantRead(IGrantable grantee) Grants read permissions on the Policy (data plane).Return the given named metric for this policy.metric(String metricName, MetricOptions props) Return the given named metric for this policy.Return a metric measuring the evaluation latency for this policy.Return a metric measuring the evaluation latency for this policy.Return a metric containing the total number of evaluations for this policy.metricEvaluations(MetricOptions props) Return a metric containing the total number of evaluations for this policy.Methods inherited from interface software.constructs.IConstruct
getNode, withMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.awscdk.services.iam.IGrantable
getGrantPrincipalMethods inherited from interface software.amazon.awscdk.interfaces.bedrockagentcore.IPolicyRef
getPolicyRefMethods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getStackMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getPolicyArn
The ARN of the policy resource. -
getPolicyEngine
The policy engine this policy belongs to. -
getPolicyId
The ID of the policy. -
getPolicyName
The name of the policy. -
getDescription
The description of the policy. -
getValidationMode
The validation mode for the policy. -
grant
Grants IAM actions to the IAM Principal.- Parameters:
grantee-- The IAM principal to grant permissions to.
actions-- The actions to grant.
-
grantRead
Grants read permissions on the Policy (data plane).This grants runtime read access to policy configuration. Use this for monitoring, audit, or read-only administrative roles that need to inspect policy definitions.
- Parameters:
grantee-- The IAM principal to grant read permissions to.
-
metric
@Stability(Stable) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this policy.- Parameters:
metricName- The name of the metric. This parameter is required.props- Optional metric configuration.
-
metric
Return the given named metric for this policy.- Parameters:
metricName- The name of the metric. This parameter is required.
-
metricEvaluationLatency
Return a metric measuring the evaluation latency for this policy.This metric represents the time taken to evaluate this specific policy.
- Parameters:
props- Optional metric configuration.
-
metricEvaluationLatency
Return a metric measuring the evaluation latency for this policy.This metric represents the time taken to evaluate this specific policy.
-
metricEvaluations
Return a metric containing the total number of evaluations for this policy.This metric tracks how many times this policy has been evaluated.
- Parameters:
props- Optional metric configuration.
-
metricEvaluations
Return a metric containing the total number of evaluations for this policy.This metric tracks how many times this policy has been evaluated.
-