Class: AWSCDK::Wisdom::CfnAIGuardrail

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSWisdom::IAIGuardrailRef
Defined in:
wisdom/cfn_ai_guardrail.rb

Overview

Creates an Amazon Q in Connect AI Guardrail.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAIGuardrail

Create a new AWS::Wisdom::AIGuardrail.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Wisdom::CfnAIGuardrailProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'wisdom/cfn_ai_guardrail.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrailProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd2lzZG9tLkNmbkFJR3VhcmRyYWlsUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_ai_guardrail(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'wisdom/cfn_ai_guardrail.rb', line 85

def self.arn_for_ai_guardrail(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c193aXNkb20uSUFJR3VhcmRyYWlsUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_wisdom.CfnAIGuardrail", "arnForAIGuardrail", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'wisdom/cfn_ai_guardrail.rb', line 192

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

.is_cfn_ai_guardrail(x) ⇒ Boolean

Checks whether the given object is a CfnAIGuardrail.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'wisdom/cfn_ai_guardrail.rb', line 94

def self.is_cfn_ai_guardrail(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_wisdom.CfnAIGuardrail", "isCfnAIGuardrail", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
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
 
# File 'wisdom/cfn_ai_guardrail.rb', line 26

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 },
    :ai_guardrail_ref => { kind: :property, name: "aiGuardrailRef", is_optional: false },
    :attr_ai_guardrail_arn => { kind: :property, name: "attrAiGuardrailArn", is_optional: false },
    :attr_ai_guardrail_id => { kind: :property, name: "attrAiGuardrailId", is_optional: false },
    :attr_assistant_arn => { kind: :property, name: "attrAssistantArn", is_optional: false },
    :attr_modified_time_seconds => { kind: :property, name: "attrModifiedTimeSeconds", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :assistant_id => { kind: :property, name: "assistantId", is_optional: false },
    :blocked_input_messaging => { kind: :property, name: "blockedInputMessaging", is_optional: false },
    :blocked_outputs_messaging => { kind: :property, name: "blockedOutputsMessaging", is_optional: false },
    :content_policy_config => { kind: :property, name: "contentPolicyConfig", is_optional: true },
    :contextual_grounding_policy_config => { kind: :property, name: "contextualGroundingPolicyConfig", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :name => { kind: :property, name: "name", 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.



409
410
411
412
 
# File 'wisdom/cfn_ai_guardrail.rb', line 409

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:



421
422
423
424
 
# File 'wisdom/cfn_ai_guardrail.rb', line 421

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:



431
432
433
434
 
# File 'wisdom/cfn_ai_guardrail.rb', line 431

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:



442
443
444
445
446
 
# File 'wisdom/cfn_ai_guardrail.rb', line 442

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.


499
500
501
502
503
 
# File 'wisdom/cfn_ai_guardrail.rb', line 499

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.



509
510
511
512
 
# File 'wisdom/cfn_ai_guardrail.rb', line 509

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.



521
522
523
524
525
 
# File 'wisdom/cfn_ai_guardrail.rb', line 521

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

#ai_guardrail_ref ⇒ AWSCDK::Interfaces::AWSWisdom::AIGuardrailReference

A reference to a AIGuardrail resource.

Returns:



199
200
201
 
# File 'wisdom/cfn_ai_guardrail.rb', line 199

def ai_guardrail_ref()
  jsii_get_property("aiGuardrailRef")
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:



534
535
536
537
 
# File 'wisdom/cfn_ai_guardrail.rb', line 534

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:



556
557
558
559
560
561
 
# File 'wisdom/cfn_ai_guardrail.rb', line 556

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

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant.

Returns:

  • (String) 


239
240
241
 
# File 'wisdom/cfn_ai_guardrail.rb', line 239

def assistant_id()
  jsii_get_property("assistantId")
end

#assistant_id=(value) ⇒ Object 



243
244
245
246
 
# File 'wisdom/cfn_ai_guardrail.rb', line 243

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

#attr_ai_guardrail_arn ⇒ String

The Amazon Resource Name (ARN) of the AI Guardrail.

Returns:

  • (String) 


206
207
208
 
# File 'wisdom/cfn_ai_guardrail.rb', line 206

def attr_ai_guardrail_arn()
  jsii_get_property("attrAiGuardrailArn")
end

#attr_ai_guardrail_id ⇒ String

The identifier of the Amazon Q in Connect AI Guardrail.

Returns:

  • (String) 


213
214
215
 
# File 'wisdom/cfn_ai_guardrail.rb', line 213

def attr_ai_guardrail_id()
  jsii_get_property("attrAiGuardrailId")
end

#attr_assistant_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

  • (String) 


220
221
222
 
# File 'wisdom/cfn_ai_guardrail.rb', line 220

def attr_assistant_arn()
  jsii_get_property("attrAssistantArn")
end

#attr_modified_time_seconds ⇒ AWSCDK::IResolvable

Returns:



225
226
227
 
# File 'wisdom/cfn_ai_guardrail.rb', line 225

def attr_modified_time_seconds()
  jsii_get_property("attrModifiedTimeSeconds")
end

#blocked_input_messaging ⇒ String

The message to return when the AI Guardrail blocks a prompt.

Returns:

  • (String) 


251
252
253
 
# File 'wisdom/cfn_ai_guardrail.rb', line 251

def blocked_input_messaging()
  jsii_get_property("blockedInputMessaging")
end

#blocked_input_messaging=(value) ⇒ Object 



255
256
257
258
 
# File 'wisdom/cfn_ai_guardrail.rb', line 255

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 AI Guardrail blocks a model response.

Returns:

  • (String) 


263
264
265
 
# File 'wisdom/cfn_ai_guardrail.rb', line 263

def blocked_outputs_messaging()
  jsii_get_property("blockedOutputsMessaging")
end

#blocked_outputs_messaging=(value) ⇒ Object 



267
268
269
270
 
# File 'wisdom/cfn_ai_guardrail.rb', line 267

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:



232
233
234
 
# File 'wisdom/cfn_ai_guardrail.rb', line 232

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 'wisdom/cfn_ai_guardrail.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'wisdom/cfn_ai_guardrail.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


565
566
567
568
 
# File 'wisdom/cfn_ai_guardrail.rb', line 565

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}) 


155
156
157
 
# File 'wisdom/cfn_ai_guardrail.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'wisdom/cfn_ai_guardrail.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content_policy_config ⇒ AWSCDK::IResolvable, ...

Contains details about how to handle harmful content.

Returns:



275
276
277
 
# File 'wisdom/cfn_ai_guardrail.rb', line 275

def content_policy_config()
  jsii_get_property("contentPolicyConfig")
end

#content_policy_config=(value) ⇒ Object 



279
280
281
282
283
 
# File 'wisdom/cfn_ai_guardrail.rb', line 279

def content_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrail::AIGuardrailContentPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlHdWFyZHJhaWwuQUlHdWFyZHJhaWxDb250ZW50UG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "contentPolicyConfig") unless value.nil?
  jsii_set_property("contentPolicyConfig", value)
end

#contextual_grounding_policy_config ⇒ AWSCDK::IResolvable, ...

The policy configuration details for the AI Guardrail's contextual grounding policy.

Returns:



288
289
290
 
# File 'wisdom/cfn_ai_guardrail.rb', line 288

def contextual_grounding_policy_config()
  jsii_get_property("contextualGroundingPolicyConfig")
end

#contextual_grounding_policy_config=(value) ⇒ Object 



292
293
294
295
296
 
# File 'wisdom/cfn_ai_guardrail.rb', line 292

def contextual_grounding_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrail::AIGuardrailContextualGroundingPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlHdWFyZHJhaWwuQUlHdWFyZHJhaWxDb250ZXh0dWFsR3JvdW5kaW5nUG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "contextualGroundingPolicyConfig") unless value.nil?
  jsii_set_property("contextualGroundingPolicyConfig", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'wisdom/cfn_ai_guardrail.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description of the AI Guardrail.

Returns:

  • (String, nil) 


301
302
303
 
# File 'wisdom/cfn_ai_guardrail.rb', line 301

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



305
306
307
308
 
# File 'wisdom/cfn_ai_guardrail.rb', line 305

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:



167
168
169
 
# File 'wisdom/cfn_ai_guardrail.rb', line 167

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:



578
579
580
581
582
 
# File 'wisdom/cfn_ai_guardrail.rb', line 578

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:



589
590
591
592
 
# File 'wisdom/cfn_ai_guardrail.rb', line 589

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



659
660
661
662
 
# File 'wisdom/cfn_ai_guardrail.rb', line 659

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


119
120
121
 
# File 'wisdom/cfn_ai_guardrail.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the AI Guardrail.

Returns:

  • (String, nil) 


313
314
315
 
# File 'wisdom/cfn_ai_guardrail.rb', line 313

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



317
318
319
320
 
# File 'wisdom/cfn_ai_guardrail.rb', line 317

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'wisdom/cfn_ai_guardrail.rb', line 102

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:



600
601
602
 
# File 'wisdom/cfn_ai_guardrail.rb', line 600

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:



607
608
609
 
# File 'wisdom/cfn_ai_guardrail.rb', line 607

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.



400
401
402
403
 
# File 'wisdom/cfn_ai_guardrail.rb', line 400

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) 


