Class: AWSCDK::QBusiness::CfnPlugin::CustomPluginConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_plugin.rb

Overview

Configuration information required to create a custom plugin.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_schema:, api_schema_type:, description:) ⇒ CustomPluginConfigurationProperty

Returns a new instance of CustomPluginConfigurationProperty.

Parameters:

  • api_schema (AWSCDK::IResolvable, AWSCDK::QBusiness::CfnPlugin::APISchemaProperty) —

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

  • api_schema_type (String) —

    The type of OpenAPI schema to use.

  • description (String) —

    A description for your custom plugin configuration.



736
737
738
739
740
741
742
743
 
# File 'q_business/cfn_plugin.rb', line 736

def initialize(api_schema:, api_schema_type:, description:)
  @api_schema = api_schema.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnPlugin::APISchemaProperty.new(**api_schema.transform_keys(&:to_sym)) : api_schema
  Jsii::Type.check_type(@api_schema, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuUGx1Z2luLkFQSVNjaGVtYVByb3BlcnR5In1dfX0=")), "apiSchema")
  @api_schema_type = api_schema_type
  Jsii::Type.check_type(@api_schema_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiSchemaType")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
end

Instance Attribute Details

#api_schema ⇒ AWSCDK::IResolvable, AWSCDK::QBusiness::CfnPlugin::APISchemaProperty (readonly)

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

See Also:



749
750
751
 
# File 'q_business/cfn_plugin.rb', line 749

def api_schema
  @api_schema
end

#api_schema_type ⇒ String (readonly)

The type of OpenAPI schema to use.

Returns:

  • (String)

See Also:



754
755
756
 
# File 'q_business/cfn_plugin.rb', line 754

def api_schema_type
  @api_schema_type
end

#description ⇒ String (readonly)

A description for your custom plugin configuration.

Returns:

  • (String)

See Also:



759
760
761
 
# File 'q_business/cfn_plugin.rb', line 759

def description
  @description
end

Class Method Details

.jsii_properties ⇒ Object 



761
762
763
764
765
766
767
 
# File 'q_business/cfn_plugin.rb', line 761

def self.jsii_properties
  {
    :api_schema => "apiSchema",
    :api_schema_type => "apiSchemaType",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



769
770
771
772
773
774
775
776
777
 
# File 'q_business/cfn_plugin.rb', line 769

def to_jsii
  result = {}
  result.merge!({
    "apiSchema" => @api_schema,
    "apiSchemaType" => @api_schema_type,
    "description" => @description,
  })
  result.compact
end