Package software.amazon.awscdk.services.qbusiness

Interface CfnPlugin.CustomPluginConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlugin.CustomPluginConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPlugin

@Stability(Stable)
public static interface CfnPlugin.CustomPluginConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration information required to create a custom plugin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 CustomPluginConfigurationProperty customPluginConfigurationProperty = CustomPluginConfigurationProperty.builder()
         .apiSchema(APISchemaProperty.builder()
                 .payload("payload")
                 .s3(S3Property.builder()
                         .bucket("bucket")
                         .key("key")
                         .build())
                 .build())
         .apiSchemaType("apiSchemaType")
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlugin.CustomPluginConfigurationProperty.Builder	A builder for CfnPlugin.CustomPluginConfigurationProperty
static final class	CfnPlugin.CustomPluginConfigurationProperty.Jsii$Proxy	An implementation for CfnPlugin.CustomPluginConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlugin.CustomPluginConfigurationProperty.Builder	builder()
Object	getApiSchema()	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.
String	getApiSchemaType()	The type of OpenAPI schema to use.
String	getDescription()	A description for your custom plugin configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiSchema

@Stability(Stable)
@NotNull
Object getApiSchema()

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 union: either IResolvable or CfnPlugin.APISchemaProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischema

getApiSchemaType

@Stability(Stable)
@NotNull
String getApiSchemaType()

The type of OpenAPI schema to use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischematype

getDescription

@Stability(Stable)
@NotNull
String getDescription()

A description for your custom plugin configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-description

builder

@Stability(Stable)
static CfnPlugin.CustomPluginConfigurationProperty.Builder builder()

Returns:

a CfnPlugin.CustomPluginConfigurationProperty.Builder of CfnPlugin.CustomPluginConfigurationProperty