Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
IPolicy Interface
Minimal reference interface for Policy resources.
Used for resource identification and ARN construction.
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#policyEngineIPolicyEnginepolicy_engineIPolicyEnginepolicyEngineIPolicyEnginePolicyEngineIPolicyEnginePolicyEngineIPolicyEngine#policyRefPolicyReferencepolicy_refPolicyReferencepolicyRefPolicyReferencePolicyRefPolicyReferencePolicyRefPolicyReference#validationModemay be undefinedPolicyValidationModevalidation_modemay be undefinedPolicyValidationModevalidationModemay be undefinedPolicyValidationModeValidationModemay be undefinedPolicyValidationModeValidationModemay be undefinedPolicyValidationMode#Methods
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#2 parameters
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant permissions to.actionsactionsactionsactionsActions— - The actions to grant.
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 configuration. Use this for monitoring, audit, or read-only administrative roles that need to inspect policy definitions.
1 parameter
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
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#3 parameters
Parameters
metricNamemetric_namemetricNamemetricNameMetricName— The name of the metric.dimensionsdimensionsdimensionsdimensionsDimensions— Additional dimensions for the metric.propspropspropspropsProps— Optional metric configuration.
metricEvaluationLatency(props?: MetricOptions): Metricdef metric_evaluation_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEvaluationLatency(MetricOptions props)public Metric MetricEvaluationLatency(MetricOptions? props = null)func MetricEvaluationLatency(Props MetricOptions) Metric#This metric represents the time taken to evaluate this specific policy.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
metricEvaluations(props?: MetricOptions): Metricdef metric_evaluations(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEvaluations(MetricOptions props)public Metric MetricEvaluations(MetricOptions? props = null)func MetricEvaluations(Props MetricOptions) Metric#This metric tracks how many times this policy has been evaluated.
1 parameter
Parameters
propspropspropspropsProps— Optional metric configuration.
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.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining