Class: AWSCDK::QBusiness::CfnDataSource

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

Overview

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDataSource

Create a new AWS::QBusiness::DataSource.

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::CfnDataSourceProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'q_business/cfn_data_source.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnDataSourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcWJ1c2luZXNzLkNmbkRhdGFTb3VyY2VQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_data_source(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'q_business/cfn_data_source.rb', line 89

def self.arn_for_data_source(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xYnVzaW5lc3MuSURhdGFTb3VyY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_qbusiness.CfnDataSource", "arnForDataSource", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'q_business/cfn_data_source.rb', line 196

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

.is_cfn_data_source(x) ⇒ Boolean

Checks whether the given object is a CfnDataSource.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'q_business/cfn_data_source.rb', line 98

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

.jsii_overridable_methods ⇒ Object 



28
29
30
31
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
 
# File 'q_business/cfn_data_source.rb', line 28

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 },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_data_source_arn => { kind: :property, name: "attrDataSourceArn", is_optional: false },
    :attr_data_source_id => { kind: :property, name: "attrDataSourceId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_type => { kind: :property, name: "attrType", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :data_source_ref => { kind: :property, name: "dataSourceRef", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :configuration => { kind: :property, name: "configuration", is_optional: false },
    :display_name => { kind: :property, name: "displayName", is_optional: false },
    :index_id => { kind: :property, name: "indexId", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :document_enrichment_configuration => { kind: :property, name: "documentEnrichmentConfiguration", is_optional: true },
    :media_extraction_configuration => { kind: :property, name: "mediaExtractionConfiguration", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :sync_schedule => { kind: :property, name: "syncSchedule", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :vpc_configuration => { kind: :property, name: "vpcConfiguration", 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.



428
429
430
431
 
# File 'q_business/cfn_data_source.rb', line 428

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:



440
441
442
443
 
# File 'q_business/cfn_data_source.rb', line 440

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:



450
451
452
453
 
# File 'q_business/cfn_data_source.rb', line 450

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:



461
462
463
464
465
 
# File 'q_business/cfn_data_source.rb', line 461

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.


518
519
520
521
522
 
# File 'q_business/cfn_data_source.rb', line 518

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.



528
529
530
531
 
# File 'q_business/cfn_data_source.rb', line 528

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.



540
541
542
543
544
 
# File 'q_business/cfn_data_source.rb', line 540

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_id ⇒ String

The identifier of the Amazon Q Business application the data source will be attached to.

Returns:

  • (String) 


259
260
261
 
# File 'q_business/cfn_data_source.rb', line 259

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



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

def application_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  jsii_set_property("applicationId", value)
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:



553
554
555
556
 
# File 'q_business/cfn_data_source.rb', line 553

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:



575
576
577
578
579
580
 
# File 'q_business/cfn_data_source.rb', line 575

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

#attr_created_at ⇒ String

The Unix timestamp when the Amazon Q Business data source was created.

Returns:

  • (String) 


203
204
205
 
# File 'q_business/cfn_data_source.rb', line 203

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_data_source_arn ⇒ String

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

Returns:

  • (String) 


210
211
212
 
# File 'q_business/cfn_data_source.rb', line 210

def attr_data_source_arn()
  jsii_get_property("attrDataSourceArn")
end

#attr_data_source_id ⇒ String

The identifier of the Amazon Q Business data source.

Returns:

  • (String) 


217
218
219
 
# File 'q_business/cfn_data_source.rb', line 217

def attr_data_source_id()
  jsii_get_property("attrDataSourceId")
end

#attr_status ⇒ String

The status of the Amazon Q Business data source.

Returns:

  • (String) 


224
225
226
 
# File 'q_business/cfn_data_source.rb', line 224

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_type ⇒ String

The type of the Amazon Q Business data source.

Returns:

  • (String) 


231
232
233
 
# File 'q_business/cfn_data_source.rb', line 231

def attr_type()
  jsii_get_property("attrType")
end

#attr_updated_at ⇒ String

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

Returns:

  • (String) 


238
239
240
 
# File 'q_business/cfn_data_source.rb', line 238

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



245
246
247
 
# File 'q_business/cfn_data_source.rb', line 245

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'q_business/cfn_data_source.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'q_business/cfn_data_source.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


584
585
586
587
 
# File 'q_business/cfn_data_source.rb', line 584

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


159
160
161
 
# File 'q_business/cfn_data_source.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'q_business/cfn_data_source.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration ⇒ Object

Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .

Returns:

  • (Object) 


271
272
273
 
# File 'q_business/cfn_data_source.rb', line 271

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



275
276
277
278
 
# File 'q_business/cfn_data_source.rb', line 275

def configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "configuration")
  jsii_set_property("configuration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'q_business/cfn_data_source.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#data_source_ref ⇒ AWSCDK::Interfaces::AWSQbusiness::DataSourceReference

A reference to a DataSource resource.

Returns:



252
253
254
 
# File 'q_business/cfn_data_source.rb', line 252

def data_source_ref()
  jsii_get_property("dataSourceRef")
end

#description ⇒ String?

A description for the data source connector.

Returns:

  • (String, nil) 


307
308
309
 
# File 'q_business/cfn_data_source.rb', line 307

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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 data source.

Returns:

  • (String) 


283
284
285
 
# File 'q_business/cfn_data_source.rb', line 283

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



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

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

#document_enrichment_configuration ⇒ AWSCDK::IResolvable, ...

Provides the configuration information for altering document metadata and content during the document ingestion process.

Returns:



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

def document_enrichment_configuration()
  jsii_get_property("documentEnrichmentConfiguration")
end

#document_enrichment_configuration=(value) ⇒ Object 



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

def document_enrichment_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnDataSource::DocumentEnrichmentConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuRGF0YVNvdXJjZS5Eb2N1bWVudEVucmljaG1lbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "documentEnrichmentConfiguration") unless value.nil?
  jsii_set_property("documentEnrichmentConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'q_business/cfn_data_source.rb', line 171

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:



597
598
599
600
601
 
# File 'q_business/cfn_data_source.rb', line 597

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:



608
609
610
611
 
# File 'q_business/cfn_data_source.rb', line 608

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

#index_id ⇒ String

The identifier of the index the data source is attached to.

Returns:

  • (String) 


295
296
297
 
# File 'q_business/cfn_data_source.rb', line 295

def index_id()
  jsii_get_property("indexId")
end

#index_id=(value) ⇒ Object 



299
300
301
302
 
# File 'q_business/cfn_data_source.rb', line 299

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



678
679
680
681
 
# File 'q_business/cfn_data_source.rb', line 678

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) 


123
124
125
 
# File 'q_business/cfn_data_source.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#media_extraction_configuration ⇒ AWSCDK::IResolvable, ...

The configuration for extracting information from media in documents.

Returns:



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

def media_extraction_configuration()
  jsii_get_property("mediaExtractionConfiguration")
end

#media_extraction_configuration=(value) ⇒ Object 



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

def media_extraction_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnDataSource::MediaExtractionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuRGF0YVNvdXJjZS5NZWRpYUV4dHJhY3Rpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "mediaExtractionConfiguration") unless value.nil?
  jsii_set_property("mediaExtractionConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'q_business/cfn_data_source.rb', line 106

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:



619
620
621
 
# File 'q_business/cfn_data_source.rb', line 619

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:



626
627
628
 
# File 'q_business/cfn_data_source.rb', line 626

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.



419
420
421
422
 
# File 'q_business/cfn_data_source.rb', line 419

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

#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) 


142
143
144
 
# File 'q_business/cfn_data_source.rb', line 142

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:



637
638
639
640
 
# File 'q_business/cfn_data_source.rb', line 637

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


644
645
646
647
 
# File 'q_business/cfn_data_source.rb', line 644

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:



654
655
656
657
658
 
# File 'q_business/cfn_data_source.rb', line 654

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 permission to access the data source and required resources.

Returns:

  • (String, nil) 


345
346
347
 
# File 'q_business/cfn_data_source.rb', line 345

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



349
350
351
352
 
# File 'q_business/cfn_data_source.rb', line 349

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.



663
664
665
 
# File 'q_business/cfn_data_source.rb', line 663

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:



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

def stack()
  jsii_get_property("stack")
end

#sync_schedule ⇒ String?

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.

Returns:

  • (String, nil) 


357
358
359
 
# File 'q_business/cfn_data_source.rb', line 357

def sync_schedule()
  jsii_get_property("syncSchedule")
end

#sync_schedule=(value) ⇒ Object 



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

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

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs that identify or categorize the data source connector.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

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



395
396
397
 
# File 'q_business/cfn_data_source.rb', line 395

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


179
180
181
 
# File 'q_business/cfn_data_source.rb', line 179

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


189
190
191
 
# File 'q_business/cfn_data_source.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


669
670
671
672
 
# File 'q_business/cfn_data_source.rb', line 669

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

#vpc_configuration ⇒ AWSCDK::IResolvable, ...

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

Returns:



382
383
384
 
# File 'q_business/cfn_data_source.rb', line 382

def vpc_configuration()
  jsii_get_property("vpcConfiguration")
end

#vpc_configuration=(value) ⇒ Object 



386
387
388
389
390
 
# File 'q_business/cfn_data_source.rb', line 386

def vpc_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnDataSource::DataSourceVPCConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuRGF0YVNvdXJjZS5EYXRhU291cmNlVnBjQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "vpcConfiguration") unless value.nil?
  jsii_set_property("vpcConfiguration", value)
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) 


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

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