Package software.amazon.awscdk.services.qbusiness

Class CfnPlugin

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qbusiness.CfnPlugin
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IPluginRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:46.593Z") @Stability(Stable) public class CfnPlugin extends CfnResource implements IInspectable, IPluginRef, ITaggableV2
Information about an Amazon Q Business plugin and its configuration.

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;
 CfnPlugin cfnPlugin = CfnPlugin.Builder.create(this, "MyCfnPlugin")
         .authConfiguration(PluginAuthConfigurationProperty.builder()
                 .basicAuthConfiguration(BasicAuthConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         .build())
                 .noAuthConfiguration(noAuthConfiguration)
                 .oAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         // the properties below are optional
                         .authorizationUrl("authorizationUrl")
                         .tokenUrl("tokenUrl")
                         .build())
                 .build())
         .displayName("displayName")
         .type("type")
         // the properties below are optional
         .applicationId("applicationId")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPlugin

      protected CfnPlugin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPlugin

      protected CfnPlugin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPlugin

      @Stability(Stable) public CfnPlugin(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPluginProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrBuildStatus

      @Stability(Stable) @NotNull public String getAttrBuildStatus()
      The current status of a plugin.

      A plugin is modified asynchronously.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp for when the plugin was created.

    • getAttrPluginArn

      @Stability(Stable) @NotNull public String getAttrPluginArn()
      The Amazon Resource Name (ARN) of a plugin.

    • getAttrPluginId

      @Stability(Stable) @NotNull public String getAttrPluginId()
      The identifier of the plugin.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp for when the plugin was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPluginRef

      @Stability(Stable) @NotNull public PluginReference getPluginRef()
      A reference to a Plugin resource.
      Specified by:
      getPluginRef in interface IPluginRef

    • getAuthConfiguration

      @Stability(Stable) @NotNull public Object getAuthConfiguration()
      Authentication configuration information for an Amazon Q Business plugin.

      Returns union: either IResolvable or CfnPlugin.PluginAuthConfigurationProperty

    • setAuthConfiguration

      @Stability(Stable) public void setAuthConfiguration(@NotNull IResolvable value)
      Authentication configuration information for an Amazon Q Business plugin.

    • setAuthConfiguration

      @Stability(Stable) public void setAuthConfiguration(@NotNull CfnPlugin.PluginAuthConfigurationProperty value)
      Authentication configuration information for an Amazon Q Business plugin.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the plugin.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the plugin.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the plugin.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the plugin.

    • getApplicationId

      @Stability(Stable) @Nullable public String getApplicationId()
      The identifier of the application that will contain the plugin.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@Nullable String value)
      The identifier of the application that will contain the plugin.

    • getCustomPluginConfiguration

      @Stability(Stable) @Nullable public Object getCustomPluginConfiguration()
      Configuration information required to create a custom plugin.

      Returns union: either IResolvable or CfnPlugin.CustomPluginConfigurationProperty

    • setCustomPluginConfiguration

      @Stability(Stable) public void setCustomPluginConfiguration(@Nullable IResolvable value)
      Configuration information required to create a custom plugin.

    • setCustomPluginConfiguration

      @Stability(Stable) public void setCustomPluginConfiguration(@Nullable CfnPlugin.CustomPluginConfigurationProperty value)
      Configuration information required to create a custom plugin.

    • getServerUrl

      @Stability(Stable) @Nullable public String getServerUrl()
      The plugin server URL used for configuration.

    • setServerUrl

      @Stability(Stable) public void setServerUrl(@Nullable String value)
      The plugin server URL used for configuration.

    • getState

      @Stability(Stable) @Nullable public String getState()
      The current status of the plugin.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The current status of the plugin.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize the data source connector.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize the data source connector.