Class: AWSCDK::QBusiness::CfnApplication

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSQbusiness::IApplicationRef
Defined in:
q_business/cfn_application.rb

Overview

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.

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

When you create an application, Amazon Q Business may securely transmit data for processing from your selected AWS region, but within your geography. For more information, see Cross region inference in Amazon Q Business .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnApplication

Create a new AWS::QBusiness::Application.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::QBusiness::CfnApplicationProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'q_business/cfn_application.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplicationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcWJ1c2luZXNzLkNmbkFwcGxpY2F0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_application(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'q_business/cfn_application.rb', line 96

def self.arn_for_application(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xYnVzaW5lc3MuSUFwcGxpY2F0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnApplication", "arnForApplication", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


229
230
231
 
# File 'q_business/cfn_application.rb', line 229

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_qbusiness.CfnApplication", "CFN_RESOURCE_TYPE_NAME")
end

.from_application_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSQbusiness::IApplicationRef

Creates a new IApplicationRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



107
108
109
110
111
112
 
# File 'q_business/cfn_application.rb', line 107

def self.from_application_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnApplication", "fromApplicationArn", [scope, id, arn])
end

.from_application_id(scope, id, application_id) ⇒ AWSCDK::Interfaces::AWSQbusiness::IApplicationRef

Creates a new IApplicationRef from a applicationId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • application_id (String)

Returns:



120
121
122
123
124
125
 
# File 'q_business/cfn_application.rb', line 120

def self.from_application_id(scope, id, application_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnApplication", "fromApplicationId", [scope, id, application_id])
end

.is_cfn_application(x) ⇒ Boolean

Checks whether the given object is a CfnApplication.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


131
132
133
134
 
# File 'q_business/cfn_application.rb', line 131

def self.is_cfn_application(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnApplication", "isCfnApplication", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'q_business/cfn_application.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :application_ref => { kind: :property, name: "applicationRef", is_optional: false },
    :attr_application_arn => { kind: :property, name: "attrApplicationArn", is_optional: false },
    :attr_application_id => { kind: :property, name: "attrApplicationId", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_identity_center_application_arn => { kind: :property, name: "attrIdentityCenterApplicationArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :display_name => { kind: :property, name: "displayName", is_optional: false },
    :attachments_configuration => { kind: :property, name: "attachmentsConfiguration", is_optional: true },
    :auto_subscription_configuration => { kind: :property, name: "autoSubscriptionConfiguration", is_optional: true },
    :client_ids_for_oidc => { kind: :property, name: "clientIdsForOidc", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_configuration => { kind: :property, name: "encryptionConfiguration", is_optional: true },
    :iam_identity_provider_arn => { kind: :property, name: "iamIdentityProviderArn", is_optional: true },
    :identity_center_instance_arn => { kind: :property, name: "identityCenterInstanceArn", is_optional: true },
    :identity_type => { kind: :property, name: "identityType", is_optional: true },
    :personalization_configuration => { kind: :property, name: "personalizationConfiguration", is_optional: true },
    :q_apps_configuration => { kind: :property, name: "qAppsConfiguration", is_optional: true },
    :quick_sight_configuration => { kind: :property, name: "quickSightConfiguration", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



502
503
504
505
 
# File 'q_business/cfn_application.rb', line 502

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



514
515
516
517
 
# File 'q_business/cfn_application.rb', line 514

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



524
525
526
527
 
# File 'q_business/cfn_application.rb', line 524

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



535
536
537
538
539
 
# File 'q_business/cfn_application.rb', line 535

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


592
593
594
595
596
 
# File 'q_business/cfn_application.rb', line 592

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



602
603
604
605
 
# File 'q_business/cfn_application.rb', line 602

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



614
615
616
617
618
 
# File 'q_business/cfn_application.rb', line 614

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#application_ref ⇒ AWSCDK::Interfaces::AWSQbusiness::ApplicationReference

A reference to a Application resource.

Returns:



236
237
238
 
# File 'q_business/cfn_application.rb', line 236

def application_ref()
  jsii_get_property("applicationRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



627
628
629
630
 
# File 'q_business/cfn_application.rb', line 627

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



649
650
651
652
653
654
 
# File 'q_business/cfn_application.rb', line 649

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attachments_configuration ⇒ AWSCDK::IResolvable, ...

Configuration information for the file upload during chat feature.

Returns:



306
307
308
 
# File 'q_business/cfn_application.rb', line 306

def attachments_configuration()
  jsii_get_property("attachmentsConfiguration")
end

#attachments_configuration=(value) ⇒ Object 



310
311
312
313
314
 
# File 'q_business/cfn_application.rb', line 310

def attachments_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::AttachmentsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uQXR0YWNobWVudHNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "attachmentsConfiguration") unless value.nil?
  jsii_set_property("attachmentsConfiguration", value)
end

#attr_application_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q Business application.

Returns:

  • (String) 


243
244
245
 
# File 'q_business/cfn_application.rb', line 243

def attr_application_arn()
  jsii_get_property("attrApplicationArn")
end

#attr_application_id ⇒ String

The identifier for the Amazon Q Business application.

Returns:

  • (String) 


250
251
252
 
# File 'q_business/cfn_application.rb', line 250

def attr_application_id()
  jsii_get_property("attrApplicationId")
end

#attr_created_at ⇒ String

The Unix timestamp when the Amazon Q Business application was created.

Returns:

  • (String) 


257
258
259
 
# File 'q_business/cfn_application.rb', line 257

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_identity_center_application_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS SSO instance attached to your Amazon Q Business application.

Returns:

  • (String) 


264
265
266
 
# File 'q_business/cfn_application.rb', line 264

def attr_identity_center_application_arn()
  jsii_get_property("attrIdentityCenterApplicationArn")
end

#attr_status ⇒ String

The status of the Amazon Q Business application.

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

Returns:

  • (String) 


273
274
275
 
# File 'q_business/cfn_application.rb', line 273

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

  • (String) 


280
281
282
 
# File 'q_business/cfn_application.rb', line 280

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#auto_subscription_configuration ⇒ AWSCDK::IResolvable, ...

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

Returns:



319
320
321
 
# File 'q_business/cfn_application.rb', line 319

def auto_subscription_configuration()
  jsii_get_property("autoSubscriptionConfiguration")
end

#auto_subscription_configuration=(value) ⇒ Object 



323
324
325
326
327
 
# File 'q_business/cfn_application.rb', line 323

def auto_subscription_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::AutoSubscriptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uQXV0b1N1YnNjcmlwdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "autoSubscriptionConfiguration") unless value.nil?
  jsii_set_property("autoSubscriptionConfiguration", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



287
288
289
 
# File 'q_business/cfn_application.rb', line 287

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



182
183
184
 
# File 'q_business/cfn_application.rb', line 182

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'q_business/cfn_application.rb', line 187

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


658
659
660
661
 
# File 'q_business/cfn_application.rb', line 658

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


192
193
194
 
# File 'q_business/cfn_application.rb', line 192

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


199
200
201
 
# File 'q_business/cfn_application.rb', line 199

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_ids_for_oidc ⇒ Array<String>?

The OIDC client ID for a Amazon Q Business application.

Returns:

  • (Array<String>, nil) 


332
333
334
 
# File 'q_business/cfn_application.rb', line 332

def client_ids_for_oidc()
  jsii_get_property("clientIdsForOidc")
end

#client_ids_for_oidc=(value) ⇒ Object 



336
337
338
339
 
# File 'q_business/cfn_application.rb', line 336

def client_ids_for_oidc=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clientIdsForOidc") unless value.nil?
  jsii_set_property("clientIdsForOidc", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


144
145
146
 
# File 'q_business/cfn_application.rb', line 144

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the Amazon Q Business application.

Returns:

  • (String, nil) 


344
345
346
 
# File 'q_business/cfn_application.rb', line 344

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



348
349
350
351
 
# File 'q_business/cfn_application.rb', line 348

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#display_name ⇒ String

The name of the Amazon Q Business application.

Returns:

  • (String) 


294
295
296
 
# File 'q_business/cfn_application.rb', line 294

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



298
299
300
301
 
# File 'q_business/cfn_application.rb', line 298

def display_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  jsii_set_property("displayName", value)
end

#encryption_configuration ⇒ AWSCDK::IResolvable, ...

Provides the identifier of the AWS key used to encrypt data indexed by Amazon Q Business.

Returns:



356
357
358
 
# File 'q_business/cfn_application.rb', line 356

def encryption_configuration()
  jsii_get_property("encryptionConfiguration")
end

#encryption_configuration=(value) ⇒ Object 



360
361
362
363
364
 
# File 'q_business/cfn_application.rb', line 360

def encryption_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::EncryptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uRW5jcnlwdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "encryptionConfiguration") unless value.nil?
  jsii_set_property("encryptionConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



204
205
206
 
# File 'q_business/cfn_application.rb', line 204

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



671
672
673
674
675
 
# File 'q_business/cfn_application.rb', line 671

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



682
683
684
685
 
# File 'q_business/cfn_application.rb', line 682

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#iam_identity_provider_arn ⇒ String?

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

Returns:

  • (String, nil) 


369
370
371
 
# File 'q_business/cfn_application.rb', line 369

def iam_identity_provider_arn()
  jsii_get_property("iamIdentityProviderArn")
end

#iam_identity_provider_arn=(value) ⇒ Object 



373
374
375
376
 
# File 'q_business/cfn_application.rb', line 373

def iam_identity_provider_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamIdentityProviderArn") unless value.nil?
  jsii_set_property("iamIdentityProviderArn", value)
end

#identity_center_instance_arn ⇒ 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.

Returns:

  • (String, nil) 


381
382
383
 
# File 'q_business/cfn_application.rb', line 381

def identity_center_instance_arn()
  jsii_get_property("identityCenterInstanceArn")
end

#identity_center_instance_arn=(value) ⇒ Object 



385
386
387
388
 
# File 'q_business/cfn_application.rb', line 385

def identity_center_instance_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityCenterInstanceArn") unless value.nil?
  jsii_set_property("identityCenterInstanceArn", value)
end

#identity_type ⇒ String?

The authentication type being used by a Amazon Q Business application.

Returns:

  • (String, nil) 


393
394
395
 
# File 'q_business/cfn_application.rb', line 393

def identity_type()
  jsii_get_property("identityType")
end

#identity_type=(value) ⇒ Object 



397
398
399
400
 
# File 'q_business/cfn_application.rb', line 397

def identity_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityType") unless value.nil?
  jsii_set_property("identityType", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



752
753
754
755
 
# File 'q_business/cfn_application.rb', line 752

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


156
157
158
 
# File 'q_business/cfn_application.rb', line 156

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


139
140
141
 
# File 'q_business/cfn_application.rb', line 139

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



693
694
695
 
# File 'q_business/cfn_application.rb', line 693

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



700
701
702
 
# File 'q_business/cfn_application.rb', line 700

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



493
494
495
496
 
# File 'q_business/cfn_application.rb', line 493

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#personalization_configuration ⇒ AWSCDK::IResolvable, ...

Configuration information about chat response personalization.

Returns:



405
406
407
 
# File 'q_business/cfn_application.rb', line 405

def personalization_configuration()
  jsii_get_property("personalizationConfiguration")
end

#personalization_configuration=(value) ⇒ Object 



409
410
411
412
413
 
# File 'q_business/cfn_application.rb', line 409

def personalization_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::PersonalizationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uUGVyc29uYWxpemF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "personalizationConfiguration") unless value.nil?
  jsii_set_property("personalizationConfiguration", value)
end

#q_apps_configuration ⇒ AWSCDK::IResolvable, ...

Configuration information about Amazon Q Apps.

Returns:



418
419
420
 
# File 'q_business/cfn_application.rb', line 418

def q_apps_configuration()
  jsii_get_property("qAppsConfiguration")
end

#q_apps_configuration=(value) ⇒ Object 



422
423
424
425
426
 
# File 'q_business/cfn_application.rb', line 422

def q_apps_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::QAppsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uUUFwcHNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "qAppsConfiguration") unless value.nil?
  jsii_set_property("qAppsConfiguration", value)
end

#quick_sight_configuration ⇒ AWSCDK::IResolvable, ...

The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.

Returns:



431
432
433
 
# File 'q_business/cfn_application.rb', line 431

def quick_sight_configuration()
  jsii_get_property("quickSightConfiguration")
end

#quick_sight_configuration=(value) ⇒ Object 



435
436
437
438
439
 
# File 'q_business/cfn_application.rb', line 435

def quick_sight_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnApplication::QuickSightConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuQXBwbGljYXRpb24uUXVpY2tTaWdodENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "quickSightConfiguration") unless value.nil?
  jsii_set_property("quickSightConfiguration", value)
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


175
176
177
 
# File 'q_business/cfn_application.rb', line 175

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



711
712
713
714
 
# File 'q_business/cfn_application.rb', line 711

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


718
719
720
721
 
# File 'q_business/cfn_application.rb', line 718

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



728
729
730
731
732
 
# File 'q_business/cfn_application.rb', line 728

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String?

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

Returns:

  • (String, nil) 


444
445
446
 
# File 'q_business/cfn_application.rb', line 444

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



448
449
450
451
 
# File 'q_business/cfn_application.rb', line 448

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless value.nil?
  jsii_set_property("roleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



737
738
739
 
# File 'q_business/cfn_application.rb', line 737

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



165
166
167
 
# File 'q_business/cfn_application.rb', line 165

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs that identify or categorize your Amazon Q Business application.

Returns:



456
457
458
 
# File 'q_business/cfn_application.rb', line 456

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



460
461
462
463
464
 
# File 'q_business/cfn_application.rb', line 460

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



469
470
471
 
# File 'q_business/cfn_application.rb', line 469

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


212
213
214
 
# File 'q_business/cfn_application.rb', line 212

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


222
223
224
 
# File 'q_business/cfn_application.rb', line 222

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


743
744
745
746
 
# File 'q_business/cfn_application.rb', line 743

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


482
483
484
485
486
487
 
# File 'q_business/cfn_application.rb', line 482

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end