Package software.amazon.awscdk.services.qbusiness

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.104.0 (build e79254c)", date="2024-11-06T23:25:13.659Z") @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.

A Amazon Q Apps service linked role will be created if it's absent in the AWS account when the QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps

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())
         .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())
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrApplicationArn

      @Stability(Stable) @NotNull public String getAttrApplicationArn()
      The Amazon Resource Name (ARN) of the Amazon Q Business application.

    • getAttrApplicationId

      @Stability(Stable) @NotNull public String getAttrApplicationId()
      The identifier for the Amazon Q Business application.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The Unix timestamp when the Amazon Q Business application was created.

    • getAttrIdentityCenterApplicationArn

      @Stability(Stable) @NotNull public String getAttrIdentityCenterApplicationArn()
      The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the Amazon Q Business application.

      The application is ready to use when the status is ACTIVE .

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The Unix timestamp when the Amazon Q Business application was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the Amazon Q Business application.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the Amazon Q Business application.

    • getAttachmentsConfiguration

      @Stability(Stable) @Nullable public Object getAttachmentsConfiguration()
      Configuration information for the file upload during chat feature.

    • setAttachmentsConfiguration

      @Stability(Stable) public void setAttachmentsConfiguration(@Nullable IResolvable value)
      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.

    • getAutoSubscriptionConfiguration

      @Stability(Stable) @Nullable public Object getAutoSubscriptionConfiguration()
      Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

    • setAutoSubscriptionConfiguration

      @Stability(Stable) public void setAutoSubscriptionConfiguration(@Nullable IResolvable value)
      Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

    • setAutoSubscriptionConfiguration

      @Stability(Stable) public void setAutoSubscriptionConfiguration(@Nullable CfnApplication.AutoSubscriptionConfigurationProperty value)
      Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

    • getClientIdsForOidc

      @Stability(Stable) @Nullable public List<String> getClientIdsForOidc()

    • setClientIdsForOidc

      @Stability(Stable) public void setClientIdsForOidc(@Nullable List<String> value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the Amazon Q Business application.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the Amazon Q Business application.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      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.

    • getIamIdentityProviderArn

      @Stability(Stable) @Nullable public String getIamIdentityProviderArn()
      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

    • setIamIdentityProviderArn

      @Stability(Stable) public void setIamIdentityProviderArn(@Nullable String value)
      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

    • getIdentityCenterInstanceArn

      @Stability(Stable) @Nullable public String 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

      @Stability(Stable) public void setIdentityCenterInstanceArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

    • getIdentityType

      @Stability(Stable) @Nullable public String getIdentityType()
      The authentication type being used by a Amazon Q Business application.

    • setIdentityType

      @Stability(Stable) public void setIdentityType(@Nullable String value)
      The authentication type being used by a Amazon Q Business application.

    • getPersonalizationConfiguration

      @Stability(Stable) @Nullable public Object getPersonalizationConfiguration()
      Configuration information about chat response personalization.

    • setPersonalizationConfiguration

      @Stability(Stable) public void setPersonalizationConfiguration(@Nullable IResolvable value)
      Configuration information about chat response personalization.

    • setPersonalizationConfiguration

      @Stability(Stable) public void setPersonalizationConfiguration(@Nullable CfnApplication.PersonalizationConfigurationProperty value)
      Configuration information about chat response personalization.

    • getQAppsConfiguration

      @Stability(Stable) @Nullable public Object getQAppsConfiguration()
      Configuration information about Amazon Q Apps.

    • setQAppsConfiguration

      @Stability(Stable) public void setQAppsConfiguration(@Nullable IResolvable value)
      Configuration information about Amazon Q Apps.

    • setQAppsConfiguration

      @Stability(Stable) public void setQAppsConfiguration(@Nullable CfnApplication.QAppsConfigurationProperty value)
      Configuration information about Amazon Q Apps.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize your Amazon Q Business application.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize your Amazon Q Business application.