Class: AWSCDK::DataZone::CfnSubscriptionTarget

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

Overview

The AWS::DataZone::SubscriptionTarget resource specifies an Amazon DataZone subscription target.

Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSubscriptionTarget

Create a new AWS::DataZone::SubscriptionTarget.

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

    Resource properties.



19
20
21
22
23
24
25
 
# File 'data_zone/cfn_subscription_target.rb', line 19

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


187
188
189
 
# File 'data_zone/cfn_subscription_target.rb', line 187

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

.is_cfn_subscription_target(x) ⇒ Boolean

Checks whether the given object is a CfnSubscriptionTarget.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'data_zone/cfn_subscription_target.rb', line 89

def self.is_cfn_subscription_target(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnSubscriptionTarget", "isCfnSubscriptionTarget", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'data_zone/cfn_subscription_target.rb', line 27

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_created_by => { kind: :property, name: "attrCreatedBy", 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_project_id => { kind: :property, name: "attrProjectId", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_updated_by => { kind: :property, name: "attrUpdatedBy", is_optional: false },
    :subscription_target_ref => { kind: :property, name: "subscriptionTargetRef", is_optional: false },
    :applicable_asset_types => { kind: :property, name: "applicableAssetTypes", is_optional: false },
    :authorized_principals => { kind: :property, name: "authorizedPrincipals", is_optional: false },
    :domain_identifier => { kind: :property, name: "domainIdentifier", is_optional: false },
    :environment_identifier => { kind: :property, name: "environmentIdentifier", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :subscription_target_config => { kind: :property, name: "subscriptionTargetConfig", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :manage_access_role => { kind: :property, name: "manageAccessRole", is_optional: true },
    :provider => { kind: :property, name: "provider", 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.



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

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:



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

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:



420
421
422
423
 
# File 'data_zone/cfn_subscription_target.rb', line 420

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:



431
432
433
434
435
 
# File 'data_zone/cfn_subscription_target.rb', line 431

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.


488
489
490
491
492
 
# File 'data_zone/cfn_subscription_target.rb', line 488

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.



498
499
500
501
 
# File 'data_zone/cfn_subscription_target.rb', line 498

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.



510
511
512
513
514
 
# File 'data_zone/cfn_subscription_target.rb', line 510

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

#applicable_asset_types ⇒ Array<String>

The asset types included in the subscription target.

Returns:

  • (Array<String>) 


257
258
259
 
# File 'data_zone/cfn_subscription_target.rb', line 257

def applicable_asset_types()
  jsii_get_property("applicableAssetTypes")
end

#applicable_asset_types=(value) ⇒ Object 



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

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



523
524
525
526
 
# File 'data_zone/cfn_subscription_target.rb', line 523

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:



545
546
547
548
549
550
 
# File 'data_zone/cfn_subscription_target.rb', line 545

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

The timestamp of when the subscription target was created.

Returns:

  • (String) 


194
195
196
 
# File 'data_zone/cfn_subscription_target.rb', line 194

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_created_by ⇒ String

The Amazon DataZone user who created the subscription target.

Returns:

  • (String) 


201
202
203
 
# File 'data_zone/cfn_subscription_target.rb', line 201

def attr_created_by()
  jsii_get_property("attrCreatedBy")
end

#attr_domain_id ⇒ String

The identifier of the Amazon DataZone domain in which the subscription target exists.

Returns:

  • (String) 


208
209
210
 
# File 'data_zone/cfn_subscription_target.rb', line 208

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_environment_id ⇒ String

The identifier of the environment of the subscription target.

Returns:

  • (String) 


215
216
217
 
# File 'data_zone/cfn_subscription_target.rb', line 215

def attr_environment_id()
  jsii_get_property("attrEnvironmentId")
end

#attr_id ⇒ String

The identifier of the subscription target.

Returns:

  • (String) 


222
223
224
 
# File 'data_zone/cfn_subscription_target.rb', line 222

def attr_id()
  jsii_get_property("attrId")
end

#attr_project_id ⇒ String

The identifier of the project specified in the subscription target.

Returns:

  • (String) 


229
230
231
 
# File 'data_zone/cfn_subscription_target.rb', line 229

def attr_project_id()
  jsii_get_property("attrProjectId")
end

#attr_updated_at ⇒ String

The timestamp of when the subscription target was updated.

Returns:

  • (String) 


236
237
238
 
# File 'data_zone/cfn_subscription_target.rb', line 236

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_updated_by ⇒ String

The Amazon DataZone user who updated the subscription target.

Returns:

  • (String) 


243
244
245
 
# File 'data_zone/cfn_subscription_target.rb', line 243

def attr_updated_by()
  jsii_get_property("attrUpdatedBy")
end

#authorized_principals ⇒ Array<String>

The authorized principals included in the subscription target.

Returns:

  • (Array<String>) 


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

def authorized_principals()
  jsii_get_property("authorizedPrincipals")
end

#authorized_principals=(value) ⇒ Object 



273
274
275
276
 
# File 'data_zone/cfn_subscription_target.rb', line 273

def authorized_principals=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "authorizedPrincipals")
  jsii_set_property("authorizedPrincipals", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



140
141
142
 
# File 'data_zone/cfn_subscription_target.rb', line 140

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


145
146
147
 
# File 'data_zone/cfn_subscription_target.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) 


554
555
556
557
 
# File 'data_zone/cfn_subscription_target.rb', line 554

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 'data_zone/cfn_subscription_target.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 'data_zone/cfn_subscription_target.rb', line 157

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_identifier ⇒ String

The ID of the Amazon DataZone domain in which subscription target is created.

Returns:

  • (String) 


281
282
283
 
# File 'data_zone/cfn_subscription_target.rb', line 281

def domain_identifier()
  jsii_get_property("domainIdentifier")
end

#domain_identifier=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#environment_identifier ⇒ String

The ID of the environment in which subscription target is created.

Returns:

  • (String) 


293
294
295
 
# File 'data_zone/cfn_subscription_target.rb', line 293

def environment_identifier()
  jsii_get_property("environmentIdentifier")
end

#environment_identifier=(value) ⇒ Object 



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

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



567
568
569
570
571
 
# File 'data_zone/cfn_subscription_target.rb', line 567

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:



578
579
580
581
 
# File 'data_zone/cfn_subscription_target.rb', line 578

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:



648
649
650
651
 
# File 'data_zone/cfn_subscription_target.rb', line 648

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 'data_zone/cfn_subscription_target.rb', line 114

def logical_id()
  jsii_get_property("logicalId")
end

#manage_access_role ⇒ String?

The manage access role that is used to create the subscription target.

Returns:

  • (String, nil) 


341
342
343
 
# File 'data_zone/cfn_subscription_target.rb', line 341

def manage_access_role()
  jsii_get_property("manageAccessRole")
end

#manage_access_role=(value) ⇒ Object 



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

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

#name ⇒ String

The name of the subscription target.

Returns:

  • (String) 


305
306
307
 
# File 'data_zone/cfn_subscription_target.rb', line 305

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


97
98
99
 
# File 'data_zone/cfn_subscription_target.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:



589
590
591
 
# File 'data_zone/cfn_subscription_target.rb', line 589

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:



596
597
598
 
# File 'data_zone/cfn_subscription_target.rb', line 596

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.



389
390
391
392
 
# File 'data_zone/cfn_subscription_target.rb', line 389

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

#provider ⇒ String?

The provider of the subscription target.

Returns:

  • (String, nil) 


353
354
355
 
# File 'data_zone/cfn_subscription_target.rb', line 353

def provider()
  jsii_get_property("provider")
end

#provider=(value) ⇒ Object 



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

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


133
134
135
 
# File 'data_zone/cfn_subscription_target.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:



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

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


614
615
616
617
 
# File 'data_zone/cfn_subscription_target.rb', line 614

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:



624
625
626
627
628
 
# File 'data_zone/cfn_subscription_target.rb', line 624

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.



633
634
635
 
# File 'data_zone/cfn_subscription_target.rb', line 633

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 'data_zone/cfn_subscription_target.rb', line 123

def stack()
  jsii_get_property("stack")
end

#subscription_target_config ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DataZone::CfnSubscriptionTarget::SubscriptionTargetFormProperty>

The configuration of the subscription target.

Returns:



317
318
319
 
# File 'data_zone/cfn_subscription_target.rb', line 317

def subscription_target_config()
  jsii_get_property("subscriptionTargetConfig")
end

#subscription_target_config=(value) ⇒ Object 



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

def subscription_target_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXpvbmUuQ2ZuU3Vic2NyaXB0aW9uVGFyZ2V0LlN1YnNjcmlwdGlvblRhcmdldEZvcm1Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "subscriptionTargetConfig")
  jsii_set_property("subscriptionTargetConfig", value)
end

#subscription_target_ref ⇒ AWSCDK::Interfaces::AWSDatazone::SubscriptionTargetReference

A reference to a SubscriptionTarget resource.

Returns:



250
251
252
 
# File 'data_zone/cfn_subscription_target.rb', line 250

def subscription_target_ref()
  jsii_get_property("subscriptionTargetRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



365
366
367
 
# File 'data_zone/cfn_subscription_target.rb', line 365

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

#type ⇒ String

The type of the subscription target.

Returns:

  • (String) 


329
330
331
 
# File 'data_zone/cfn_subscription_target.rb', line 329

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



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

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


170
171
172
 
# File 'data_zone/cfn_subscription_target.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 'data_zone/cfn_subscription_target.rb', line 180

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


639
640
641
642
 
# File 'data_zone/cfn_subscription_target.rb', line 639

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) 


378
379
380
381
382
383
 
# File 'data_zone/cfn_subscription_target.rb', line 378

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