Class: AWSCDK::Bedrock::CfnAgent

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

Overview

Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.

For more information about using agents in Amazon Bedrock , see Agents for Amazon Bedrock .

See the Properties section below for descriptions of both the required and optional properties.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAgent

Create a new AWS::Bedrock::Agent.

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::CfnAgentProps) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'bedrock/cfn_agent.rb', line 26

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

Class Method Details

.arn_for_agent(resource) ⇒ String

Parameters:

Returns:

  • (String) 


107
108
109
110
 
# File 'bedrock/cfn_agent.rb', line 107

def self.arn_for_agent(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrLklBZ2VudFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnAgent", "arnForAgent", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


240
241
242
 
# File 'bedrock/cfn_agent.rb', line 240

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

.from_agent_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSBedrock::IAgentRef

Creates a new IAgentRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



118
119
120
121
122
123
 
# File 'bedrock/cfn_agent.rb', line 118

def self.from_agent_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnAgent", "fromAgentArn", [scope, id, arn])
end

.from_agent_id(scope, id, agent_id) ⇒ AWSCDK::Interfaces::AWSBedrock::IAgentRef

Creates a new IAgentRef from a agentId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • agent_id (String)

Returns:



131
132
133
134
135
136
 
# File 'bedrock/cfn_agent.rb', line 131

def self.from_agent_id(scope, id, agent_id)
  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(agent_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnAgent", "fromAgentId", [scope, id, agent_id])
end

.is_cfn_agent(x) ⇒ Boolean

Checks whether the given object is a CfnAgent.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


142
143
144
145
 
# File 'bedrock/cfn_agent.rb', line 142

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

.jsii_overridable_methods ⇒ Object 



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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'bedrock/cfn_agent.rb', line 34

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 },
    :agent_ref => { kind: :property, name: "agentRef", is_optional: false },
    :attr_agent_arn => { kind: :property, name: "attrAgentArn", is_optional: false },
    :attr_agent_id => { kind: :property, name: "attrAgentId", is_optional: false },
    :attr_agent_status => { kind: :property, name: "attrAgentStatus", is_optional: false },
    :attr_agent_version => { kind: :property, name: "attrAgentVersion", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reasons => { kind: :property, name: "attrFailureReasons", is_optional: false },
    :attr_prepared_at => { kind: :property, name: "attrPreparedAt", is_optional: false },
    :attr_recommended_actions => { kind: :property, name: "attrRecommendedActions", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :agent_name => { kind: :property, name: "agentName", is_optional: false },
    :action_groups => { kind: :property, name: "actionGroups", is_optional: true },
    :agent_collaboration => { kind: :property, name: "agentCollaboration", is_optional: true },
    :agent_collaborators => { kind: :property, name: "agentCollaborators", is_optional: true },
    :agent_resource_role_arn => { kind: :property, name: "agentResourceRoleArn", is_optional: true },
    :auto_prepare => { kind: :property, name: "autoPrepare", is_optional: true },
    :customer_encryption_key_arn => { kind: :property, name: "customerEncryptionKeyArn", is_optional: true },
    :custom_orchestration => { kind: :property, name: "customOrchestration", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :foundation_model => { kind: :property, name: "foundationModel", is_optional: true },
    :guardrail_configuration => { kind: :property, name: "guardrailConfiguration", is_optional: true },
    :idle_session_ttl_in_seconds => { kind: :property, name: "idleSessionTtlInSeconds", is_optional: true },
    :instruction => { kind: :property, name: "instruction", is_optional: true },
    :knowledge_bases => { kind: :property, name: "knowledgeBases", is_optional: true },
    :memory_configuration => { kind: :property, name: "memoryConfiguration", is_optional: true },
    :orchestration_type => { kind: :property, name: "orchestrationType", is_optional: true },
    :prompt_override_configuration => { kind: :property, name: "promptOverrideConfiguration", is_optional: true },
    :skip_resource_in_use_check_on_delete => { kind: :property, name: "skipResourceInUseCheckOnDelete", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :test_alias_tags => { kind: :property, name: "testAliasTags", 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

#action_groups ⇒ AWSCDK::IResolvable, ...

The action groups that belong to an agent.

Returns:



344
345
346
 
# File 'bedrock/cfn_agent.rb', line 344

def action_groups()
  jsii_get_property("actionGroups")
end

#action_groups=(value) ⇒ Object 



348
349
350
351
 
# File 'bedrock/cfn_agent.rb', line 348

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

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



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

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:



625
626
627
628
 
# File 'bedrock/cfn_agent.rb', line 625

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:



635
636
637
638
 
# File 'bedrock/cfn_agent.rb', line 635

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:



646
647
648
649
650
 
# File 'bedrock/cfn_agent.rb', line 646

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.


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

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.



713
714
715
716
 
# File 'bedrock/cfn_agent.rb', line 713

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.



725
726
727
728
729
 
# File 'bedrock/cfn_agent.rb', line 725

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

#agent_collaboration ⇒ String?

The agent's collaboration settings.

Returns:

  • (String, nil) 


356
357
358
 
# File 'bedrock/cfn_agent.rb', line 356

def agent_collaboration()
  jsii_get_property("agentCollaboration")
end

#agent_collaboration=(value) ⇒ Object 



360
361
362
363
 
# File 'bedrock/cfn_agent.rb', line 360

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

#agent_collaborators ⇒ AWSCDK::IResolvable, ...

List of Agent Collaborators.

Returns:



368
369
370
 
# File 'bedrock/cfn_agent.rb', line 368

def agent_collaborators()
  jsii_get_property("agentCollaborators")
end

#agent_collaborators=(value) ⇒ Object 



372
373
374
375
 
# File 'bedrock/cfn_agent.rb', line 372

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

#agent_name ⇒ String

The name of the agent.

Returns:

  • (String) 


332
333
334
 
# File 'bedrock/cfn_agent.rb', line 332

def agent_name()
  jsii_get_property("agentName")
end

#agent_name=(value) ⇒ Object 



336
337
338
339
 
# File 'bedrock/cfn_agent.rb', line 336

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

#agent_ref ⇒ AWSCDK::Interfaces::AWSBedrock::AgentReference

A reference to a Agent resource.

Returns:



247
248
249
 
# File 'bedrock/cfn_agent.rb', line 247

def agent_ref()
  jsii_get_property("agentRef")
end

#agent_resource_role_arn ⇒ String?

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

  • (String, nil) 


380
381
382
 
# File 'bedrock/cfn_agent.rb', line 380

def agent_resource_role_arn()
  jsii_get_property("agentResourceRoleArn")
end

#agent_resource_role_arn=(value) ⇒ Object 



384
385
386
387
 
# File 'bedrock/cfn_agent.rb', line 384

def agent_resource_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentResourceRoleArn") unless value.nil?
  jsii_set_property("agentResourceRoleArn", 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:



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

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:



760
761
762
763
764
765
 
# File 'bedrock/cfn_agent.rb', line 760

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_agent_arn ⇒ String

The Amazon Resource Name (ARN) of the agent.

Returns:

  • (String) 


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

def attr_agent_arn()
  jsii_get_property("attrAgentArn")
end

#attr_agent_id ⇒ String

The unique identifier of the agent.

Returns:

  • (String) 


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

def attr_agent_id()
  jsii_get_property("attrAgentId")
end

#attr_agent_status ⇒ String

The status of the agent and whether it is ready for use. The following statuses are possible:.

  • CREATING – The agent is being created.
  • PREPARING – The agent is being prepared.
  • PREPARED – The agent is prepared and ready to be invoked.
  • NOT_PREPARED – The agent has been created but not yet prepared.
  • FAILED – The agent API operation failed.
  • UPDATING – The agent is being updated.
  • DELETING – The agent is being deleted.

Returns:

  • (String) 


276
277
278
 
# File 'bedrock/cfn_agent.rb', line 276

def attr_agent_status()
  jsii_get_property("attrAgentStatus")
end

#attr_agent_version ⇒ String

The version of the agent.

Returns:

  • (String) 


283
284
285
 
# File 'bedrock/cfn_agent.rb', line 283

def attr_agent_version()
  jsii_get_property("attrAgentVersion")
end

#attr_created_at ⇒ String

The time at which the agent was created.

Returns:

  • (String) 


290
291
292
 
# File 'bedrock/cfn_agent.rb', line 290

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reasons ⇒ Array<String>

Contains reasons that the agent-related API that you invoked failed.

Returns:

  • (Array<String>) 


297
298
299
 
# File 'bedrock/cfn_agent.rb', line 297

def attr_failure_reasons()
  jsii_get_property("attrFailureReasons")
end

#attr_prepared_at ⇒ String

The time at which the agent was last prepared.

Returns:

  • (String) 


304
305
306
 
# File 'bedrock/cfn_agent.rb', line 304

def attr_prepared_at()
  jsii_get_property("attrPreparedAt")
end

#attr_recommended_actions ⇒ Array<String>

Contains recommended actions to take for the agent-related API that you invoked to succeed.

Returns:

  • (Array<String>) 


311
312
313
 
# File 'bedrock/cfn_agent.rb', line 311

def attr_recommended_actions()
  jsii_get_property("attrRecommendedActions")
end

#attr_updated_at ⇒ String

The time at which the agent was last updated.

Returns:

  • (String) 


318
319
320
 
# File 'bedrock/cfn_agent.rb', line 318

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#auto_prepare ⇒ Boolean, ...

Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.

Returns:



392
393
394
 
# File 'bedrock/cfn_agent.rb', line 392

def auto_prepare()
  jsii_get_property("autoPrepare")
end

#auto_prepare=(value) ⇒ Object 



396
397
398
399
 
# File 'bedrock/cfn_agent.rb', line 396

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



325
326
327
 
# File 'bedrock/cfn_agent.rb', line 325

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



193
194
195
 
# File 'bedrock/cfn_agent.rb', line 193

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


198
199
200
 
# File 'bedrock/cfn_agent.rb', line 198

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


769
770
771
772
 
# File 'bedrock/cfn_agent.rb', line 769

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


203
204
205
 
# File 'bedrock/cfn_agent.rb', line 203

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


210
211
212
 
# File 'bedrock/cfn_agent.rb', line 210

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


155
156
157
 
# File 'bedrock/cfn_agent.rb', line 155

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_orchestration ⇒ AWSCDK::IResolvable, ...

Contains custom orchestration configurations for the agent.

Returns:



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

def custom_orchestration()
  jsii_get_property("customOrchestration")
end

#custom_orchestration=(value) ⇒ Object 



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

def custom_orchestration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnAgent::CustomOrchestrationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkFnZW50LkN1c3RvbU9yY2hlc3RyYXRpb25Qcm9wZXJ0eSJ9XX19")), "customOrchestration") unless value.nil?
  jsii_set_property("customOrchestration", value)
end

#customer_encryption_key_arn ⇒ String?

The Amazon Resource Name (ARN) of the AWS key that encrypts the agent.

Returns:

  • (String, nil) 


404
405
406
 
# File 'bedrock/cfn_agent.rb', line 404

def customer_encryption_key_arn()
  jsii_get_property("customerEncryptionKeyArn")
end

#customer_encryption_key_arn=(value) ⇒ Object 



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

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

#description ⇒ String?

The description of the agent.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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:



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

def env()
  jsii_get_property("env")
end

#foundation_model ⇒ String?

The foundation model used for orchestration by the agent.

Returns:

  • (String, nil) 


441
442
443
 
# File 'bedrock/cfn_agent.rb', line 441

def foundation_model()
  jsii_get_property("foundationModel")
end

#foundation_model=(value) ⇒ Object 



445
446
447
448
 
# File 'bedrock/cfn_agent.rb', line 445

def foundation_model=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "foundationModel") unless value.nil?
  jsii_set_property("foundationModel", value)
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:



782
783
784
785
786
 
# File 'bedrock/cfn_agent.rb', line 782

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:



793
794
795
796
 
# File 'bedrock/cfn_agent.rb', line 793

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

#guardrail_configuration ⇒ AWSCDK::IResolvable, ...

Details about the guardrail associated with the agent.

Returns:



453
454
455
 
# File 'bedrock/cfn_agent.rb', line 453

def guardrail_configuration()
  jsii_get_property("guardrailConfiguration")
end

#guardrail_configuration=(value) ⇒ Object 



457
458
459
460
461
 
# File 'bedrock/cfn_agent.rb', line 457

def guardrail_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnAgent::GuardrailConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkFnZW50Lkd1YXJkcmFpbENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "guardrailConfiguration") unless value.nil?
  jsii_set_property("guardrailConfiguration", value)
end

#idle_session_ttl_in_seconds ⇒ Numeric?

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

Returns:

  • (Numeric, nil) 


466
467
468
 
# File 'bedrock/cfn_agent.rb', line 466

def idle_session_ttl_in_seconds()
  jsii_get_property("idleSessionTtlInSeconds")
end

#idle_session_ttl_in_seconds=(value) ⇒ Object 



470
471
472
473
 
# File 'bedrock/cfn_agent.rb', line 470

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



863
864
865
866
 
# File 'bedrock/cfn_agent.rb', line 863

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

#instruction ⇒ String?

Instructions that tell the agent what it should do and how it should interact with users.

Returns:

  • (String, nil) 


478
479
480
 
# File 'bedrock/cfn_agent.rb', line 478

def instruction()
  jsii_get_property("instruction")
end

#instruction=(value) ⇒ Object 



482
483
484
485
 
# File 'bedrock/cfn_agent.rb', line 482

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

#knowledge_bases ⇒ AWSCDK::IResolvable, ...

The knowledge bases associated with the agent.

Returns:



490
491
492
 
# File 'bedrock/cfn_agent.rb', line 490

def knowledge_bases()
  jsii_get_property("knowledgeBases")
end

#knowledge_bases=(value) ⇒ Object 



494
495
496
497
 
# File 'bedrock/cfn_agent.rb', line 494

def knowledge_bases=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9jay5DZm5BZ2VudC5BZ2VudEtub3dsZWRnZUJhc2VQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "knowledgeBases") unless value.nil?
  jsii_set_property("knowledgeBases", 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) 


167
168
169
 
# File 'bedrock/cfn_agent.rb', line 167

def logical_id()
  jsii_get_property("logicalId")
end

#memory_configuration ⇒ AWSCDK::IResolvable, ...

Contains memory configuration for the agent.

Returns:



502
503
504
 
# File 'bedrock/cfn_agent.rb', line 502

def memory_configuration()
  jsii_get_property("memoryConfiguration")
end

#memory_configuration=(value) ⇒ Object 



506
507
508
509
510
 
# File 'bedrock/cfn_agent.rb', line 506

def memory_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnAgent::MemoryConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkFnZW50Lk1lbW9yeUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "memoryConfiguration") unless value.nil?
  jsii_set_property("memoryConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


150
151
152
 
# File 'bedrock/cfn_agent.rb', line 150

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:



804
805
806
 
# File 'bedrock/cfn_agent.rb', line 804

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:



811
812
813
 
# File 'bedrock/cfn_agent.rb', line 811

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

#orchestration_type ⇒ String?

Specifies the orchestration strategy for the agent.

Returns:

  • (String, nil) 


515
516
517
 
# File 'bedrock/cfn_agent.rb', line 515

def orchestration_type()
  jsii_get_property("orchestrationType")
end

#orchestration_type=(value) ⇒ Object 



519
520
521
522
 
# File 'bedrock/cfn_agent.rb', line 519

def orchestration_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "orchestrationType") unless value.nil?
  jsii_set_property("orchestrationType", value)
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.



604
605
606
607
 
# File 'bedrock/cfn_agent.rb', line 604

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

#prompt_override_configuration ⇒ AWSCDK::IResolvable, ...

Contains configurations to override prompt templates in different parts of an agent sequence.

Returns:



527
528
529
 
# File 'bedrock/cfn_agent.rb', line 527

def prompt_override_configuration()
  jsii_get_property("promptOverrideConfiguration")
end

#prompt_override_configuration=(value) ⇒ Object 



531
532
533
534
535
 
# File 'bedrock/cfn_agent.rb', line 531

def prompt_override_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnAgent::PromptOverrideConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkFnZW50LlByb21wdE92ZXJyaWRlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "promptOverrideConfiguration") unless value.nil?
  jsii_set_property("promptOverrideConfiguration", value)
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) 


186
187
188
 
# File 'bedrock/cfn_agent.rb', line 186

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:



822
823
824
825
 
# File 'bedrock/cfn_agent.rb', line 822

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


829
830
831
832
 
# File 'bedrock/cfn_agent.rb', line 829

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:



839
840
841
842
843
 
# File 'bedrock/cfn_agent.rb', line 839

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

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



848
849
850
 
# File 'bedrock/cfn_agent.rb', line 848

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

#skip_resource_in_use_check_on_delete ⇒ Boolean, ...

Specifies whether to delete the resource even if it's in use.

Returns:



540
541
542
 
# File 'bedrock/cfn_agent.rb', line 540

def skip_resource_in_use_check_on_delete()
  jsii_get_property("skipResourceInUseCheckOnDelete")
end

#skip_resource_in_use_check_on_delete=(value) ⇒ Object 



544
545
546
547
 
# File 'bedrock/cfn_agent.rb', line 544

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



176
177
178
 
# File 'bedrock/cfn_agent.rb', line 176

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

Returns:

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


554
555
556
 
# File 'bedrock/cfn_agent.rb', line 554

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



558
559
560
561
 
# File 'bedrock/cfn_agent.rb', line 558

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

#test_alias_tags ⇒ AWSCDK::IResolvable, ...

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

Returns:



568
569
570
 
# File 'bedrock/cfn_agent.rb', line 568

def test_alias_tags()
  jsii_get_property("testAliasTags")
end

#test_alias_tags=(value) ⇒ Object 



572
573
574
575
 
# File 'bedrock/cfn_agent.rb', line 572

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



580
581
582
 
# File 'bedrock/cfn_agent.rb', line 580

def to_string()
  jsii_call_method("toString", [])
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}) 


223
224
225
 
# File 'bedrock/cfn_agent.rb', line 223

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


233
234
235
 
# File 'bedrock/cfn_agent.rb', line 233

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


854
855
856
857
 
# File 'bedrock/cfn_agent.rb', line 854

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) 


593
594
595
596
597
598
 
# File 'bedrock/cfn_agent.rb', line 593

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