@aws-cdk/aws-bedrock-alpha.GuardrailAttributes

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GuardrailAttributes Struct

**************************************************************************** ATTRS FOR IMPORTED CONSTRUCT ***************************************************************************.

Stability

Experimental

Source

bedrock/guardrails/guardrails.ts

Example

declare const stack: Stack;
const cmk = new kms.Key(this, 'cmk', {});
// Import an existing guardrail by ARN
const importedGuardrail = bedrock.Guardrail.fromGuardrailAttributes(stack, 'TestGuardrail', {
  guardrailArn: 'arn:aws:bedrock:us-east-1:123456789012:guardrail/oygh3o8g7rtl',
  guardrailVersion: '1', //optional
  kmsKey: cmk, //optional
});

Properties

guardrailArnstringguardrail_arnstrguardrailArnStringGuardrailArnstringGuardrailArn*stringrequired#

The ARN of the guardrail.

At least one of guardrailArn or guardrailId must be defined in order to initialize a guardrail ref.

guardrailVersion?optionalstringguardrail_version?optionalstrguardrailVersion?optionalStringGuardrailVersion?optionalstringGuardrailVersion?optional*string= "DRAFT"#

The version of the guardrail.

kmsKey?optionalIKeykms_key?optionalIKeykmsKey?optionalIKeyKmsKey?optionalIKeyKmsKey?optionalIKey#

The KMS key of the guardrail if custom encryption is configured.

Default: undefined - Means data is encrypted by default with a AWS-managed key