Class: AWSCDK::QuickSight::CfnDataSet

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

Overview

Creates a dataset.

This operation doesn't support datasets that include uploaded files as a source.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDataSet

Create a new AWS::QuickSight::DataSet.

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::CfnDataSetProps, nil) (defaults to: nil)

    Resource properties.



20
21
22
23
24
25
26
# File 'quick_sight/cfn_data_set.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU2V0UHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_data_set(resource) ⇒ String

Parameters:

Returns:

  • (String)


99
100
101
102
# File 'quick_sight/cfn_data_set.rb', line 99

def self.arn_for_data_set(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklEYXRhU2V0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnDataSet", "arnForDataSet", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


206
207
208
# File 'quick_sight/cfn_data_set.rb', line 206

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

.is_cfn_data_set(x) ⇒ Boolean

Checks whether the given object is a CfnDataSet.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


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

def self.is_cfn_data_set(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnDataSet", "isCfnDataSet", [x])
end

.jsii_overridable_methodsObject



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
86
87
88
89
90
91
92
93
94
95
# File 'quick_sight/cfn_data_set.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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_consumed_spice_capacity_in_bytes => { kind: :property, name: "attrConsumedSpiceCapacityInBytes", 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_output_columns => { kind: :property, name: "attrOutputColumns", is_optional: false },
    :data_set_ref => { kind: :property, name: "dataSetRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: true },
    :column_groups => { kind: :property, name: "columnGroups", is_optional: true },
    :column_level_permission_rules => { kind: :property, name: "columnLevelPermissionRules", is_optional: true },
    :data_prep_configuration => { kind: :property, name: "dataPrepConfiguration", is_optional: true },
    :data_set_id => { kind: :property, name: "dataSetId", is_optional: true },
    :dataset_parameters => { kind: :property, name: "datasetParameters", is_optional: true },
    :data_set_refresh_properties => { kind: :property, name: "dataSetRefreshProperties", is_optional: true },
    :data_set_usage_configuration => { kind: :property, name: "dataSetUsageConfiguration", is_optional: true },
    :field_folders => { kind: :property, name: "fieldFolders", is_optional: true },
    :folder_arns => { kind: :property, name: "folderArns", is_optional: true },
    :import_mode => { kind: :property, name: "importMode", is_optional: true },
    :ingestion_wait_policy => { kind: :property, name: "ingestionWaitPolicy", is_optional: true },
    :logical_table_map => { kind: :property, name: "logicalTableMap", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :performance_configuration => { kind: :property, name: "performanceConfiguration", is_optional: true },
    :permissions => { kind: :property, name: "permissions", is_optional: true },
    :physical_table_map => { kind: :property, name: "physicalTableMap", is_optional: true },
    :row_level_permission_data_set => { kind: :property, name: "rowLevelPermissionDataSet", is_optional: true },
    :row_level_permission_tag_configuration => { kind: :property, name: "rowLevelPermissionTagConfiguration", is_optional: true },
    :semantic_model_configuration => { kind: :property, name: "semanticModelConfiguration", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :use_as => { kind: :property, name: "useAs", 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.



575
576
577
578
# File 'quick_sight/cfn_data_set.rb', line 575

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:



587
588
589
590
# File 'quick_sight/cfn_data_set.rb', line 587

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:



597
598
599
600
# File 'quick_sight/cfn_data_set.rb', line 597

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.



608
609
610
611
612
# File 'quick_sight/cfn_data_set.rb', line 608

def (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.


665
666
667
668
669
# File 'quick_sight/cfn_data_set.rb', line 665

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.



675
676
677
678
# File 'quick_sight/cfn_data_set.rb', line 675

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.



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

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

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



700
701
702
703
# File 'quick_sight/cfn_data_set.rb', line 700

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:



722
723
724
725
726
727
# File 'quick_sight/cfn_data_set.rb', line 722

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_arnString

The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (String)


213
214
215
# File 'quick_sight/cfn_data_set.rb', line 213

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_consumed_spice_capacity_in_bytesAWSCDK::IResolvable

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

Returns:



223
224
225
# File 'quick_sight/cfn_data_set.rb', line 223

def attr_consumed_spice_capacity_in_bytes()
  jsii_get_property("attrConsumedSpiceCapacityInBytes")
end

#attr_created_timeString

The time this dataset version was created.

Returns:

  • (String)


230
231
232
# File 'quick_sight/cfn_data_set.rb', line 230

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_last_updated_timeString

The time this dataset version was last updated.

Returns:

  • (String)


237
238
239
# File 'quick_sight/cfn_data_set.rb', line 237

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_output_columnsAWSCDK::IResolvable

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Returns:



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

def attr_output_columns()
  jsii_get_property("attrOutputColumns")
end

#aws_account_idString?

The AWS account ID.

Returns:

  • (String, nil)


268
269
270
# File 'quick_sight/cfn_data_set.rb', line 268

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object



272
273
274
275
# File 'quick_sight/cfn_data_set.rb', line 272

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

#cfn_optionsAWSCDK::ICfnResourceOptions

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



159
160
161
# File 'quick_sight/cfn_data_set.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


731
732
733
734
# File 'quick_sight/cfn_data_set.rb', line 731

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


176
177
178
# File 'quick_sight/cfn_data_set.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#column_groupsAWSCDK::IResolvable, ...

Groupings of columns that work together in certain Amazon Quick Sight features.



280
281
282
# File 'quick_sight/cfn_data_set.rb', line 280

def column_groups()
  jsii_get_property("columnGroups")
end

#column_groups=(value) ⇒ Object



284
285
286
287
# File 'quick_sight/cfn_data_set.rb', line 284

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

#column_level_permission_rulesAWSCDK::IResolvable, ...

A set of one or more definitions of a ColumnLevelPermissionRule .



292
293
294
# File 'quick_sight/cfn_data_set.rb', line 292

def column_level_permission_rules()
  jsii_get_property("columnLevelPermissionRules")
end

#column_level_permission_rules=(value) ⇒ Object



296
297
298
299
# File 'quick_sight/cfn_data_set.rb', line 296

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

#creation_stackArray<String>

Returns:

  • (Array<String>)


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

def creation_stack()
  jsii_get_property("creationStack")
end

#data_prep_configurationAWSCDK::IResolvable, ...

The data preparation configuration associated with this dataset.



304
305
306
# File 'quick_sight/cfn_data_set.rb', line 304

def data_prep_configuration()
  jsii_get_property("dataPrepConfiguration")
end

#data_prep_configuration=(value) ⇒ Object



308
309
310
311
312
# File 'quick_sight/cfn_data_set.rb', line 308

def data_prep_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::DataPrepConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuRGF0YVByZXBDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "dataPrepConfiguration") unless value.nil?
  jsii_set_property("dataPrepConfiguration", value)
end

#data_set_idString?

An ID for the dataset that you want to create.

Returns:

  • (String, nil)


317
318
319
# File 'quick_sight/cfn_data_set.rb', line 317

def data_set_id()
  jsii_get_property("dataSetId")
end

#data_set_id=(value) ⇒ Object



321
322
323
324
# File 'quick_sight/cfn_data_set.rb', line 321

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

#data_set_refAWSCDK::Interfaces::AWSQuicksight::DataSetReference

A reference to a DataSet resource.



254
255
256
# File 'quick_sight/cfn_data_set.rb', line 254

def data_set_ref()
  jsii_get_property("dataSetRef")
end

#data_set_refresh_propertiesAWSCDK::IResolvable, ...

The refresh properties of a dataset.



341
342
343
# File 'quick_sight/cfn_data_set.rb', line 341

def data_set_refresh_properties()
  jsii_get_property("dataSetRefreshProperties")
end

#data_set_refresh_properties=(value) ⇒ Object



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

def data_set_refresh_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::DataSetRefreshPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuRGF0YVNldFJlZnJlc2hQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "dataSetRefreshProperties") unless value.nil?
  jsii_set_property("dataSetRefreshProperties", value)
end

#data_set_usage_configurationAWSCDK::IResolvable, ...

The usage configuration to apply to child datasets that reference this dataset as a source.



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

def data_set_usage_configuration()
  jsii_get_property("dataSetUsageConfiguration")
end

#data_set_usage_configuration=(value) ⇒ Object



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

def data_set_usage_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::DataSetUsageConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuRGF0YVNldFVzYWdlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "dataSetUsageConfiguration") unless value.nil?
  jsii_set_property("dataSetUsageConfiguration", value)
end

#dataset_parametersAWSCDK::IResolvable, ...

The parameters that are declared in a dataset.



329
330
331
# File 'quick_sight/cfn_data_set.rb', line 329

def dataset_parameters()
  jsii_get_property("datasetParameters")
end

#dataset_parameters=(value) ⇒ Object



333
334
335
336
# File 'quick_sight/cfn_data_set.rb', line 333

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

#envAWSCDK::Interfaces::ResourceEnvironment



181
182
183
# File 'quick_sight/cfn_data_set.rb', line 181

def env()
  jsii_get_property("env")
end

#field_foldersAWSCDK::IResolvable, ...

The folder that contains fields and nested subfolders for your dataset.



367
368
369
# File 'quick_sight/cfn_data_set.rb', line 367

def field_folders()
  jsii_get_property("fieldFolders")
end

#field_folders=(value) ⇒ Object



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

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

#folder_arnsArray<String>?

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

.

Returns:

  • (Array<String>, nil)


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

def folder_arns()
  jsii_get_property("folderArns")
end

#folder_arns=(value) ⇒ Object



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

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:



744
745
746
747
748
# File 'quick_sight/cfn_data_set.rb', line 744

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.



755
756
757
758
# File 'quick_sight/cfn_data_set.rb', line 755

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

#import_modeString?

Indicates whether you want to import the data into SPICE.

Returns:

  • (String, nil)


391
392
393
# File 'quick_sight/cfn_data_set.rb', line 391

def import_mode()
  jsii_get_property("importMode")
end

#import_mode=(value) ⇒ Object



395
396
397
398
# File 'quick_sight/cfn_data_set.rb', line 395

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

#ingestion_wait_policyAWSCDK::IResolvable, ...

The wait policy to use when creating or updating a Dataset.



403
404
405
# File 'quick_sight/cfn_data_set.rb', line 403

def ingestion_wait_policy()
  jsii_get_property("ingestionWaitPolicy")
end

#ingestion_wait_policy=(value) ⇒ Object



407
408
409
410
411
# File 'quick_sight/cfn_data_set.rb', line 407

def ingestion_wait_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::IngestionWaitPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuSW5nZXN0aW9uV2FpdFBvbGljeVByb3BlcnR5In1dfX0=")), "ingestionWaitPolicy") unless value.nil?
  jsii_set_property("ingestionWaitPolicy", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



825
826
827
828
# File 'quick_sight/cfn_data_set.rb', line 825

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

#logical_idString

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)


133
134
135
# File 'quick_sight/cfn_data_set.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#logical_table_mapAWSCDK::IResolvable, ...

Deprecated.

this property has been deprecated



415
416
417
# File 'quick_sight/cfn_data_set.rb', line 415

def logical_table_map()
  jsii_get_property("logicalTableMap")
end

#logical_table_map=(value) ⇒ Object



419
420
421
422
# File 'quick_sight/cfn_data_set.rb', line 419

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

#nameString?

The display name for the dataset.

Returns:

  • (String, nil)


427
428
429
# File 'quick_sight/cfn_data_set.rb', line 427

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



431
432
433
434
# File 'quick_sight/cfn_data_set.rb', line 431

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


116
117
118
# File 'quick_sight/cfn_data_set.rb', line 116

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



766
767
768
# File 'quick_sight/cfn_data_set.rb', line 766

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



773
774
775
# File 'quick_sight/cfn_data_set.rb', line 773

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.



566
567
568
569
# File 'quick_sight/cfn_data_set.rb', line 566

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

#performance_configurationAWSCDK::IResolvable, ...

The performance optimization configuration of a dataset.



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

def performance_configuration()
  jsii_get_property("performanceConfiguration")
end

#performance_configuration=(value) ⇒ Object



443
444
445
446
447
# File 'quick_sight/cfn_data_set.rb', line 443

def performance_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::PerformanceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuUGVyZm9ybWFuY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "performanceConfiguration") unless value.nil?
  jsii_set_property("performanceConfiguration", value)
end

#permissionsAWSCDK::IResolvable, ...

A list of resource permissions on the dataset.



452
453
454
# File 'quick_sight/cfn_data_set.rb', line 452

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object



456
457
458
459
# File 'quick_sight/cfn_data_set.rb', line 456

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

#physical_table_mapAWSCDK::IResolvable, ...

Declares the physical tables that are available in the underlying data sources.



464
465
466
# File 'quick_sight/cfn_data_set.rb', line 464

def physical_table_map()
  jsii_get_property("physicalTableMap")
end

#physical_table_map=(value) ⇒ Object



468
469
470
471
# File 'quick_sight/cfn_data_set.rb', line 468

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

#refString

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)


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

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:



784
785
786
787
# File 'quick_sight/cfn_data_set.rb', line 784

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


791
792
793
794
# File 'quick_sight/cfn_data_set.rb', line 791

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:



801
802
803
804
805
# File 'quick_sight/cfn_data_set.rb', line 801

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

#row_level_permission_data_setAWSCDK::IResolvable, ...

Deprecated.

this property has been deprecated

Information about a dataset that contains permissions for row-level security (RLS).



477
478
479
# File 'quick_sight/cfn_data_set.rb', line 477

def row_level_permission_data_set()
  jsii_get_property("rowLevelPermissionDataSet")
end

#row_level_permission_data_set=(value) ⇒ Object



481
482
483
484
485
# File 'quick_sight/cfn_data_set.rb', line 481

def row_level_permission_data_set=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::RowLevelPermissionDataSetProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuUm93TGV2ZWxQZXJtaXNzaW9uRGF0YVNldFByb3BlcnR5In1dfX0=")), "rowLevelPermissionDataSet") unless value.nil?
  jsii_set_property("rowLevelPermissionDataSet", value)
end

#row_level_permission_tag_configurationAWSCDK::IResolvable, ...

Deprecated.

this property has been deprecated

The configuration of tags on a dataset to set row-level security.



491
492
493
# File 'quick_sight/cfn_data_set.rb', line 491

def row_level_permission_tag_configuration()
  jsii_get_property("rowLevelPermissionTagConfiguration")
end

#row_level_permission_tag_configuration=(value) ⇒ Object



495
496
497
498
499
# File 'quick_sight/cfn_data_set.rb', line 495

def row_level_permission_tag_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::RowLevelPermissionTagConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuUm93TGV2ZWxQZXJtaXNzaW9uVGFnQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "rowLevelPermissionTagConfiguration") unless value.nil?
  jsii_set_property("rowLevelPermissionTagConfiguration", value)
end

#semantic_model_configurationAWSCDK::IResolvable, ...

The semantic model configuration associated with this dataset.



504
505
506
# File 'quick_sight/cfn_data_set.rb', line 504

def semantic_model_configuration()
  jsii_get_property("semanticModelConfiguration")
end

#semantic_model_configuration=(value) ⇒ Object



508
509
510
511
512
# File 'quick_sight/cfn_data_set.rb', line 508

def semantic_model_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSet::SemanticModelConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTZXQuU2VtYW50aWNNb2RlbENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "semanticModelConfiguration") unless value.nil?
  jsii_set_property("semanticModelConfiguration", value)
end

#should_synthesizeBoolean

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.



810
811
812
# File 'quick_sight/cfn_data_set.rb', line 810

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



142
143
144
# File 'quick_sight/cfn_data_set.rb', line 142

def stack()
  jsii_get_property("stack")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

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

Returns:



517
518
519
# File 'quick_sight/cfn_data_set.rb', line 517

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



521
522
523
524
525
# File 'quick_sight/cfn_data_set.rb', line 521

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_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



542
543
544
# File 'quick_sight/cfn_data_set.rb', line 542

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

#updated_properitesHash{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})


189
190
191
# File 'quick_sight/cfn_data_set.rb', line 189

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


199
200
201
# File 'quick_sight/cfn_data_set.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_asString?

The usage of the dataset.

Returns:

  • (String, nil)


530
531
532
# File 'quick_sight/cfn_data_set.rb', line 530

def use_as()
  jsii_get_property("useAs")
end

#use_as=(value) ⇒ Object



534
535
536
537
# File 'quick_sight/cfn_data_set.rb', line 534

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


816
817
818
819
# File 'quick_sight/cfn_data_set.rb', line 816

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)


555
556
557
558
559
560
# File 'quick_sight/cfn_data_set.rb', line 555

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