PluginAuthConfigurationProperty Struct
Authentication configuration information for an Amazon Q Business plugin.
| Source | |
|---|---|
| Type last changed |
Example
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
# 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
// 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();
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"
}
};
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
basicAuthConfigurationoptionalIResolvable | CfnPlugin.basic_auth_configurationoptionaltyping.Union[IResolvable, BasicAuthConfigurationProperty]basicAuthConfigurationoptionalIResolvableBasicAuthConfigurationoptionalIResolvableBasicAuthConfigurationoptionalinterface{} #Information about the basic authentication credentials used to configure a plugin.
noAuthConfigurationoptionalanyno_auth_configurationoptionalAnynoAuthConfigurationoptionalObjectNoAuthConfigurationoptionalobjectNoAuthConfigurationoptionalinterface{} #Information about invoking a custom plugin without any authentication.
oAuth2ClientCredentialConfigurationoptionalIResolvable | CfnPlugin.o_auth2_client_credential_configurationoptionaltyping.Union[IResolvable, OAuth2ClientCredentialConfigurationProperty]oAuth2ClientCredentialConfigurationoptionalIResolvableOAuth2ClientCredentialConfigurationoptionalIResolvableOAuth2ClientCredentialConfigurationoptionalinterface{} #Information about the OAuth 2.0 authentication credential/token used to configure a plugin.