Class: AWSCDK::QuickSight::CfnDataSource

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSQuicksight::IDataSourceRef
Defined in:
quick_sight/cfn_data_source.rb

Overview

Creates a data source.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDataSource

Create a new AWS::QuickSight::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::QuickSight::CfnDataSourceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'quick_sight/cfn_data_source.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::QuickSight::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU291cmNlUHJvcHMifQ==")), "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) 


87
88
89
90
 
# File 'quick_sight/cfn_data_source.rb', line 87

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'quick_sight/cfn_data_source.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_quicksight.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) 


96
97
98
99
 
# File 'quick_sight/cfn_data_source.rb', line 96

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_quicksight.CfnDataSource", "isCfnDataSource", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'quick_sight/cfn_data_source.rb', line 26

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_time => { kind: :property, name: "attrCreatedTime", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :data_source_ref => { kind: :property, name: "dataSourceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :alternate_data_source_parameters => { kind: :property, name: "alternateDataSourceParameters", is_optional: true },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: true },
    :credentials => { kind: :property, name: "credentials", is_optional: true },
    :data_source_id => { kind: :property, name: "dataSourceId", is_optional: true },
    :data_source_parameters => { kind: :property, name: "dataSourceParameters", is_optional: true },
    :error_info => { kind: :property, name: "errorInfo", is_optional: true },
    :folder_arns => { kind: :property, name: "folderArns", is_optional: true },
    :permissions => { kind: :property, name: "permissions", is_optional: true },
    :ssl_properties => { kind: :property, name: "sslProperties", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_connection_properties => { kind: :property, name: "vpcConnectionProperties", 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.



438
439
440
441
 
# File 'quick_sight/cfn_data_source.rb', line 438

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:



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

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:



460
461
462
463
 
# File 'quick_sight/cfn_data_source.rb', line 460

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:



471
472
473
474
475
 
# File 'quick_sight/cfn_data_source.rb', line 471

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.


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

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.



538
539
540
541
 
# File 'quick_sight/cfn_data_source.rb', line 538

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.



550
551
552
553
554
 
# File 'quick_sight/cfn_data_source.rb', line 550

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

#alternate_data_source_parameters ⇒ AWSCDK::IResolvable, ...

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

Returns:



269
270
271
 
# File 'quick_sight/cfn_data_source.rb', line 269

def alternate_data_source_parameters()
  jsii_get_property("alternateDataSourceParameters")
end

#alternate_data_source_parameters=(value) ⇒ Object 



273
274
275
276
 
# File 'quick_sight/cfn_data_source.rb', line 273

def alternate_data_source_parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU291cmNlLkRhdGFTb3VyY2VQYXJhbWV0ZXJzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "alternateDataSourceParameters") unless value.nil?
  jsii_set_property("alternateDataSourceParameters", 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:



563
564
565
566
 
# File 'quick_sight/cfn_data_source.rb', line 563

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:



585
586
587
588
589
590
 
# File 'quick_sight/cfn_data_source.rb', line 585

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

The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (String) 


201
202
203
 
# File 'quick_sight/cfn_data_source.rb', line 201

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The time that this data source was created.

Returns:

  • (String) 


208
209
210
 
# File 'quick_sight/cfn_data_source.rb', line 208

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_last_updated_time ⇒ String

The last time that this data source was updated.

Returns:

  • (String) 


215
216
217
 
# File 'quick_sight/cfn_data_source.rb', line 215

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_status ⇒ String

The HTTP status of the request.

Returns:

  • (String) 


222
223
224
 
# File 'quick_sight/cfn_data_source.rb', line 222

def attr_status()
  jsii_get_property("attrStatus")
end

#aws_account_id ⇒ String?

The AWS account ID.

Returns:

  • (String, nil) 


281
282
283
 
# File 'quick_sight/cfn_data_source.rb', line 281

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object 



285
286
287
288
 
# File 'quick_sight/cfn_data_source.rb', line 285

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



147
148
149
 
# File 'quick_sight/cfn_data_source.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'quick_sight/cfn_data_source.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


594
595
596
597
 
# File 'quick_sight/cfn_data_source.rb', line 594

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


157
158
159
 
# File 'quick_sight/cfn_data_source.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'quick_sight/cfn_data_source.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'quick_sight/cfn_data_source.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#credentials ⇒ AWSCDK::IResolvable, ...

The credentials Amazon Quick Sight that uses to connect to your underlying source.

Returns:



293
294
295
 
# File 'quick_sight/cfn_data_source.rb', line 293

def credentials()
  jsii_get_property("credentials")
end

#credentials=(value) ⇒ Object 



297
298
299
300
301
 
# File 'quick_sight/cfn_data_source.rb', line 297

def credentials=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceCredentialsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZUNyZWRlbnRpYWxzUHJvcGVydHkifV19fQ==")), "credentials") unless value.nil?
  jsii_set_property("credentials", value)
end

#data_source_id ⇒ String?

An ID for the data source.

Returns:

  • (String, nil) 


306
307
308
 
# File 'quick_sight/cfn_data_source.rb', line 306

def data_source_id()
  jsii_get_property("dataSourceId")
end

#data_source_id=(value) ⇒ Object 



310
311
312
313
 
# File 'quick_sight/cfn_data_source.rb', line 310

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

#data_source_parameters ⇒ AWSCDK::IResolvable, ...

The parameters that Amazon Quick Sight uses to connect to your underlying source.

Returns:



318
319
320
 
# File 'quick_sight/cfn_data_source.rb', line 318

def data_source_parameters()
  jsii_get_property("dataSourceParameters")
end

#data_source_parameters=(value) ⇒ Object 



322
323
324
325
326
 
# File 'quick_sight/cfn_data_source.rb', line 322

def data_source_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "dataSourceParameters") unless value.nil?
  jsii_set_property("dataSourceParameters", value)
end

#data_source_ref ⇒ AWSCDK::Interfaces::AWSQuicksight::DataSourceReference

A reference to a DataSource resource.

Returns:



229
230
231
 
# File 'quick_sight/cfn_data_source.rb', line 229

def data_source_ref()
  jsii_get_property("dataSourceRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'quick_sight/cfn_data_source.rb', line 169

def env()
  jsii_get_property("env")
end

#error_info ⇒ AWSCDK::IResolvable, ...

Error information from the last update or the creation of the data source.

Returns:



331
332
333
 
# File 'quick_sight/cfn_data_source.rb', line 331

def error_info()
  jsii_get_property("errorInfo")
end

#error_info=(value) ⇒ Object 



335
336
337
338
339
 
# File 'quick_sight/cfn_data_source.rb', line 335

def error_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceErrorInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZUVycm9ySW5mb1Byb3BlcnR5In1dfX0=")), "errorInfo") unless value.nil?
  jsii_set_property("errorInfo", value)
end

#folder_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


342
343
344
 
# File 'quick_sight/cfn_data_source.rb', line 342

def folder_arns()
  jsii_get_property("folderArns")
end

#folder_arns=(value) ⇒ Object 



346
347
348
349
 
# File 'quick_sight/cfn_data_source.rb', line 346

def folder_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "folderArns") unless value.nil?
  jsii_set_property("folderArns", value)
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:



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

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:



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



688
689
690
691
 
# File 'quick_sight/cfn_data_source.rb', line 688

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) 


121
122
123
 
# File 'quick_sight/cfn_data_source.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A display name for the data source.

Returns:

  • (String) 


243
244
245
 
# File 'quick_sight/cfn_data_source.rb', line 243

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



247
248
249
250
 
# File 'quick_sight/cfn_data_source.rb', line 247

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'quick_sight/cfn_data_source.rb', line 104

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:



629
630
631
 
# File 'quick_sight/cfn_data_source.rb', line 629

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:



636
637
638
 
# File 'quick_sight/cfn_data_source.rb', line 636

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.



429
430
431
432
 
# File 'quick_sight/cfn_data_source.rb', line 429

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

#permissions ⇒ AWSCDK::IResolvable, ...

A list of resource permissions on the data source.

Returns:



354
355
356
 
# File 'quick_sight/cfn_data_source.rb', line 354

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object 



358
359
360
361
 
# File 'quick_sight/cfn_data_source.rb', line 358

def permissions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU291cmNlLlJlc291cmNlUGVybWlzc2lvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "permissions") unless value.nil?
  jsii_set_property("permissions", 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) 


140
141
142
 
# File 'quick_sight/cfn_data_source.rb', line 140

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:



647
648
649
650
 
# File 'quick_sight/cfn_data_source.rb', line 647

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


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

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:



664
665
666
667
668
 
# File 'quick_sight/cfn_data_source.rb', line 664

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

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



673
674
675
 
# File 'quick_sight/cfn_data_source.rb', line 673

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

#ssl_properties ⇒ AWSCDK::IResolvable, ...

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

Returns:



366
367
368
 
# File 'quick_sight/cfn_data_source.rb', line 366

def ssl_properties()
  jsii_get_property("sslProperties")
end

#ssl_properties=(value) ⇒ Object 



370
371
372
373
374
 
# File 'quick_sight/cfn_data_source.rb', line 370

def ssl_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::SSLPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuU3NsUHJvcGVydGllc1Byb3BlcnR5In1dfX0=")), "sslProperties") unless value.nil?
  jsii_set_property("sslProperties", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



130
131
132
 
# File 'quick_sight/cfn_data_source.rb', line 130

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



236
237
238
 
# File 'quick_sight/cfn_data_source.rb', line 236

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:



379
380
381
 
# File 'quick_sight/cfn_data_source.rb', line 379

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



383
384
385
386
387
 
# File 'quick_sight/cfn_data_source.rb', line 383

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



405
406
407
 
# File 'quick_sight/cfn_data_source.rb', line 405

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

#type ⇒ String

The type of the data source.

To return a list of all data sources, use ListDataSources .

Returns:

  • (String) 


257
258
259
 
# File 'quick_sight/cfn_data_source.rb', line 257

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



261
262
263
264
 
# File 'quick_sight/cfn_data_source.rb', line 261

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


177
178
179
 
# File 'quick_sight/cfn_data_source.rb', line 177

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


187
188
189
 
# File 'quick_sight/cfn_data_source.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


679
680
681
682
 
# File 'quick_sight/cfn_data_source.rb', line 679

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

#vpc_connection_properties ⇒ AWSCDK::IResolvable, ...

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

Returns:



392
393
394
 
# File 'quick_sight/cfn_data_source.rb', line 392

def vpc_connection_properties()
  jsii_get_property("vpcConnectionProperties")
end

#vpc_connection_properties=(value) ⇒ Object 



396
397
398
399
400
 
# File 'quick_sight/cfn_data_source.rb', line 396

def vpc_connection_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::VPCConnectionPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuVnBjQ29ubmVjdGlvblByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "vpcConnectionProperties") unless value.nil?
  jsii_set_property("vpcConnectionProperties", 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) 


418
419
420
421
422
423
 
# File 'quick_sight/cfn_data_source.rb', line 418

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