Class: AWSCDK::BCMDataExports::CfnExport

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSBcmdataexports::IExportRef
Defined in:
bcm_data_exports/cfn_export.rb

Overview

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations .

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query . To view the available tables and columns, see the Data Exports table dictionary .

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement . TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query . To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnExport

Create a new AWS::BCMDataExports::Export.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::BCMDataExports::CfnExportProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'bcm_data_exports/cfn_export.rb', line 24

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

Class Method Details

.arn_for_export(resource) ⇒ String

Parameters:

Returns:

  • (String) 


80
81
82
83
 
# File 'bcm_data_exports/cfn_export.rb', line 80

def self.arn_for_export(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iY21kYXRhZXhwb3J0cy5JRXhwb3J0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bcmdataexports.CfnExport", "arnForExport", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


187
188
189
 
# File 'bcm_data_exports/cfn_export.rb', line 187

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

.is_cfn_export(x) ⇒ Boolean

Checks whether the given object is a CfnExport.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'bcm_data_exports/cfn_export.rb', line 89

def self.is_cfn_export(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bcmdataexports.CfnExport", "isCfnExport", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'bcm_data_exports/cfn_export.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_export_arn => { kind: :property, name: "attrExportArn", is_optional: false },
    :attr_export_export_arn => { kind: :property, name: "attrExportExportArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :export_ref => { kind: :property, name: "exportRef", is_optional: false },
    :export => { kind: :property, name: "export", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



279
280
281
282
 
# File 'bcm_data_exports/cfn_export.rb', line 279

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:



291
292
293
294
 
# File 'bcm_data_exports/cfn_export.rb', line 291

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:



301
302
303
304
 
# File 'bcm_data_exports/cfn_export.rb', line 301

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:



312
313
314
315
316
 
# File 'bcm_data_exports/cfn_export.rb', line 312

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.


369
370
371
372
373
 
# File 'bcm_data_exports/cfn_export.rb', line 369

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.



379
380
381
382
 
# File 'bcm_data_exports/cfn_export.rb', line 379

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.



391
392
393
394
395
 
# File 'bcm_data_exports/cfn_export.rb', line 391

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:



404
405
406
407
 
# File 'bcm_data_exports/cfn_export.rb', line 404

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:



426
427
428
429
430
431
 
# File 'bcm_data_exports/cfn_export.rb', line 426

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

The Amazon Resource Name (ARN) for this export.

Returns:

  • (String) 


194
195
196
 
# File 'bcm_data_exports/cfn_export.rb', line 194

def attr_export_arn()
  jsii_get_property("attrExportArn")
end

#attr_export_export_arn ⇒ String

The Amazon Resource Name (ARN) for this export.

Returns:

  • (String) 


201
202
203
 
# File 'bcm_data_exports/cfn_export.rb', line 201

def attr_export_export_arn()
  jsii_get_property("attrExportExportArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



208
209
210
 
# File 'bcm_data_exports/cfn_export.rb', line 208

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



140
141
142
 
# File 'bcm_data_exports/cfn_export.rb', line 140

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


145
146
147
 
# File 'bcm_data_exports/cfn_export.rb', line 145

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


435
436
437
438
 
# File 'bcm_data_exports/cfn_export.rb', line 435

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


150
151
152
 
# File 'bcm_data_exports/cfn_export.rb', line 150

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


157
158
159
 
# File 'bcm_data_exports/cfn_export.rb', line 157

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


102
103
104
 
# File 'bcm_data_exports/cfn_export.rb', line 102

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



162
163
164
 
# File 'bcm_data_exports/cfn_export.rb', line 162

def env()
  jsii_get_property("env")
end

#export ⇒ AWSCDK::IResolvable, AWSCDK::BCMDataExports::CfnExport::ExportProperty

The details that are available for an export.

Returns:



222
223
224
 
# File 'bcm_data_exports/cfn_export.rb', line 222

def export()
  jsii_get_property("export")
end

#export=(value) ⇒ Object 



226
227
228
229
230
 
# File 'bcm_data_exports/cfn_export.rb', line 226

def export=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BCMDataExports::CfnExport::ExportProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iY21kYXRhZXhwb3J0cy5DZm5FeHBvcnQuRXhwb3J0UHJvcGVydHkifV19fQ==")), "export")
  jsii_set_property("export", value)
end

#export_ref ⇒ AWSCDK::Interfaces::AWSBcmdataexports::ExportReference

A reference to a Export resource.

Returns:



215
216
217
 
# File 'bcm_data_exports/cfn_export.rb', line 215

def export_ref()
  jsii_get_property("exportRef")
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:



448
449
450
451
452
 
# File 'bcm_data_exports/cfn_export.rb', line 448

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:



459
460
461
462
 
# File 'bcm_data_exports/cfn_export.rb', line 459

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:



529
530
531
532
 
# File 'bcm_data_exports/cfn_export.rb', line 529

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) 


114
115
116
 
# File 'bcm_data_exports/cfn_export.rb', line 114

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


97
98
99
 
# File 'bcm_data_exports/cfn_export.rb', line 97

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:



470
471
472
 
# File 'bcm_data_exports/cfn_export.rb', line 470

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:



477
478
479
 
# File 'bcm_data_exports/cfn_export.rb', line 477

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.



270
271
272
273
 
# File 'bcm_data_exports/cfn_export.rb', line 270

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

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


133
134
135
 
# File 'bcm_data_exports/cfn_export.rb', line 133

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:



488
489
490
491
 
# File 'bcm_data_exports/cfn_export.rb', line 488

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


495
496
497
498
 
# File 'bcm_data_exports/cfn_export.rb', line 495

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:



505
506
507
508
509
 
# File 'bcm_data_exports/cfn_export.rb', line 505

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.



514
515
516
 
# File 'bcm_data_exports/cfn_export.rb', line 514

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:



123
124
125
 
# File 'bcm_data_exports/cfn_export.rb', line 123

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::BCMDataExports::CfnExport::ResourceTagProperty>?

Returns:



233
234
235
 
# File 'bcm_data_exports/cfn_export.rb', line 233

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



237
238
239
240
241
 
# File 'bcm_data_exports/cfn_export.rb', line 237

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



246
247
248
 
# File 'bcm_data_exports/cfn_export.rb', line 246

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'bcm_data_exports/cfn_export.rb', line 170

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


180
181
182
 
# File 'bcm_data_exports/cfn_export.rb', line 180

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


520
521
522
523
 
# File 'bcm_data_exports/cfn_export.rb', line 520

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) 


259
260
261
262
263
264
 
# File 'bcm_data_exports/cfn_export.rb', line 259

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