Skip to content
v2.278.0

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 ***************************************************************************.

Example ​

ts
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
});
python
# stack: Stack

cmk = kms.Key(self, "cmk")
# Import an existing guardrail by ARN
imported_guardrail = bedrock.Guardrail.from_guardrail_attributes(stack, "TestGuardrail",
    guardrail_arn="arn:aws:bedrock:us-east-1:123456789012:guardrail/oygh3o8g7rtl",
    guardrail_version="1",  # optional
    kms_key=cmk
)
java
Stack stack;

Key cmk = Key.Builder.create(this, "cmk").build();
// Import an existing guardrail by ARN
IGuardrail importedGuardrail = Guardrail.fromGuardrailAttributes(stack, "TestGuardrail", GuardrailAttributes.builder()
        .guardrailArn("arn:aws:bedrock:us-east-1:123456789012:guardrail/oygh3o8g7rtl")
        .guardrailVersion("1") //optional
        .kmsKey(cmk)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
Stack stack;

var cmk = new Key(this, "cmk", new KeyProps { });
// Import an existing guardrail by ARN
var importedGuardrail = Guardrail.FromGuardrailAttributes(stack, "TestGuardrail", new GuardrailAttributes {
    GuardrailArn = "arn:aws:bedrock:us-east-1:123456789012:guardrail/oygh3o8g7rtl",
    GuardrailVersion = "1",  //optional
    KmsKey = cmk
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
var stack Stack

cmk := kms.NewKey(this, jsii.String("cmk"), &KeyProps{
})
// Import an existing guardrail by ARN
importedGuardrail := bedrock.Guardrail_FromGuardrailAttributes(stack, jsii.String("TestGuardrail"), &GuardrailAttributes{
	GuardrailArn: jsii.String("arn:aws:bedrock:us-east-1:123456789012:guardrail/oygh3o8g7rtl"),
	GuardrailVersion: jsii.String("1"),
	 //optional
	KmsKey: cmk,
})

Properties ​

guardrailArnstringguardrail_arnstrguardrailArnStringGuardrailArnstringGuardrailArn*string required #
The ARN of the guardrail.

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

guardrailVersionoptionalstringguardrail_versionoptionalstrguardrailVersionoptionalStringGuardrailVersionoptionalstringGuardrailVersionoptional*string = "DRAFT" #
The version of the guardrail.
kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey #
The KMS key of the guardrail if custom encryption is configured.

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