# PluginAuthConfigurationProperty

Authentication configuration information for an Amazon Q Business plugin.

- Source: Generated at build time
- Type last changed: v2.140.0 · 2 May 2024

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';

declare const noAuthConfiguration: any;
const pluginAuthConfigurationProperty: qbusiness.CfnPlugin.PluginAuthConfigurationProperty = {
  basicAuthConfiguration: {
    roleArn: 'roleArn',
    secretArn: 'secretArn',
  },
  noAuthConfiguration: noAuthConfiguration,
  oAuth2ClientCredentialConfiguration: {
    roleArn: 'roleArn',
    secretArn: 'secretArn',

    // the properties below are optional
    authorizationUrl: 'authorizationUrl',
    tokenUrl: 'tokenUrl',
  },
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# no_auth_configuration: Any

plugin_auth_configuration_property = qbusiness.CfnPlugin.PluginAuthConfigurationProperty(
    basic_auth_configuration=qbusiness.CfnPlugin.BasicAuthConfigurationProperty(
        role_arn="roleArn",
        secret_arn="secretArn"
    ),
    no_auth_configuration=no_auth_configuration,
    o_auth2_client_credential_configuration=qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty(
        role_arn="roleArn",
        secret_arn="secretArn",

        # the properties below are optional
        authorization_url="authorizationUrl",
        token_url="tokenUrl"
    )
)
```

Java:

```java
// 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;

PluginAuthConfigurationProperty pluginAuthConfigurationProperty = 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 pluginAuthConfigurationProperty = 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"
    }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var noAuthConfiguration interface{}

pluginAuthConfigurationProperty := &PluginAuthConfigurationProperty{
	BasicAuthConfiguration: &BasicAuthConfigurationProperty{
		RoleArn: jsii.String("roleArn"),
		SecretArn: jsii.String("secretArn"),
	},
	NoAuthConfiguration: noAuthConfiguration,
	OAuth2ClientCredentialConfiguration: &OAuth2ClientCredentialConfigurationProperty{
		RoleArn: jsii.String("roleArn"),
		SecretArn: jsii.String("secretArn"),

		// the properties below are optional
		AuthorizationUrl: jsii.String("authorizationUrl"),
		TokenUrl: jsii.String("tokenUrl"),
	},
}
```

## Properties

- `basicAuthConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPlugin.BasicAuthConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_qbusiness.CfnPlugin.BasicAuthConfigurationProperty.html) — Information about the basic authentication credentials used to configure a plugin.

- `noAuthConfiguration`: any — Information about invoking a custom plugin without any authentication.

- `oAuth2ClientCredentialConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPlugin.OAuth2ClientCredentialConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty.html) — Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
