Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
GuardrailBase L2 construct
Abstract base class for a Guardrail.
Contains methods and attributes valid for Guardrails either created with CDK or imported.
Initializer
new GuardrailBase(scope: Construct, id: string, props?: ResourceProps)
GuardrailBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new GuardrailBase(Construct scope, String id, ResourceProps props)
new GuardrailBase(Construct scope, string id, ResourceProps? props = null)
NewGuardrailBase(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
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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.
guardrailVersionstringguardrail_versionstrguardrailVersionStringGuardrailVersionstringGuardrailVersion*stringrequired#kmsKeymay be undefinedIKeykms_keymay be undefinedIKeykmsKeymay be undefinedIKeyKmsKeymay be undefinedIKeyKmsKeymay be undefinedIKey#lastUpdatedmay be undefinedstringlast_updatedmay be undefinedstrlastUpdatedmay be undefinedStringLastUpdatedmay be undefinedstringLastUpdatedmay be undefined*string#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]
grantApply(grantee: IGrantable): Grantdef grant_apply(self, grantee: IGrantable) -> Grantpublic Grant grantApply(IGrantable grantee)public Grant GrantApply(IGrantable grantee)func GrantApply(Grantee IGrantable) Grant#[disable-awslint:no-grants]
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, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *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.
metricAll(metricName: string, props?: MetricOptions): Metric@staticmethod def metric_all(metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAll(String metricName, MetricOptions props)public static Metric MetricAll(string metricName, MetricOptions? props = null)func MetricAll(MetricName *string, Props MetricOptions) Metricstatic#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.
metricAllInvocationLatency(props?: MetricOptions): Metric@staticmethod def metric_all_invocation_latency(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllInvocationLatency(MetricOptions props)public static Metric MetricAllInvocationLatency(MetricOptions? props = null)func MetricAllInvocationLatency(Props MetricOptions) Metricstatic#metricAllInvocations(props?: MetricOptions): Metric@staticmethod def metric_all_invocations(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllInvocations(MetricOptions props)public static Metric MetricAllInvocations(MetricOptions? props = null)func MetricAllInvocations(Props MetricOptions) Metricstatic#metricAllInvocationsIntervened(props?: MetricOptions): Metric@staticmethod def metric_all_invocations_intervened(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllInvocationsIntervened(MetricOptions props)public static Metric MetricAllInvocationsIntervened(MetricOptions? props = null)func MetricAllInvocationsIntervened(Props MetricOptions) Metricstatic#metricAllTextUnitCount(props?: MetricOptions): Metric@staticmethod def metric_all_text_unit_count(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricAllTextUnitCount(MetricOptions props)public static Metric MetricAllTextUnitCount(MetricOptions? props = null)func MetricAllTextUnitCount(Props MetricOptions) Metricstatic#metricInvocationClientErrors(props?: MetricOptions): Metricdef metric_invocation_client_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationClientErrors(MetricOptions props)public Metric MetricInvocationClientErrors(MetricOptions? props = null)func MetricInvocationClientErrors(Props MetricOptions) Metric#metricInvocationLatency(props?: MetricOptions): Metricdef metric_invocation_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationLatency(MetricOptions props)public Metric MetricInvocationLatency(MetricOptions? props = null)func MetricInvocationLatency(Props MetricOptions) Metric#metricInvocations(props?: MetricOptions): Metricdef metric_invocations(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocations(MetricOptions props)public Metric MetricInvocations(MetricOptions? props = null)func MetricInvocations(Props MetricOptions) Metric#metricInvocationServerErrors(props?: MetricOptions): Metricdef metric_invocation_server_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationServerErrors(MetricOptions props)public Metric MetricInvocationServerErrors(MetricOptions? props = null)func MetricInvocationServerErrors(Props MetricOptions) Metric#metricInvocationsIntervened(props?: MetricOptions): Metricdef metric_invocations_intervened(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationsIntervened(MetricOptions props)public Metric MetricInvocationsIntervened(MetricOptions? props = null)func MetricInvocationsIntervened(Props MetricOptions) Metric#metricInvocationThrottles(props?: MetricOptions): Metricdef metric_invocation_throttles(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationThrottles(MetricOptions props)public Metric MetricInvocationThrottles(MetricOptions? props = null)func MetricInvocationThrottles(Props MetricOptions) Metric#metricTextUnitCount(props?: MetricOptions): Metricdef metric_text_unit_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTextUnitCount(MetricOptions props)public Metric MetricTextUnitCount(MetricOptions? props = null)func MetricTextUnitCount(Props MetricOptions) Metric#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.