Class: AWSCDK::Bedrock::CfnAgent::ParameterDetailProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnAgent::ParameterDetailProperty

Defined in:

bedrock/cfn_agent.rb

Overview

Contains details about a parameter in a function for an action group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html

Instance Attribute Summary

• #description ⇒ String^? readonly

  A description of the parameter.

• #required ⇒ Boolean, ... readonly

  Whether the parameter is required for the agent to complete the function for action group invocation.

• #type ⇒ String readonly

  The data type of the parameter.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, description: nil, required: nil) ⇒ ParameterDetailProperty constructor

  A new instance of ParameterDetailProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, description: nil, required: nil) ⇒ ParameterDetailProperty

Returns a new instance of ParameterDetailProperty.

Parameters:

• type (String) —

  The data type of the parameter.

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

  A description of the parameter.

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

  Whether the parameter is required for the agent to complete the function for action group invocation.

# File 'bedrock/cfn_agent.rb', line 1581

def initialize(type:, description: nil, required: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "required") unless @required.nil?
end

Instance Attribute Details

#description ⇒ String^? (readonly)

A description of the parameter.

Helps the foundation model determine how to elicit the parameters from the user.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-description

# File 'bedrock/cfn_agent.rb', line 1601

def description
  @description
end

#required ⇒ Boolean, ... (readonly)

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-required

# File 'bedrock/cfn_agent.rb', line 1606

def required
  @required
end

#type ⇒ String (readonly)

The data type of the parameter.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-type

# File 'bedrock/cfn_agent.rb', line 1594

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_agent.rb', line 1608

def self.jsii_properties
  {
    :type => "type",
    :description => "description",
    :required => "required",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_agent.rb', line 1616

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "description" => @description,
    "required" => @required,
  })
  result.compact
end