1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. Application

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws-native.qbusiness.Application

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Definition of AWS::QBusiness::Application Resource Type

    Create Application Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Application(name: string, args: ApplicationArgs, opts?: CustomResourceOptions);
    @overload
    def Application(resource_name: str,
                    args: ApplicationArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Application(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    attachments_configuration: Optional[ApplicationAttachmentsConfigurationArgs] = None,
                    description: Optional[str] = None,
                    encryption_configuration: Optional[ApplicationEncryptionConfigurationArgs] = None,
                    identity_center_instance_arn: Optional[str] = None,
                    role_arn: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewApplication(ctx *Context, name string, args ApplicationArgs, opts ...ResourceOption) (*Application, error)
    public Application(string name, ApplicationArgs args, CustomResourceOptions? opts = null)
    public Application(String name, ApplicationArgs args)
    public Application(String name, ApplicationArgs args, CustomResourceOptions options)
    
    type: aws-native:qbusiness:Application
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Application Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Application resource accepts the following input properties:

    DisplayName string
    The name of the Amazon Q Business application.
    AttachmentsConfiguration Pulumi.AwsNative.QBusiness.Inputs.ApplicationAttachmentsConfiguration
    Configuration information for the file upload during chat feature.
    Description string
    A description for the Amazon Q Business application.
    EncryptionConfiguration Pulumi.AwsNative.QBusiness.Inputs.ApplicationEncryptionConfiguration
    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.
    IdentityCenterInstanceArn string

    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

    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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: _ . : / = + - @.
    DisplayName string
    The name of the Amazon Q Business application.
    AttachmentsConfiguration ApplicationAttachmentsConfigurationArgs
    Configuration information for the file upload during chat feature.
    Description string
    A description for the Amazon Q Business application.
    EncryptionConfiguration ApplicationEncryptionConfigurationArgs
    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.
    IdentityCenterInstanceArn string

    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

    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    Tags TagArgs
    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: _ . : / = + - @.
    displayName String
    The name of the Amazon Q Business application.
    attachmentsConfiguration ApplicationAttachmentsConfiguration
    Configuration information for the file upload during chat feature.
    description String
    A description for the Amazon Q Business application.
    encryptionConfiguration ApplicationEncryptionConfiguration
    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.
    identityCenterInstanceArn String

    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

    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    tags List<Tag>
    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: _ . : / = + - @.
    displayName string
    The name of the Amazon Q Business application.
    attachmentsConfiguration ApplicationAttachmentsConfiguration
    Configuration information for the file upload during chat feature.
    description string
    A description for the Amazon Q Business application.
    encryptionConfiguration ApplicationEncryptionConfiguration
    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.
    identityCenterInstanceArn string

    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

    roleArn string
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    tags Tag[]
    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: _ . : / = + - @.
    display_name str
    The name of the Amazon Q Business application.
    attachments_configuration ApplicationAttachmentsConfigurationArgs
    Configuration information for the file upload during chat feature.
    description str
    A description for the Amazon Q Business application.
    encryption_configuration ApplicationEncryptionConfigurationArgs
    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.
    identity_center_instance_arn 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

    role_arn str
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    tags Sequence[TagArgs]
    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: _ . : / = + - @.
    displayName String
    The name of the Amazon Q Business application.
    attachmentsConfiguration Property Map
    Configuration information for the file upload during chat feature.
    description String
    A description for the Amazon Q Business application.
    encryptionConfiguration Property Map
    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.
    identityCenterInstanceArn String

    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

    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    tags List<Property Map>
    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: _ . : / = + - @.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Application resource produces the following output properties:

    ApplicationArn string
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    ApplicationId string
    The identifier for the Amazon Q Business application.
    CreatedAt string
    The Unix timestamp when the Amazon Q Business application was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    Status Pulumi.AwsNative.QBusiness.ApplicationStatus
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    UpdatedAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    ApplicationArn string
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    ApplicationId string
    The identifier for the Amazon Q Business application.
    CreatedAt string
    The Unix timestamp when the Amazon Q Business application was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    Status ApplicationStatus
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    UpdatedAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    applicationArn String
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    applicationId String
    The identifier for the Amazon Q Business application.
    createdAt String
    The Unix timestamp when the Amazon Q Business application was created.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    status ApplicationStatus
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    updatedAt String
    The Unix timestamp when the Amazon Q Business application was last updated.
    applicationArn string
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    applicationId string
    The identifier for the Amazon Q Business application.
    createdAt string
    The Unix timestamp when the Amazon Q Business application was created.
    id string
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn string
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    status ApplicationStatus
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    updatedAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    application_arn str
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    application_id str
    The identifier for the Amazon Q Business application.
    created_at str
    The Unix timestamp when the Amazon Q Business application was created.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_center_application_arn str
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    status ApplicationStatus
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    updated_at str
    The Unix timestamp when the Amazon Q Business application was last updated.
    applicationArn String
    The Amazon Resource Name (ARN) of the Amazon Q Business application.
    applicationId String
    The identifier for the Amazon Q Business application.
    createdAt String
    The Unix timestamp when the Amazon Q Business application was created.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
    status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
    The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
    updatedAt String
    The Unix timestamp when the Amazon Q Business application was last updated.

    Supporting Types

    ApplicationAttachmentsConfiguration, ApplicationAttachmentsConfigurationArgs

    AttachmentsControlMode Pulumi.AwsNative.QBusiness.ApplicationAttachmentsControlMode
    Status information about whether file upload functionality is activated or deactivated for your end user.
    AttachmentsControlMode ApplicationAttachmentsControlMode
    Status information about whether file upload functionality is activated or deactivated for your end user.
    attachmentsControlMode ApplicationAttachmentsControlMode
    Status information about whether file upload functionality is activated or deactivated for your end user.
    attachmentsControlMode ApplicationAttachmentsControlMode
    Status information about whether file upload functionality is activated or deactivated for your end user.
    attachments_control_mode ApplicationAttachmentsControlMode
    Status information about whether file upload functionality is activated or deactivated for your end user.
    attachmentsControlMode "ENABLED" | "DISABLED"
    Status information about whether file upload functionality is activated or deactivated for your end user.

    ApplicationAttachmentsControlMode, ApplicationAttachmentsControlModeArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    ApplicationAttachmentsControlModeEnabled
    ENABLED
    ApplicationAttachmentsControlModeDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    ApplicationEncryptionConfiguration, ApplicationEncryptionConfigurationArgs

    KmsKeyId string
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
    KmsKeyId string
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
    kmsKeyId String
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
    kmsKeyId string
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
    kms_key_id str
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
    kmsKeyId String
    The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.

    ApplicationStatus, ApplicationStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    ApplicationStatusCreating
    CREATING
    ApplicationStatusActive
    ACTIVE
    ApplicationStatusDeleting
    DELETING
    ApplicationStatusFailed
    FAILED
    ApplicationStatusUpdating
    UPDATING
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    FAILED
    FAILED
    UPDATING
    UPDATING
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "UPDATING"
    UPDATING

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi