Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
PolicyEngineBase L2 construct
Abstract base class for a PolicyEngine.
Contains methods and attributes valid for PolicyEngines either created with CDK or imported.
Initializer
new PolicyEngineBase(scope: Construct, id: string, props?: ResourceProps)
PolicyEngineBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new PolicyEngineBase(Construct scope, String id, ResourceProps props)
new PolicyEngineBase(Construct scope, string id, ResourceProps? props = null)
NewPolicyEngineBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#Default: the resource is in the same account as the stack it belongs to
environmentFromArnoptionalstringenvironment_from_arnoptionalstrenvironmentFromArnoptionalStringEnvironmentFromArnoptionalstringEnvironmentFromArnoptional*string#Default: take environment from account, region parameters, or use Stack environment.
The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.
Cannot be supplied together with either account or region.
physicalNameoptionalstringphysical_nameoptionalstrphysicalNameoptionalStringPhysicalNameoptionalstringPhysicalNameoptional*string#Default: The physical name will be allocated by CloudFormation at deployment time
notes
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
Default: the resource is in the same region as the stack it belongs to
Properties
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#kmsKeymay be undefinedIKeykms_keymay be undefinedIKeykmsKeymay be undefinedIKeyKmsKeymay be undefinedIKeyKmsKeymay be undefinedIKey#policyEngineArnstringpolicy_engine_arnstrpolicyEngineArnStringPolicyEngineArnstringPolicyEngineArn*string#policyEngineIdstringpolicy_engine_idstrpolicyEngineIdStringPolicyEngineIdstringPolicyEngineId*string#policyEngineNamestringpolicy_engine_namestrpolicyEngineNameStringPolicyEngineNamestringPolicyEngineName*string#policyEngineRefPolicyEngineReferencepolicy_engine_refPolicyEngineReferencepolicyEngineRefPolicyEngineReferencePolicyEngineRefPolicyEngineReferencePolicyEngineRefPolicyEngineReference#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#[disable-awslint:no-grants]
2 parameters · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant permissions to.actionsactionsactionsactionsActions— - The actions to grant.
Returns: An IAM Grant object representing the granted permissions
grantEvaluate(grantee: IGrantable): Grantdef grant_evaluate(self, grantee: IGrantable) -> Grantpublic Grant grantEvaluate(IGrantable grantee)public Grant GrantEvaluate(IGrantable grantee)func GrantEvaluate(Grantee IGrantable) Grant#notes · 1 parameter · returns
This is the primary permission needed by Gateway execution roles to evaluate authorization decisions during agent requests. Grant this to roles that need to call AuthorizeAction or PartiallyAuthorizeActions at runtime.
[disable-awslint:no-grants]
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant evaluation permissions to.
Returns: An IAM Grant object representing the granted permissions
grantEvaluateForGateway(grantee: IGrantable, gateway: IGateway): Grantdef grant_evaluate_for_gateway(self, grantee: IGrantable, gateway: IGateway) -> Grantpublic Grant grantEvaluateForGateway(IGrantable grantee, IGateway gateway)public Grant GrantEvaluateForGateway(IGrantable grantee, IGateway gateway)func GrantEvaluateForGateway(Grantee IGrantable, Gateway IGateway) Grant#Per the AWS docs:
GetPolicyEngine→ policy engine ARN onlyAuthorizeAction+PartiallyAuthorizeActions→ policy engine ARN and gateway ARN
[disable-awslint:no-grants]
2 parameters · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal (gateway execution role) to grant permissions to.gatewaygatewaygatewaygatewayGateway— - The gateway that will use this policy engine [disable-awslint:prefer-ref-interface].
Returns: A combined IAM Grant representing all granted permissions
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#This grants runtime read access to policy engine configuration. Use this for monitoring, observability, or read-only administrative roles that need to inspect policy engine settings at runtime.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
Returns: An IAM Grant object representing the granted permissions
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metricdef metric(self, metric_name: str, dimensions: typing.Mapping[str, str], props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, Map<String, String> dimensions, MetricOptions props)public Metric Metric(string metricName, IDictionary<string, string> dimensions, MetricOptions? props = null)func Metric(MetricName *string, Dimensions *map[string]*string, Props MetricOptions) Metric#By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.
3 parameters
Parameters
metricNamemetric_namemetricNamemetricNameMetricName— The name of the metric.dimensionsdimensionsdimensionsdimensionsDimensions— Additional dimensions for the metric.propspropspropspropsProps— Optional metric configuration.
metricAuthorizationLatency(props?: MetricOptions): Metricdef metric_authorization_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricAuthorizationLatency(MetricOptions props)public Metric MetricAuthorizationLatency(MetricOptions? props = null)func MetricAuthorizationLatency(Props MetricOptions) Metric#This metric represents the time taken to evaluate authorization policies.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
metricAuthorizations(props?: MetricOptions): Metricdef metric_authorizations(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricAuthorizations(MetricOptions props)public Metric MetricAuthorizations(MetricOptions? props = null)func MetricAuthorizations(Props MetricOptions) Metric#This metric tracks all authorization requests processed by the policy engine.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
metricDeniedRequests(props?: MetricOptions): Metricdef metric_denied_requests(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDeniedRequests(MetricOptions props)public Metric MetricDeniedRequests(MetricOptions? props = null)func MetricDeniedRequests(Props MetricOptions) Metric#This metric tracks authorization requests that were explicitly denied by policies.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
metricErrors(props?: MetricOptions): Metricdef metric_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricErrors(MetricOptions props)public Metric MetricErrors(MetricOptions? props = null)func MetricErrors(Props MetricOptions) Metric#This metric tracks errors encountered during policy evaluation.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.