Class: AWSCDK::Bedrock::CfnGuardrail

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSBedrock::IGuardrailRef
Defined in:
bedrock/cfn_guardrail.rb

Overview

Creates a guardrail to detect and filter harmful content in your generative AI application.

Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

  • Content filters - Detect and filter harmful text or image content in input prompts or model responses. Filtering is done based on detection of certain predefined harmful content categories: Hate, Insults, Sexual, Violence, Misconduct and Prompt Attack. You also can adjust the filter strength for each of these categories.
  • Denied topics - Define a set of topics that are undesirable in the context of your application. The filter will help block them if detected in user queries or model responses.
  • Word filters - Configure filters to help block undesirable words, phrases, and profanity (exact match). Such words can include offensive terms, competitor names, etc.
  • Sensitive information filters - Configure filters to help block or mask sensitive information, such as personally identifiable information (PII), or custom regex in user inputs and model responses. Blocking or masking is done based on probabilistic detection of sensitive information in standard formats in entities such as SSN number, Date of Birth, address, etc. This also allows configuring regular expression based detection of patterns for identifiers.
  • Contextual grounding check - Help detect and filter hallucinations in model responses based on grounding in a source and relevance to the user query.

For more information, see How Amazon Bedrock Guardrails works .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGuardrail

Create a new AWS::Bedrock::Guardrail.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Bedrock::CfnGuardrailProps) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'bedrock/cfn_guardrail.rb', line 28

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrailProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9jay5DZm5HdWFyZHJhaWxQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_guardrail(resource) ⇒ String

Parameters:

Returns:

  • (String) 


101
102
103
104
 
# File 'bedrock/cfn_guardrail.rb', line 101

