Interface CfnPluginProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPluginProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:19.319Z")
@Stability(Stable)
public interface CfnPluginProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnPlugin
.
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.*; Object noAuthConfiguration; CfnPluginProps cfnPluginProps = CfnPluginProps.builder() .applicationId("applicationId") .authConfiguration(PluginAuthConfigurationProperty.builder() .basicAuthConfiguration(BasicAuthConfigurationProperty.builder() .roleArn("roleArn") .secretArn("secretArn") .build()) .noAuthConfiguration(noAuthConfiguration) .oAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfigurationProperty.builder() .roleArn("roleArn") .secretArn("secretArn") .build()) .build()) .displayName("displayName") .type("type") // the properties below are optional .customPluginConfiguration(CustomPluginConfigurationProperty.builder() .apiSchema(APISchemaProperty.builder() .payload("payload") .s3(S3Property.builder() .bucket("bucket") .key("key") .build()) .build()) .apiSchemaType("apiSchemaType") .description("description") .build()) .serverUrl("serverUrl") .state("state") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPluginProps
static final class
An implementation forCfnPluginProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPluginProps.Builder
builder()
The identifier of the application that will contain the plugin.Authentication configuration information for an Amazon Q Business plugin.default Object
Configuration information required to create a custom plugin.The name of the plugin.default String
The plugin server URL used for configuration.default String
getState()
The current status of the plugin.getTags()
A list of key-value pairs that identify or categorize the data source connector.getType()
The type of the plugin.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The identifier of the application that will contain the plugin.- See Also:
-
getAuthConfiguration
Authentication configuration information for an Amazon Q Business plugin.- See Also:
-
getDisplayName
The name of the plugin.- See Also:
-
getType
The type of the plugin.- See Also:
-
getCustomPluginConfiguration
Configuration information required to create a custom plugin.- See Also:
-
getServerUrl
The plugin server URL used for configuration.- See Also:
-
getState
The current status of the plugin.- See Also:
-
getTags
A list of key-value pairs that identify or categorize the data source connector.You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
- See Also:
-
builder
- Returns:
- a
CfnPluginProps.Builder
ofCfnPluginProps
-