Package software.amazon.awscdk.services.bedrock.alpha

Interface GuardrailAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GuardrailAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:42.808Z")
@Stability(Experimental)
public interface GuardrailAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) **************************************************************************** ATTRS FOR IMPORTED CONSTRUCT ***************************************************************************.

Example:

 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GuardrailAttributes.Builder	A builder for GuardrailAttributes
static final class	GuardrailAttributes.Jsii$Proxy	An implementation for GuardrailAttributes

Method Summary

Modifier and Type	Method	Description
static GuardrailAttributes.Builder	builder()
String	getGuardrailArn()	(experimental) The ARN of the guardrail.
default String	getGuardrailVersion()	(experimental) The version of the guardrail.
default IKey	getKmsKey()	(experimental) The KMS key of the guardrail if custom encryption is configured.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGuardrailArn

@Stability(Experimental)
@NotNull
String getGuardrailArn()

(experimental) The ARN of the guardrail.

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

getGuardrailVersion

@Stability(Experimental)
@Nullable
default String getGuardrailVersion()

(experimental) The version of the guardrail.

Default: "DRAFT"

getKmsKey

@Stability(Experimental)
@Nullable
default IKey getKmsKey()

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

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

builder

@Stability(Experimental)
static GuardrailAttributes.Builder builder()

Returns:

a GuardrailAttributes.Builder of GuardrailAttributes