def self.arn_for_guardrail(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrLklHdWFyZHJhaWxSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnGuardrail", "arnForGuardrail", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


208
209
210
 
# File 'bedrock/cfn_guardrail.rb', line 208

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrock.CfnGuardrail", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_guardrail(x) ⇒ Boolean

Checks whether the given object is a CfnGuardrail.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


110
111
112
113
 
# File 'bedrock/cfn_guardrail.rb', line 110

def self.is_cfn_guardrail(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnGuardrail", "isCfnGuardrail", [x])
end

.jsii_overridable_methods ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'bedrock/cfn_guardrail.rb', line 36

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_recommendations => { kind: :property, name: "attrFailureRecommendations", is_optional: false },
    :attr_guardrail_arn => { kind: :property, name: "attrGuardrailArn", is_optional: false },
    :attr_guardrail_id => { kind: :property, name: "attrGuardrailId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_reasons => { kind: :property, name: "attrStatusReasons", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :guardrail_ref => { kind: :property, name: "guardrailRef", is_optional: false },
    :blocked_input_messaging => { kind: :property, name: "blockedInputMessaging", is_optional: false },
    :blocked_outputs_messaging => { kind: :property, name: "blockedOutputsMessaging", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :automated_reasoning_policy_config => { kind: :property, name: "automatedReasoningPolicyConfig", is_optional: true },
    :content_policy_config => { kind: :property, name: "contentPolicyConfig", is_optional: true },
    :contextual_grounding_policy_config => { kind: :property, name: "contextualGroundingPolicyConfig", is_optional: true },
    :cross_region_config => { kind: :property, name: "crossRegionConfig", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :sensitive_information_policy_config => { kind: :property, name: "sensitiveInformationPolicyConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :topic_policy_config => { kind: :property, name: "topicPolicyConfig", is_optional: true },
    :word_policy_config => { kind: :property, name: "wordPolicyConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



488
489
490
491
 
# File 'bedrock/cfn_guardrail.rb', line 488

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



500
501
502
503
 
# File 'bedrock/cfn_guardrail.rb', line 500

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



510
511
512
513
 
# File 'bedrock/cfn_guardrail.rb', line 510

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



521
522
523
524
525
 
# File 'bedrock/cfn_guardrail.rb', line 521

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


578
579
580
581
582
 
# File 'bedrock/cfn_guardrail.rb', line 578

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



588
589
590
591
 
# File 'bedrock/cfn_guardrail.rb', line 588

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



600
601
602
603
604
 
# File 'bedrock/cfn_guardrail.rb', line 600

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



613
614
615
616
 
# File 'bedrock/cfn_guardrail.rb', line 613

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



635
636
637
638
639
640
 
# File 'bedrock/cfn_guardrail.rb', line 635

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

Timestamp.

Returns:

  • (String) 


215
216
217
 
# File 'bedrock/cfn_guardrail.rb', line 215

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_recommendations ⇒ Array<String>

Appears if the status of the guardrail is FAILED .

A list of recommendations to carry out before retrying the request.

Returns:

  • (Array<String>) 


224
225
226
 
# File 'bedrock/cfn_guardrail.rb', line 224

def attr_failure_recommendations()
  jsii_get_property("attrFailureRecommendations")
end

#attr_guardrail_arn ⇒ String

The ARN of the guardrail.

Returns:

  • (String) 


231
232
233
 
# File 'bedrock/cfn_guardrail.rb', line 231

def attr_guardrail_arn()
  jsii_get_property("attrGuardrailArn")
end

#attr_guardrail_id ⇒ String

The unique identifier of the guardrail.

Returns:

  • (String) 


238
239
240
 
# File 'bedrock/cfn_guardrail.rb', line 238

def attr_guardrail_id()
  jsii_get_property("attrGuardrailId")
end

#attr_status ⇒ String

The status of the guardrail.

Returns:

  • (String) 


245
246
247
 
# File 'bedrock/cfn_guardrail.rb', line 245

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_reasons ⇒ Array<String>

Appears if the status is FAILED .

A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Returns:

  • (Array<String>) 


254
255
256
 
# File 'bedrock/cfn_guardrail.rb', line 254

def attr_status_reasons()
  jsii_get_property("attrStatusReasons")
end

#attr_updated_at ⇒ String

Timestamp.

Returns:

  • (String) 


261
262
263
 
# File 'bedrock/cfn_guardrail.rb', line 261

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_version ⇒ String

The version of the guardrail that was created.

This value will always be DRAFT .

Returns:

  • (String) 


270
271
272
 
# File 'bedrock/cfn_guardrail.rb', line 270

def attr_version()
  jsii_get_property("attrVersion")
end

#automated_reasoning_policy_config ⇒ AWSCDK::IResolvable, ...

Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

Returns:



327
328
329
 
# File 'bedrock/cfn_guardrail.rb', line 327

def automated_reasoning_policy_config()
  jsii_get_property("automatedReasoningPolicyConfig")
end

#automated_reasoning_policy_config=(value) ⇒ Object 



331
332
333
334
335
 
# File 'bedrock/cfn_guardrail.rb', line 331

def automated_reasoning_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::AutomatedReasoningPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5BdXRvbWF0ZWRSZWFzb25pbmdQb2xpY3lDb25maWdQcm9wZXJ0eSJ9XX19")), "automatedReasoningPolicyConfig") unless value.nil?
  jsii_set_property("automatedReasoningPolicyConfig", value)
end

#blocked_input_messaging ⇒ String

The message to return when the guardrail blocks a prompt.

Returns:

  • (String) 


291
292
293
 
# File 'bedrock/cfn_guardrail.rb', line 291

def blocked_input_messaging()
  jsii_get_property("blockedInputMessaging")
end

#blocked_input_messaging=(value) ⇒ Object 



295
296
297
298
 
# File 'bedrock/cfn_guardrail.rb', line 295

def blocked_input_messaging=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "blockedInputMessaging")
  jsii_set_property("blockedInputMessaging", value)
end

#blocked_outputs_messaging ⇒ String

The message to return when the guardrail blocks a model response.

Returns:

  • (String) 


303
304
305
 
# File 'bedrock/cfn_guardrail.rb', line 303

def blocked_outputs_messaging()
  jsii_get_property("blockedOutputsMessaging")
end

#blocked_outputs_messaging=(value) ⇒ Object 



307
308
309
310
 
# File 'bedrock/cfn_guardrail.rb', line 307

def blocked_outputs_messaging=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "blockedOutputsMessaging")
  jsii_set_property("blockedOutputsMessaging", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



277
278
279
 
# File 'bedrock/cfn_guardrail.rb', line 277

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



161
162
163
 
# File 'bedrock/cfn_guardrail.rb', line 161

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


166
167
168
 
# File 'bedrock/cfn_guardrail.rb', line 166

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


644
645
646
647
 
# File 'bedrock/cfn_guardrail.rb', line 644

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


171
172
173
 
# File 'bedrock/cfn_guardrail.rb', line 171

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


178
179
180
 
# File 'bedrock/cfn_guardrail.rb', line 178

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content_policy_config ⇒ AWSCDK::IResolvable, ...

The content filter policies to configure for the guardrail.

Returns:



340
341
342
 
# File 'bedrock/cfn_guardrail.rb', line 340

def content_policy_config()
  jsii_get_property("contentPolicyConfig")
end

#content_policy_config=(value) ⇒ Object 



344
345
346
347
348
 
# File 'bedrock/cfn_guardrail.rb', line 344

def content_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::ContentPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5Db250ZW50UG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "contentPolicyConfig") unless value.nil?
  jsii_set_property("contentPolicyConfig", value)
end

#contextual_grounding_policy_config ⇒ AWSCDK::IResolvable, ...

Contextual grounding policy config for a guardrail.

Returns:



353
354
355
 
# File 'bedrock/cfn_guardrail.rb', line 353

def contextual_grounding_policy_config()
  jsii_get_property("contextualGroundingPolicyConfig")
end

#contextual_grounding_policy_config=(value) ⇒ Object 



357
358
359
360
361
 
# File 'bedrock/cfn_guardrail.rb', line 357

def contextual_grounding_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::ContextualGroundingPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5Db250ZXh0dWFsR3JvdW5kaW5nUG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "contextualGroundingPolicyConfig") unless value.nil?
  jsii_set_property("contextualGroundingPolicyConfig", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


123
124
125
 
# File 'bedrock/cfn_guardrail.rb', line 123

def creation_stack()
  jsii_get_property("creationStack")
end

#cross_region_config ⇒ AWSCDK::IResolvable, ...

The system-defined guardrail profile that you're using with your guardrail.

Returns:



366
367
368
 
# File 'bedrock/cfn_guardrail.rb', line 366

def cross_region_config()
  jsii_get_property("crossRegionConfig")
end

#cross_region_config=(value) ⇒ Object 



370
371
372
373
374
 
# File 'bedrock/cfn_guardrail.rb', line 370

def cross_region_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::GuardrailCrossRegionConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5HdWFyZHJhaWxDcm9zc1JlZ2lvbkNvbmZpZ1Byb3BlcnR5In1dfX0=")), "crossRegionConfig") unless value.nil?
  jsii_set_property("crossRegionConfig", value)
end

#description ⇒ String?

A description of the guardrail.

Returns:

  • (String, nil) 


379
380
381
 
# File 'bedrock/cfn_guardrail.rb', line 379

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



383
384
385
386
 
# File 'bedrock/cfn_guardrail.rb', line 383

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



183
184
185
 
# File 'bedrock/cfn_guardrail.rb', line 183

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



657
658
659
660
661
 
# File 'bedrock/cfn_guardrail.rb', line 657

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



668
669
670
671
 
# File 'bedrock/cfn_guardrail.rb', line 668

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#guardrail_ref ⇒ AWSCDK::Interfaces::AWSBedrock::GuardrailReference

A reference to a Guardrail resource.

Returns:



284
285
286
 
# File 'bedrock/cfn_guardrail.rb', line 284

def guardrail_ref()
  jsii_get_property("guardrailRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



738
739
740
741
 
# File 'bedrock/cfn_guardrail.rb', line 738

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_arn ⇒ String?

The ARN of the AWS key that you use to encrypt the guardrail.

Returns:

  • (String, nil) 


391
392
393
 
# File 'bedrock/cfn_guardrail.rb', line 391

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



395
396
397
398
 
# File 'bedrock/cfn_guardrail.rb', line 395

def kms_key_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless value.nil?
  jsii_set_property("kmsKeyArn", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


135
136
137
 
# File 'bedrock/cfn_guardrail.rb', line 135

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the guardrail.

Returns:

  • (String) 


315
316
317
 
# File 'bedrock/cfn_guardrail.rb', line 315

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



319
320
321
322
 
# File 'bedrock/cfn_guardrail.rb', line 319

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


118
119
120
 
# File 'bedrock/cfn_guardrail.rb', line 118

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



679
680
681
 
# File 'bedrock/cfn_guardrail.rb', line 679

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



686
687
688
 
# File 'bedrock/cfn_guardrail.rb', line 686

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



479
480
481
482
 
# File 'bedrock/cfn_guardrail.rb', line 479

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


154
155
156
 
# File 'bedrock/cfn_guardrail.rb', line 154

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



697
698
699
700
 
# File 'bedrock/cfn_guardrail.rb', line 697

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


704
705
706
707
 
# File 'bedrock/cfn_guardrail.rb', line 704

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



714
715
716
717
718
 
# File 'bedrock/cfn_guardrail.rb', line 714

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#sensitive_information_policy_config ⇒ AWSCDK::IResolvable, ...

The sensitive information policy to configure for the guardrail.

Returns:



403
404
405
 
# File 'bedrock/cfn_guardrail.rb', line 403

def sensitive_information_policy_config()
  jsii_get_property("sensitiveInformationPolicyConfig")
end

#sensitive_information_policy_config=(value) ⇒ Object 



407
408
409
410
411
 
# File 'bedrock/cfn_guardrail.rb', line 407

def sensitive_information_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::SensitiveInformationPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5TZW5zaXRpdmVJbmZvcm1hdGlvblBvbGljeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "sensitiveInformationPolicyConfig") unless value.nil?
  jsii_set_property("sensitiveInformationPolicyConfig", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



723
724
725
 
# File 'bedrock/cfn_guardrail.rb', line 723

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



144
145
146
 
# File 'bedrock/cfn_guardrail.rb', line 144

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags that you want to attach to the guardrail.

Returns:



416
417
418
 
# File 'bedrock/cfn_guardrail.rb', line 416

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



420
421
422
423
424
 
# File 'bedrock/cfn_guardrail.rb', line 420

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



455
456
457
 
# File 'bedrock/cfn_guardrail.rb', line 455

def to_string()
  jsii_call_method("toString", [])
end

#topic_policy_config ⇒ AWSCDK::IResolvable, ...

The topic policies to configure for the guardrail.

Returns:



429
430
431
 
# File 'bedrock/cfn_guardrail.rb', line 429

def topic_policy_config()
  jsii_get_property("topicPolicyConfig")
end

#topic_policy_config=(value) ⇒ Object 



433
434
435
436
437
 
# File 'bedrock/cfn_guardrail.rb', line 433

def topic_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::TopicPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5Ub3BpY1BvbGljeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "topicPolicyConfig") unless value.nil?
  jsii_set_property("topicPolicyConfig", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'bedrock/cfn_guardrail.rb', line 191

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


201
202
203
 
# File 'bedrock/cfn_guardrail.rb', line 201

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


729
730
731
732
 
# File 'bedrock/cfn_guardrail.rb', line 729

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


468
469
470
471
472
473
 
# File 'bedrock/cfn_guardrail.rb', line 468

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#word_policy_config ⇒ AWSCDK::IResolvable, ...

The word policy you configure for the guardrail.

Returns:



442
443
444
 
# File 'bedrock/cfn_guardrail.rb', line 442

def word_policy_config()
  jsii_get_property("wordPolicyConfig")
end

#word_policy_config=(value) ⇒ Object 



446
447
448
449
450
 
# File 'bedrock/cfn_guardrail.rb', line 446

def word_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnGuardrail::WordPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkd1YXJkcmFpbC5Xb3JkUG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "wordPolicyConfig") unless value.nil?
  jsii_set_property("wordPolicyConfig", value)
end