Class CfnPlugin

Information about an Amazon Q Business plugin and its configuration.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnPlugin
Inherited Members
Namespace: Amazon.CDK.AwsQbusiness
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPlugin : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnPlugin
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html

CloudformationResource: AWS::QBusiness::Plugin

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_qbusiness;

var noAuthConfiguration;

var cfnPlugin = new CfnPlugin(this, "MyCfnPlugin", new CfnPluginProps {
    AuthConfiguration = new PluginAuthConfigurationProperty {
        BasicAuthConfiguration = new BasicAuthConfigurationProperty {
            RoleArn = "roleArn",
            SecretArn = "secretArn"
        },
        NoAuthConfiguration = noAuthConfiguration,
        OAuth2ClientCredentialConfiguration = new OAuth2ClientCredentialConfigurationProperty {
            RoleArn = "roleArn",
            SecretArn = "secretArn",

            // the properties below are optional
            AuthorizationUrl = "authorizationUrl",
            TokenUrl = "tokenUrl"
        }
    },
    DisplayName = "displayName",
    Type = "type",

    // the properties below are optional
    ApplicationId = "applicationId",
    CustomPluginConfiguration = new CustomPluginConfigurationProperty {
        ApiSchema = new APISchemaProperty {
            Payload = "payload",
            S3 = new S3Property {
                Bucket = "bucket",
                Key = "key"
            }
        },
        ApiSchemaType = "apiSchemaType",
        Description = "description"
    },
    ServerUrl = "serverUrl",
    State = "state",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnPlugin(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnPlugin(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnPlugin(Construct, String, ICfnPluginProps)

Properties

ApplicationId

The identifier of the application that will contain the plugin.
AttrBuildStatus

The current status of a plugin.
AttrCreatedAt

The timestamp for when the plugin was created.
AttrPluginArn

The Amazon Resource Name (ARN) of a plugin.
AttrPluginId

The identifier of the plugin.
AttrUpdatedAt

The timestamp for when the plugin was last updated.
AuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
CustomPluginConfiguration

Configuration information required to create a custom plugin.
DisplayName

The name of the plugin.
ServerUrl

The plugin server URL used for configuration.
State

The current status of the plugin.
Tags

A list of key-value pairs that identify or categorize the data source connector.
Type

The type of the plugin.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnPlugin(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnPlugin(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnPlugin(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnPlugin(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnPlugin(Construct, String, ICfnPluginProps)

public CfnPlugin(Construct scope, string id, ICfnPluginProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnPluginProps

Resource properties.

Properties

ApplicationId

The identifier of the application that will contain the plugin.

public virtual string ApplicationId { get; set; }
Property Value

System.String

AttrBuildStatus

The current status of a plugin.

public virtual string AttrBuildStatus { get; }
Property Value

System.String

Remarks

A plugin is modified asynchronously.

CloudformationAttribute: BuildStatus

AttrCreatedAt

The timestamp for when the plugin was created.

public virtual string AttrCreatedAt { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreatedAt

AttrPluginArn

The Amazon Resource Name (ARN) of a plugin.

public virtual string AttrPluginArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: PluginArn

AttrPluginId

The identifier of the plugin.

public virtual string AttrPluginId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: PluginId

AttrUpdatedAt

The timestamp for when the plugin was last updated.

public virtual string AttrUpdatedAt { get; }
Property Value

System.String

Remarks

CloudformationAttribute: UpdatedAt

AuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

public virtual object AuthConfiguration { get; set; }
Property Value

System.Object

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CustomPluginConfiguration

Configuration information required to create a custom plugin.

public virtual object CustomPluginConfiguration { get; set; }
Property Value

System.Object

DisplayName

The name of the plugin.

public virtual string DisplayName { get; set; }
Property Value

System.String

ServerUrl

The plugin server URL used for configuration.

public virtual string ServerUrl { get; set; }
Property Value

System.String

State

The current status of the plugin.

public virtual string State { get; set; }
Property Value

System.String

Tags

A list of key-value pairs that identify or categorize the data source connector.

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Type

The type of the plugin.

public virtual string Type { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements