CfnApplication
- class aws_cdk.aws_qbusiness.CfnApplication(scope, id, *, display_name, attachments_configuration=None, auto_subscription_configuration=None, client_ids_for_oidc=None, description=None, encryption_configuration=None, iam_identity_provider_arn=None, identity_center_instance_arn=None, identity_type=None, personalization_configuration=None, q_apps_configuration=None, role_arn=None, tags=None)
Bases:
CfnResource
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.
- See:
- CloudformationResource:
AWS::QBusiness::Application
- ExampleMetadata:
fixture=_generated
Example:
# 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 cfn_application = qbusiness.CfnApplication(self, "MyCfnApplication", display_name="displayName", # the properties below are optional attachments_configuration=qbusiness.CfnApplication.AttachmentsConfigurationProperty( attachments_control_mode="attachmentsControlMode" ), auto_subscription_configuration=qbusiness.CfnApplication.AutoSubscriptionConfigurationProperty( auto_subscribe="autoSubscribe", # the properties below are optional default_subscription_type="defaultSubscriptionType" ), client_ids_for_oidc=["clientIdsForOidc"], description="description", encryption_configuration=qbusiness.CfnApplication.EncryptionConfigurationProperty( kms_key_id="kmsKeyId" ), iam_identity_provider_arn="iamIdentityProviderArn", identity_center_instance_arn="identityCenterInstanceArn", identity_type="identityType", personalization_configuration=qbusiness.CfnApplication.PersonalizationConfigurationProperty( personalization_control_mode="personalizationControlMode" ), q_apps_configuration=qbusiness.CfnApplication.QAppsConfigurationProperty( q_apps_control_mode="qAppsControlMode" ), role_arn="roleArn", tags=[CfnTag( key="key", value="value" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).display_name (
str
) – The name of the Amazon Q Business application.attachments_configuration (
Union
[IResolvable
,AttachmentsConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration information for the file upload during chat feature.auto_subscription_configuration (
Union
[IResolvable
,AutoSubscriptionConfigurationProperty
,Dict
[str
,Any
],None
]) – Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.client_ids_for_oidc (
Optional
[Sequence
[str
]]) –description (
Optional
[str
]) – A description for the Amazon Q Business application.encryption_configuration (
Union
[IResolvable
,EncryptionConfigurationProperty
,Dict
[str
,Any
],None
]) – 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.iam_identity_provider_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.identity_center_instance_arn (
Optional
[str
]) – 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
identity_type (
Optional
[str
]) – The authentication type being used by a Amazon Q Business application.personalization_configuration (
Union
[IResolvable
,PersonalizationConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration information about chat response personalization. For more information, see Personalizing chat responses .q_apps_configuration (
Union
[IResolvable
,QAppsConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration information about Amazon Q Apps.role_arn (
Optional
[str
]) – 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.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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: _ . : / = + -
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::QBusiness::Application'
- attachments_configuration
Configuration information for the file upload during chat feature.
- attr_application_arn
The Amazon Resource Name (ARN) of the Amazon Q Business application.
- CloudformationAttribute:
ApplicationArn
- attr_application_id
The identifier for the Amazon Q Business application.
- CloudformationAttribute:
ApplicationId
- attr_created_at
The Unix timestamp when the Amazon Q Business application was created.
- CloudformationAttribute:
CreatedAt
- attr_identity_center_application_arn
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
- CloudformationAttribute:
IdentityCenterApplicationArn
- attr_status
The status of the Amazon Q Business application.
The application is ready to use when the status is
ACTIVE
.- CloudformationAttribute:
Status
- attr_updated_at
The Unix timestamp when the Amazon Q Business application was last updated.
- CloudformationAttribute:
UpdatedAt
- auto_subscription_configuration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- client_ids_for_oidc
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
A description for the Amazon Q Business application.
- display_name
The name of the Amazon Q Business application.
- encryption_configuration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
- iam_identity_provider_arn
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
- identity_center_instance_arn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
- identity_type
The authentication type being used by a Amazon Q Business application.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- personalization_configuration
Configuration information about chat response personalization.
- q_apps_configuration
Configuration information about Amazon Q Apps.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- role_arn
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
A list of key-value pairs that identify or categorize your Amazon Q Business application.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
AttachmentsConfigurationProperty
- class CfnApplication.AttachmentsConfigurationProperty(*, attachments_control_mode)
Bases:
object
Configuration information for the file upload during chat feature.
- Parameters:
attachments_control_mode (
str
) – Status information about whether file upload functionality is activated or deactivated for your end user.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 attachments_configuration_property = qbusiness.CfnApplication.AttachmentsConfigurationProperty( attachments_control_mode="attachmentsControlMode" )
Attributes
- attachments_control_mode
Status information about whether file upload functionality is activated or deactivated for your end user.
AutoSubscriptionConfigurationProperty
- class CfnApplication.AutoSubscriptionConfigurationProperty(*, auto_subscribe, default_subscription_type=None)
Bases:
object
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
- Parameters:
auto_subscribe (
str
) – Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.default_subscription_type (
Optional
[str
]) – Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value forautoSubscribe
is set toENABLED
you must select a value for this field.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 auto_subscription_configuration_property = qbusiness.CfnApplication.AutoSubscriptionConfigurationProperty( auto_subscribe="autoSubscribe", # the properties below are optional default_subscription_type="defaultSubscriptionType" )
Attributes
- auto_subscribe
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
- default_subscription_type
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
If the value for
autoSubscribe
is set toENABLED
you must select a value for this field.
EncryptionConfigurationProperty
- class CfnApplication.EncryptionConfigurationProperty(*, kms_key_id=None)
Bases:
object
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.
- Parameters:
kms_key_id (
Optional
[str
]) – The identifier of the AWS KMS key. Amazon Q Business doesn’t support asymmetric keys.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 encryption_configuration_property = qbusiness.CfnApplication.EncryptionConfigurationProperty( kms_key_id="kmsKeyId" )
Attributes
- kms_key_id
The identifier of the AWS KMS key.
Amazon Q Business doesn’t support asymmetric keys.
PersonalizationConfigurationProperty
- class CfnApplication.PersonalizationConfigurationProperty(*, personalization_control_mode)
Bases:
object
Configuration information about chat response personalization.
For more information, see Personalizing chat responses .
- Parameters:
personalization_control_mode (
str
) – An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 personalization_configuration_property = qbusiness.CfnApplication.PersonalizationConfigurationProperty( personalization_control_mode="personalizationControlMode" )
Attributes
- personalization_control_mode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
QAppsConfigurationProperty
- class CfnApplication.QAppsConfigurationProperty(*, q_apps_control_mode)
Bases:
object
Configuration information about Amazon Q Apps.
- Parameters:
q_apps_control_mode (
str
) – Status information about whether end users can create and use Amazon Q Apps in the web experience.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 q_apps_configuration_property = qbusiness.CfnApplication.QAppsConfigurationProperty( q_apps_control_mode="qAppsControlMode" )
Attributes
- q_apps_control_mode
Status information about whether end users can create and use Amazon Q Apps in the web experience.