138
139
140
 
# File 'wisdom/cfn_ai_guardrail.rb', line 138

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:



618
619
620
621
 
# File 'wisdom/cfn_ai_guardrail.rb', line 618

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}) 


625
626
627
628
 
# File 'wisdom/cfn_ai_guardrail.rb', line 625

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:



635
636
637
638
639
 
# File 'wisdom/cfn_ai_guardrail.rb', line 635

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

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Returns:



325
326
327
 
# File 'wisdom/cfn_ai_guardrail.rb', line 325

def sensitive_information_policy_config()
  jsii_get_property("sensitiveInformationPolicyConfig")
end

#sensitive_information_policy_config=(value) ⇒ Object 



329
330
331
332
333
 
# File 'wisdom/cfn_ai_guardrail.rb', line 329

def sensitive_information_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrail::AIGuardrailSensitiveInformationPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlHdWFyZHJhaWwuQUlHdWFyZHJhaWxTZW5zaXRpdmVJbmZvcm1hdGlvblBvbGljeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "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.



644
645
646
 
# File 'wisdom/cfn_ai_guardrail.rb', line 644

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:



128
129
130
 
# File 'wisdom/cfn_ai_guardrail.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash{String => String}, nil) 


338
339
340
 
# File 'wisdom/cfn_ai_guardrail.rb', line 338

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



