Class CfnApplication
Creates an Amazon Q Business application.
Inherited Members
Namespace: Amazon.CDK.AwsQbusiness
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnApplication
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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.
CloudformationResource: AWS::QBusiness::Application
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 cfnApplication = new CfnApplication(this, "MyCfnApplication", new CfnApplicationProps {
DisplayName = "displayName",
// the properties below are optional
AttachmentsConfiguration = new AttachmentsConfigurationProperty {
AttachmentsControlMode = "attachmentsControlMode"
},
Description = "description",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsKeyId = "kmsKeyId"
},
IdentityCenterInstanceArn = "identityCenterInstanceArn",
RoleArn = "roleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnApplication(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplication(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnApplication(Construct, String, ICfnApplicationProps) |
Properties
AttachmentsConfiguration | Configuration information for the file upload during chat feature. |
AttrApplicationArn | The Amazon Resource Name (ARN) of the Amazon Q Business application. |
AttrApplicationId | The identifier for the Amazon Q Business application. |
AttrCreatedAt | The Unix timestamp when the Amazon Q Business application was created. |
AttrIdentityCenterApplicationArn | The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application. |
AttrStatus | The status of the Amazon Q Business application. |
AttrUpdatedAt | The Unix timestamp when the Amazon Q Business application was last updated. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the Amazon Q Business application. |
DisplayName | The name of the Amazon Q Business application. |
EncryptionConfiguration | Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. |
IdentityCenterInstanceArn | The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. |
RoleArn | The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. |
Tags | A list of key-value pairs that identify or categorize your Amazon Q Business application. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplication(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplication(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplication(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplication(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnApplication(Construct, String, ICfnApplicationProps)
public CfnApplication(Construct scope, string id, ICfnApplicationProps 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 ICfnApplicationProps
Resource properties.
Properties
AttachmentsConfiguration
Configuration information for the file upload during chat feature.
public virtual object AttachmentsConfiguration { get; set; }
Property Value
System.Object
AttrApplicationArn
The Amazon Resource Name (ARN) of the Amazon Q Business application.
public virtual string AttrApplicationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationArn
AttrApplicationId
The identifier for the Amazon Q Business application.
public virtual string AttrApplicationId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationId
AttrCreatedAt
The Unix timestamp when the Amazon Q Business application was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrIdentityCenterApplicationArn
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
public virtual string AttrIdentityCenterApplicationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IdentityCenterApplicationArn
AttrStatus
The status of the Amazon Q Business application.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
The application is ready to use when the status is ACTIVE
.
CloudformationAttribute: Status
AttrUpdatedAt
The Unix timestamp when the Amazon Q Business application was last updated.
public virtual string AttrUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdatedAt
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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
Description
A description for the Amazon Q Business application.
public virtual string Description { get; set; }
Property Value
System.String
DisplayName
The name of the Amazon Q Business application.
public virtual string DisplayName { get; set; }
Property Value
System.String
EncryptionConfiguration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
public virtual object EncryptionConfiguration { get; set; }
Property Value
System.Object
IdentityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
public virtual string IdentityCenterInstanceArn { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
public virtual string RoleArn { get; set; }
Property Value
System.String
Tags
A list of key-value pairs that identify or categorize your Amazon Q Business application.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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>