Interface CfnApplicationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApplicationProps.Jsii$Proxy
CfnApplication.
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.*;
CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
.displayName("displayName")
// the properties below are optional
.attachmentsConfiguration(AttachmentsConfigurationProperty.builder()
.attachmentsControlMode("attachmentsControlMode")
.build())
.autoSubscriptionConfiguration(AutoSubscriptionConfigurationProperty.builder()
.autoSubscribe("autoSubscribe")
// the properties below are optional
.defaultSubscriptionType("defaultSubscriptionType")
.build())
.clientIdsForOidc(List.of("clientIdsForOidc"))
.description("description")
.encryptionConfiguration(EncryptionConfigurationProperty.builder()
.kmsKeyId("kmsKeyId")
.build())
.iamIdentityProviderArn("iamIdentityProviderArn")
.identityCenterInstanceArn("identityCenterInstanceArn")
.identityType("identityType")
.personalizationConfiguration(PersonalizationConfigurationProperty.builder()
.personalizationControlMode("personalizationControlMode")
.build())
.qAppsConfiguration(QAppsConfigurationProperty.builder()
.qAppsControlMode("qAppsControlMode")
.build())
.quickSightConfiguration(QuickSightConfigurationProperty.builder()
.clientNamespace("clientNamespace")
.build())
.roleArn("roleArn")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnApplicationPropsstatic final classAn implementation forCfnApplicationProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnApplicationProps.Builderbuilder()default ObjectConfiguration information for the file upload during chat feature.default ObjectSubscription configuration information for an Amazon Q Business application using IAM identity federation for user management.The OIDC client ID for a Amazon Q Business application.default StringA description for the Amazon Q Business application.The name of the Amazon Q Business application.default ObjectProvides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.default StringThe Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.default StringThe Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.default StringThe authentication type being used by a Amazon Q Business application.default ObjectConfiguration information about chat response personalization.default ObjectConfiguration information about Amazon Q Apps.default ObjectThe Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.default StringThe Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.getTags()A list of key-value pairs that identify or categorize your Amazon Q Business application.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDisplayName
The name of the Amazon Q Business application.- See Also:
-
getAttachmentsConfiguration
Configuration information for the file upload during chat feature.Returns union: either
IResolvableorCfnApplication.AttachmentsConfigurationProperty- See Also:
-
getAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.Returns union: either
IResolvableorCfnApplication.AutoSubscriptionConfigurationProperty- See Also:
-
getClientIdsForOidc
The OIDC client ID for a Amazon Q Business application.- See Also:
-
getDescription
A description for the Amazon Q Business application.- See Also:
-
getEncryptionConfiguration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.Amazon Q Business doesn't support asymmetric keys.
Returns union: either
IResolvableorCfnApplication.EncryptionConfigurationProperty- See Also:
-
getIamIdentityProviderArn
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.- See Also:
-
getIdentityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.Required :
Yes- See Also:
-
getIdentityType
The authentication type being used by a Amazon Q Business application.- See Also:
-
getPersonalizationConfiguration
Configuration information about chat response personalization.For more information, see Personalizing chat responses .
Returns union: either
IResolvableorCfnApplication.PersonalizationConfigurationProperty- See Also:
-
getQAppsConfiguration
Configuration information about Amazon Q Apps.Returns union: either
IResolvableorCfnApplication.QAppsConfigurationProperty- See Also:
-
getQuickSightConfiguration
The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.Returns union: either
IResolvableorCfnApplication.QuickSightConfigurationProperty- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
- See Also:
-
getTags
A list of key-value pairs that identify or categorize your Amazon Q Business application.You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
- See Also:
-
builder
- Returns:
- a
CfnApplicationProps.BuilderofCfnApplicationProps
-