Class: AWSCDK::DataZone::CfnDataSource

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSDatazone::IDataSourceRef
Defined in:
data_zone/cfn_data_source.rb

Overview

The AWS::DataZone::DataSource resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDataSource

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

    Resource properties.



17
18
19
20
21
22
23
 
# File 'data_zone/cfn_data_source.rb', line 17

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


92
93
94
95
 
# File 'data_zone/cfn_data_source.rb', line 92

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'data_zone/cfn_data_source.rb', line 199

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


101
102
103
104
 
# File 'data_zone/cfn_data_source.rb', line 101

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

.jsii_overridable_methods ⇒ Object 



25
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
84
85
86
87
88
 
# File 'data_zone/cfn_data_source.rb', line 25

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_connection_id => { kind: :property, name: "attrConnectionId", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_domain_id => { kind: :property, name: "attrDomainId", is_optional: false },
    :attr_environment_id => { kind: :property, name: "attrEnvironmentId", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_last_run_asset_count => { kind: :property, name: "attrLastRunAssetCount", is_optional: false },
    :attr_last_run_at => { kind: :property, name: "attrLastRunAt", is_optional: false },
    :attr_last_run_status => { kind: :property, name: "attrLastRunStatus", is_optional: false },
    :attr_project_id => { kind: :property, name: "attrProjectId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :data_source_ref => { kind: :property, name: "dataSourceRef", is_optional: false },
    :domain_identifier => { kind: :property, name: "domainIdentifier", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :project_identifier => { kind: :property, name: "projectIdentifier", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :asset_forms_input => { kind: :property, name: "assetFormsInput", is_optional: true },
    :configuration => { kind: :property, name: "configuration", is_optional: true },
    :connection_identifier => { kind: :property, name: "connectionIdentifier", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_setting => { kind: :property, name: "enableSetting", is_optional: true },
    :environment_identifier => { kind: :property, name: "environmentIdentifier", is_optional: true },
    :publish_on_import => { kind: :property, name: "publishOnImport", is_optional: true },
    :recommendation => { kind: :property, name: "recommendation", is_optional: true },
    :schedule => { kind: :property, name: "schedule", 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.



482
483
484
485
 
# File 'data_zone/cfn_data_source.rb', line 482

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:



494
495
496
497
 
# File 'data_zone/cfn_data_source.rb', line 494

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:



504
505
506
507
 
# File 'data_zone/cfn_data_source.rb', line 504

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:



515
516
517
518
519
 
# File 'data_zone/cfn_data_source.rb', line 515

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.


572
573
574
575
576
 
# File 'data_zone/cfn_data_source.rb', line 572

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.



582
583
584
585
 
# File 'data_zone/cfn_data_source.rb', line 582

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.



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

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:



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

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:



629
630
631
632
633
634
 
# File 'data_zone/cfn_data_source.rb', line 629

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

#asset_forms_input ⇒ AWSCDK::IResolvable, ...

The metadata forms attached to the assets that the data source works with.

Returns:



338
339
340
 
# File 'data_zone/cfn_data_source.rb', line 338

def asset_forms_input()
  jsii_get_property("assetFormsInput")
end

#asset_forms_input=(value) ⇒ Object 



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

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

#attr_connection_id ⇒ String

The connection ID that's part of the data source summary.

Returns:

  • (String) 


206
207
208
 
# File 'data_zone/cfn_data_source.rb', line 206

def attr_connection_id()
  jsii_get_property("attrConnectionId")
end

#attr_created_at ⇒ String

The timestamp of when the data source was created.

Returns:

  • (String) 


213
214
215
 
# File 'data_zone/cfn_data_source.rb', line 213

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_domain_id ⇒ String

The ID of the Amazon DataZone domain in which the data source exists.

Returns:

  • (String) 


220
221
222
 
# File 'data_zone/cfn_data_source.rb', line 220

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_environment_id ⇒ String

The ID of the environment in which the data source exists.

Returns:

  • (String) 


227
228
229
 
# File 'data_zone/cfn_data_source.rb', line 227

def attr_environment_id()
  jsii_get_property("attrEnvironmentId")
end

#attr_id ⇒ String

The identifier of the data source run.

Returns:

  • (String) 


234
235
236
 
# File 'data_zone/cfn_data_source.rb', line 234

def attr_id()
  jsii_get_property("attrId")
end

#attr_last_run_asset_count ⇒ AWSCDK::IResolvable

The count of the assets created during the last data source run.

Returns:



241
242
243
 
# File 'data_zone/cfn_data_source.rb', line 241

def attr_last_run_asset_count()
  jsii_get_property("attrLastRunAssetCount")
end

#attr_last_run_at ⇒ String

The timestamp of when the data source run was last performed.

Returns:

  • (String) 


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

def attr_last_run_at()
  jsii_get_property("attrLastRunAt")
end

#attr_last_run_status ⇒ String

The status of the last data source run.

Returns:

  • (String) 


255
256
257
 
# File 'data_zone/cfn_data_source.rb', line 255

def attr_last_run_status()
  jsii_get_property("attrLastRunStatus")
end

#attr_project_id ⇒ String

The project ID included in the data source run activity.

Returns:

  • (String) 


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

def attr_project_id()
  jsii_get_property("attrProjectId")
end

#attr_status ⇒ String

The status of the data source.

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The timestamp of when the data source was updated.

Returns:

  • (String) 


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

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


638
639
640
641
 
# File 'data_zone/cfn_data_source.rb', line 638

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


162
163
164
 
# File 'data_zone/cfn_data_source.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration ⇒ AWSCDK::IResolvable, ...

The configuration of the data source.

Returns:



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

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



354
355
356
357
358
 
# File 'data_zone/cfn_data_source.rb', line 354

def configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataZone::CfnDataSource::DataSourceConfigurationInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhem9uZS5DZm5EYXRhU291cmNlLkRhdGFTb3VyY2VDb25maWd1cmF0aW9uSW5wdXRQcm9wZXJ0eSJ9XX19")), "configuration") unless value.nil?
  jsii_set_property("configuration", value)
end

#connection_identifier ⇒ String?

The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.

Returns:

  • (String, nil) 


363
364
365
 
# File 'data_zone/cfn_data_source.rb', line 363

def connection_identifier()
  jsii_get_property("connectionIdentifier")
end

#connection_identifier=(value) ⇒ Object 



367
368
369
370
 
# File 'data_zone/cfn_data_source.rb', line 367

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'data_zone/cfn_data_source.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#data_source_ref ⇒ AWSCDK::Interfaces::AWSDatazone::DataSourceReference

A reference to a DataSource resource.

Returns:



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

def data_source_ref()
  jsii_get_property("dataSourceRef")
end

#description ⇒ String?

The description of the data source.

Returns:

  • (String, nil) 


375
376
377
 
# File 'data_zone/cfn_data_source.rb', line 375

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#domain_identifier ⇒ String

The ID of the Amazon DataZone domain where the data source is created.

Returns:

  • (String) 


290
291
292
 
# File 'data_zone/cfn_data_source.rb', line 290

def domain_identifier()
  jsii_get_property("domainIdentifier")
end

#domain_identifier=(value) ⇒ Object 



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

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

#enable_setting ⇒ String?

Specifies whether the data source is enabled.

Returns:

  • (String, nil) 


387
388
389
 
# File 'data_zone/cfn_data_source.rb', line 387

def enable_setting()
  jsii_get_property("enableSetting")
end

#enable_setting=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'data_zone/cfn_data_source.rb', line 174

def env()
  jsii_get_property("env")
end

#environment_identifier ⇒ String?

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

Returns:

  • (String, nil) 


399
400
401
 
# File 'data_zone/cfn_data_source.rb', line 399

def environment_identifier()
  jsii_get_property("environmentIdentifier")
end

#environment_identifier=(value) ⇒ Object 



403
404
405
406
 
# File 'data_zone/cfn_data_source.rb', line 403

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



651
652
653
654
655
 
# File 'data_zone/cfn_data_source.rb', line 651

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:



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

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:



732
733
734
735
 
# File 'data_zone/cfn_data_source.rb', line 732

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) 


126
127
128
 
# File 'data_zone/cfn_data_source.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the data source.

Returns:

  • (String) 


302
303
304
 
# File 'data_zone/cfn_data_source.rb', line 302

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


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

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:



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

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:



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

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.



473
474
475
476
 
# File 'data_zone/cfn_data_source.rb', line 473

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

#project_identifier ⇒ String

The identifier of the Amazon DataZone project in which you want to add this data source.

Returns:

  • (String) 


314
315
316
 
# File 'data_zone/cfn_data_source.rb', line 314

def project_identifier()
  jsii_get_property("projectIdentifier")
end

#project_identifier=(value) ⇒ Object 



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

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

#publish_on_import ⇒ Boolean, ...

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

Returns:



411
412
413
 
# File 'data_zone/cfn_data_source.rb', line 411

def publish_on_import()
  jsii_get_property("publishOnImport")
end

#publish_on_import=(value) ⇒ Object 



415
416
417
418
 
# File 'data_zone/cfn_data_source.rb', line 415

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

#recommendation ⇒ AWSCDK::IResolvable, ...

Specifies whether the business name generation is to be enabled for this data source.

Returns:



423
424
425
 
# File 'data_zone/cfn_data_source.rb', line 423

def recommendation()
  jsii_get_property("recommendation")
end

#recommendation=(value) ⇒ Object 



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

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


145
146
147
 
# File 'data_zone/cfn_data_source.rb', line 145

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:



691
692
693
694
 
# File 'data_zone/cfn_data_source.rb', line 691

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


698
699
700
701
 
# File 'data_zone/cfn_data_source.rb', line 698

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:



708
709
710
711
712
 
# File 'data_zone/cfn_data_source.rb', line 708

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

#schedule ⇒ AWSCDK::IResolvable, ...

The schedule of the data source runs.

Returns:



436
437
438
 
# File 'data_zone/cfn_data_source.rb', line 436

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



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

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



717
718
719
 
# File 'data_zone/cfn_data_source.rb', line 717

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:



135
136
137
 
# File 'data_zone/cfn_data_source.rb', line 135

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



449
450
451
 
# File 'data_zone/cfn_data_source.rb', line 449

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

#type ⇒ String

The type of the data source.

Returns:

  • (String) 


326
327
328
 
# File 'data_zone/cfn_data_source.rb', line 326

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



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

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


182
183
184
 
# File 'data_zone/cfn_data_source.rb', line 182

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


192
193
194
 
# File 'data_zone/cfn_data_source.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


723
724
725
726
 
# File 'data_zone/cfn_data_source.rb', line 723

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) 


462
463
464
465
466
467
 
# File 'data_zone/cfn_data_source.rb', line 462

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