Class: AWSCDK::Bedrock::CfnAutomatedReasoningPolicyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_automated_reasoning_policy_props.rb

Overview

Properties for defining a CfnAutomatedReasoningPolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, description: nil, force_delete: nil, kms_key_id: nil, policy_definition: nil, tags: nil) ⇒ CfnAutomatedReasoningPolicyProps

Returns a new instance of CfnAutomatedReasoningPolicyProps.

Parameters:

  • name (String) —

    The name of the policy.

  • description (String, nil) (defaults to: nil) —

    The description of the policy.

  • force_delete (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to force delete the automated reasoning policy even if it has active resources.

  • kms_key_id (String, nil) (defaults to: nil) —

    The KMS key with which the Policy's assets will be encrypted at rest.

  • policy_definition (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnAutomatedReasoningPolicy::PolicyDefinitionProperty, nil) (defaults to: nil) —

    The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags associated with the Automated Reasoning policy.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 15

def initialize(name:, description: nil, force_delete: nil, kms_key_id: nil, policy_definition: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @force_delete = force_delete
  Jsii::Type.check_type(@force_delete, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "forceDelete") unless @force_delete.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @policy_definition = policy_definition.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnAutomatedReasoningPolicy::PolicyDefinitionProperty.new(**policy_definition.transform_keys(&:to_sym)) : policy_definition
  Jsii::Type.check_type(@policy_definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkF1dG9tYXRlZFJlYXNvbmluZ1BvbGljeS5Qb2xpY3lEZWZpbml0aW9uUHJvcGVydHkifV19fQ==")), "policyDefinition") unless @policy_definition.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the policy.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 39

def description
  @description
end

#force_delete ⇒ Boolean, ... (readonly)

Note:

Default: - false

Specifies whether to force delete the automated reasoning policy even if it has active resources.

When false , Amazon Bedrock validates if all artifacts have been deleted (e.g. policy version, test case, test result) for a policy before deletion. When true , Amazon Bedrock will delete the policy and all its artifacts without validation. Default is false

Returns:

See Also:



47
48
49
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 47

def force_delete
  @force_delete
end

#kms_key_id ⇒ String? (readonly)

The KMS key with which the Policy's assets will be encrypted at rest.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 52

def kms_key_id
  @kms_key_id
end

#name ⇒ String (readonly)

The name of the policy.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 34

def name
  @name
end

#policy_definition ⇒ AWSCDK::IResolvable, ... (readonly)

The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

Returns:

See Also:



57
58
59
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 57

def policy_definition
  @policy_definition
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags associated with the Automated Reasoning policy.

Returns:

See Also:



62
63
64
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 62

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 64

def self.jsii_properties
  {
    :name => "name",
    :description => "description",
    :force_delete => "forceDelete",
    :kms_key_id => "kmsKeyId",
    :policy_definition => "policyDefinition",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'bedrock/cfn_automated_reasoning_policy_props.rb', line 75

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "description" => @description,
    "forceDelete" => @force_delete,
    "kmsKeyId" => @kms_key_id,
    "policyDefinition" => @policy_definition,
    "tags" => @tags,
  })
  result.compact
end