Class: AWSCDK::DataZone::CfnConnection

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

Overview

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConnection

Create a new AWS::DataZone::Connection.

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

    Resource properties.



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

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


185
186
187
 
# File 'data_zone/cfn_connection.rb', line 185

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

.is_cfn_connection(x) ⇒ Boolean

Checks whether the given object is a CfnConnection.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


87
88
89
90
 
# File 'data_zone/cfn_connection.rb', line 87

def self.is_cfn_connection(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnConnection", "isCfnConnection", [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
 
# File 'data_zone/cfn_connection.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_domain_id => { kind: :property, name: "attrDomainId", is_optional: false },
    :attr_domain_unit_id => { kind: :property, name: "attrDomainUnitId", is_optional: false },
    :attr_environment_id => { kind: :property, name: "attrEnvironmentId", is_optional: false },
    :attr_environment_user_role => { kind: :property, name: "attrEnvironmentUserRole", is_optional: false },
    :attr_project_id => { kind: :property, name: "attrProjectId", is_optional: false },
    :attr_type => { kind: :property, name: "attrType", is_optional: false },
    :connection_ref => { kind: :property, name: "connectionRef", is_optional: false },
    :domain_identifier => { kind: :property, name: "domainIdentifier", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :aws_location => { kind: :property, name: "awsLocation", is_optional: true },
    :configurations => { kind: :property, name: "configurations", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_trusted_identity_propagation => { kind: :property, name: "enableTrustedIdentityPropagation", is_optional: true },
    :environment_identifier => { kind: :property, name: "environmentIdentifier", is_optional: true },
    :project_identifier => { kind: :property, name: "projectIdentifier", is_optional: true },
    :props => { kind: :property, name: "props", is_optional: true },
    :scope => { kind: :property, name: "scope", 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.



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

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:



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

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:



425
426
427
428
 
# File 'data_zone/cfn_connection.rb', line 425

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:



436
437
438
439
440
 
# File 'data_zone/cfn_connection.rb', line 436

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.


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

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.



503
504
505
506
 
# File 'data_zone/cfn_connection.rb', line 503

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.



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

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:



528
529
530
531
 
# File 'data_zone/cfn_connection.rb', line 528

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:



550
551
552
553
554
555
 
# File 'data_zone/cfn_connection.rb', line 550

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

The ID of the connection.

Returns:

  • (String) 


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

def attr_connection_id()
  jsii_get_property("attrConnectionId")
end

#attr_domain_id ⇒ String

The domain ID of the connection.

Returns:

  • (String) 


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

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_domain_unit_id ⇒ String

The domain unit ID of the connection.

Returns:

  • (String) 


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

def attr_domain_unit_id()
  jsii_get_property("attrDomainUnitId")
end

#attr_environment_id ⇒ String

The ID of the environment.

Returns:

  • (String) 


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

def attr_environment_id()
  jsii_get_property("attrEnvironmentId")
end

#attr_environment_user_role ⇒ String

The environment user role.

Returns:

  • (String) 


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

def attr_environment_user_role()
  jsii_get_property("attrEnvironmentUserRole")
end

#attr_project_id ⇒ String

The ID of the project.

Returns:

  • (String) 


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

def attr_project_id()
  jsii_get_property("attrProjectId")
end

#attr_type ⇒ String

The type of the connection.

Returns:

  • (String) 


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

def attr_type()
  jsii_get_property("attrType")
end

#aws_location ⇒ AWSCDK::IResolvable, ...

The location where the connection is created.

Returns:



272
273
274
 
# File 'data_zone/cfn_connection.rb', line 272

def aws_location()
  jsii_get_property("awsLocation")
end

#aws_location=(value) ⇒ Object 



276
277
278
279
280
 
# File 'data_zone/cfn_connection.rb', line 276

def aws_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataZone::CfnConnection::AWSLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhem9uZS5DZm5Db25uZWN0aW9uLkF3c0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "awsLocation") unless value.nil?
  jsii_set_property("awsLocation", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



138
139
140
 
# File 'data_zone/cfn_connection.rb', line 138

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


143
144
145
 
# File 'data_zone/cfn_connection.rb', line 143

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


559
560
561
562
 
# File 'data_zone/cfn_connection.rb', line 559

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


148
149
150
 
# File 'data_zone/cfn_connection.rb', line 148

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


155
156
157
 
# File 'data_zone/cfn_connection.rb', line 155

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configurations ⇒ AWSCDK::IResolvable, ...

The configurations of the connection.

Returns:



285
286
287
 
# File 'data_zone/cfn_connection.rb', line 285

def configurations()
  jsii_get_property("configurations")
end

#configurations=(value) ⇒ Object 



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

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

#connection_ref ⇒ AWSCDK::Interfaces::AWSDatazone::ConnectionReference

A reference to a Connection resource.

Returns:



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

def connection_ref()
  jsii_get_property("connectionRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


100
101
102
 
# File 'data_zone/cfn_connection.rb', line 100

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

Connection description.

Returns:

  • (String, nil) 


297
298
299
 
# File 'data_zone/cfn_connection.rb', line 297

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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 domain where the connection is created.

Returns:

  • (String) 


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

def domain_identifier()
  jsii_get_property("domainIdentifier")
end

#domain_identifier=(value) ⇒ Object 



252
253
254
255
 
# File 'data_zone/cfn_connection.rb', line 252

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

#enable_trusted_identity_propagation ⇒ Boolean, ...

Specifies whether the trusted identity propagation is enabled.

Returns:



309
310
311
 
# File 'data_zone/cfn_connection.rb', line 309

def enable_trusted_identity_propagation()
  jsii_get_property("enableTrustedIdentityPropagation")
end

#enable_trusted_identity_propagation=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



160
161
162
 
# File 'data_zone/cfn_connection.rb', line 160

def env()
  jsii_get_property("env")
end

#environment_identifier ⇒ String?

The ID of the environment where the connection is created.

Returns:

  • (String, nil) 


321
322
323
 
# File 'data_zone/cfn_connection.rb', line 321

def environment_identifier()
  jsii_get_property("environmentIdentifier")
end

#environment_identifier=(value) ⇒ Object 



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

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:



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

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:



583
584
585
586
 
# File 'data_zone/cfn_connection.rb', line 583

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:



653
654
655
656
 
# File 'data_zone/cfn_connection.rb', line 653

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) 


112
113
114
 
# File 'data_zone/cfn_connection.rb', line 112

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the connection.

Returns:

  • (String) 


260
261
262
 
# File 'data_zone/cfn_connection.rb', line 260

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



264
265
266
267
 
# File 'data_zone/cfn_connection.rb', line 264

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) 


95
96
97
 
# File 'data_zone/cfn_connection.rb', line 95

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:



594
595
596
 
# File 'data_zone/cfn_connection.rb', line 594

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:



601
602
603
 
# File 'data_zone/cfn_connection.rb', line 601

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.



394
395
396
397
 
# File 'data_zone/cfn_connection.rb', line 394

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 project in which the connection should be created.

Returns:

  • (String, nil) 


333
334
335
 
# File 'data_zone/cfn_connection.rb', line 333

def project_identifier()
  jsii_get_property("projectIdentifier")
end

#project_identifier=(value) ⇒ Object 



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

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

#props ⇒ AWSCDK::IResolvable, ...

Connection props.

Returns:



345
346
347
 
# File 'data_zone/cfn_connection.rb', line 345

def props()
  jsii_get_property("props")
end

#props=(value) ⇒ Object 



349
350
351
352
353
 
# File 'data_zone/cfn_connection.rb', line 349

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


131
132
133
 
# File 'data_zone/cfn_connection.rb', line 131

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:



612
613
614
615
 
# File 'data_zone/cfn_connection.rb', line 612

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


619
620
621
622
 
# File 'data_zone/cfn_connection.rb', line 619

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:



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

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

#scope ⇒ String?

The scope of the connection.

Returns:

  • (String, nil) 


358
359
360
 
# File 'data_zone/cfn_connection.rb', line 358

def scope()
  jsii_get_property("scope")
end

#scope=(value) ⇒ Object 



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

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



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

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:



121
122
123
 
# File 'data_zone/cfn_connection.rb', line 121

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



370
371
372
 
# File 'data_zone/cfn_connection.rb', line 370

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


168
169
170
 
# File 'data_zone/cfn_connection.rb', line 168

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


178
179
180
 
# File 'data_zone/cfn_connection.rb', line 178

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


644
645
646
647
 
# File 'data_zone/cfn_connection.rb', line 644

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) 


383
384
385
386
387
388
 
# File 'data_zone/cfn_connection.rb', line 383

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