Class CfnApplication
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.CfnApplication
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:34:06.484Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, ITaggableV2
Creates an Amazon Q Business application.
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers . You must use the Amazon Q Business console to assign subscription tiers to users.
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.*; CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication") .displayName("displayName") // the properties below are optional .attachmentsConfiguration(AttachmentsConfigurationProperty.builder() .attachmentsControlMode("attachmentsControlMode") .build()) .description("description") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsKeyId("kmsKeyId") .build()) .identityCenterInstanceArn("identityCenterInstanceArn") .roleArn("roleArn") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Configuration information for the file upload during chat feature.static final class
A fluent builder forCfnApplication
.static interface
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnApplication
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnApplication
(software.amazon.jsii.JsiiObjectRef objRef) CfnApplication
(software.constructs.Construct scope, String id, CfnApplicationProps props) -
Method Summary
Modifier and TypeMethodDescriptionConfiguration information for the file upload during chat feature.The Amazon Resource Name (ARN) of the Amazon Q Business application.The identifier for the Amazon Q Business application.The Unix timestamp when the Amazon Q Business application was created.The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.The status of the Amazon Q Business application.The Unix timestamp when the Amazon Q Business application was last updated.Tag Manager which manages the tags for this resource.A description for the Amazon Q Business application.The name of the Amazon Q Business application.Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.The 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.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Configuration information for the file upload during chat feature.void
Configuration information for the file upload during chat feature.void
setDescription
(String value) A description for the Amazon Q Business application.void
setDisplayName
(String value) The name of the Amazon Q Business application.void
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.void
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.void
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.void
A list of key-value pairs that identify or categorize your Amazon Q Business application.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef) -
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnApplication
@Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps 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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrApplicationArn
The Amazon Resource Name (ARN) of the Amazon Q Business application. -
getAttrApplicationId
The identifier for the Amazon Q Business application. -
getAttrCreatedAt
The Unix timestamp when the Amazon Q Business application was created. -
getAttrIdentityCenterApplicationArn
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application. -
getAttrStatus
The status of the Amazon Q Business application.The application is ready to use when the status is
ACTIVE
. -
getAttrUpdatedAt
The Unix timestamp when the Amazon Q Business application was last updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDisplayName
The name of the Amazon Q Business application. -
setDisplayName
The name of the Amazon Q Business application. -
getAttachmentsConfiguration
Configuration information for the file upload during chat feature. -
setAttachmentsConfiguration
Configuration information for the file upload during chat feature. -
setAttachmentsConfiguration
@Stability(Stable) public void setAttachmentsConfiguration(@Nullable CfnApplication.AttachmentsConfigurationProperty value) Configuration information for the file upload during chat feature. -
getDescription
A description for the Amazon Q Business application. -
setDescription
A description for the Amazon Q Business application. -
getEncryptionConfiguration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. -
setEncryptionConfiguration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. -
setEncryptionConfiguration
@Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnApplication.EncryptionConfigurationProperty value) Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. -
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. -
setIdentityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. -
getRoleArn
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. -
setRoleArn
The 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. -
setTags
A list of key-value pairs that identify or categorize your Amazon Q Business application.
-