342
343
344
345
 
# File 'wisdom/cfn_ai_guardrail.rb', line 342

def tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "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



376
377
378
 
# File 'wisdom/cfn_ai_guardrail.rb', line 376

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

#topic_policy_config ⇒ AWSCDK::IResolvable, ...

Contains details about topics that the AI Guardrail should identify and deny.

Returns:



350
351
352
 
# File 'wisdom/cfn_ai_guardrail.rb', line 350

def topic_policy_config()
  jsii_get_property("topicPolicyConfig")
end

#topic_policy_config=(value) ⇒ Object 



354
355
356
357
358
 
# File 'wisdom/cfn_ai_guardrail.rb', line 354

def topic_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrail::AIGuardrailTopicPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlHdWFyZHJhaWwuQUlHdWFyZHJhaWxUb3BpY1BvbGljeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "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}) 


175
176
177
 
# File 'wisdom/cfn_ai_guardrail.rb', line 175

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}) 


185
186
187
 
# File 'wisdom/cfn_ai_guardrail.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


650
651
652
653
 
# File 'wisdom/cfn_ai_guardrail.rb', line 650

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) 


389
390
391
392
393
394
 
# File 'wisdom/cfn_ai_guardrail.rb', line 389

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

Contains details about the word policy to configured for the AI Guardrail.

Returns:



363
364
365
 
# File 'wisdom/cfn_ai_guardrail.rb', line 363

def word_policy_config()
  jsii_get_property("wordPolicyConfig")
end

#word_policy_config=(value) ⇒ Object 



367
368
369
370
371
 
# File 'wisdom/cfn_ai_guardrail.rb', line 367

def word_policy_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIGuardrail::AIGuardrailWordPolicyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlHdWFyZHJhaWwuQUlHdWFyZHJhaWxXb3JkUG9saWN5Q29uZmlnUHJvcGVydHkifV19fQ==")), "wordPolicyConfig") unless value.nil?
  jsii_set_property("wordPolicyConfig", value)
end