Class: AWSCDK::DataZone::CfnDomain

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSDatazone::IDomainRef
Defined in:
data_zone/cfn_domain.rb

Overview

The AWS::DataZone::Domain resource specifies an Amazon DataZone domain.

You can use domains to organize your assets, users, and their projects.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDomain

Create a new AWS::DataZone::Domain.

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

    Resource properties.



20
21
22
23
24
25
26
 
# File 'data_zone/cfn_domain.rb', line 20

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

Class Method Details

.arn_for_domain(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'data_zone/cfn_domain.rb', line 88

def self.arn_for_domain(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kYXRhem9uZS5JRG9tYWluUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnDomain", "arnForDomain", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


221
222
223
 
# File 'data_zone/cfn_domain.rb', line 221

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

.from_domain_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSDatazone::IDomainRef

Creates a new IDomainRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



99
100
101
102
103
104
 
# File 'data_zone/cfn_domain.rb', line 99

def self.from_domain_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnDomain", "fromDomainArn", [scope, id, arn])
end

.from_domain_id(scope, id, domain_id) ⇒ AWSCDK::Interfaces::AWSDatazone::IDomainRef

Creates a new IDomainRef from a domainId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • domain_id (String)

Returns:



112
113
114
115
116
117
 
# File 'data_zone/cfn_domain.rb', line 112

def self.from_domain_id(scope, id, domain_id)
  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(domain_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnDomain", "fromDomainId", [scope, id, domain_id])
end

.is_cfn_domain(x) ⇒ Boolean

Checks whether the given object is a CfnDomain.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


123
124
125
126
 
# File 'data_zone/cfn_domain.rb', line 123

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

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_last_updated_at => { kind: :property, name: "attrLastUpdatedAt", is_optional: false },
    :attr_managed_account_id => { kind: :property, name: "attrManagedAccountId", is_optional: false },
    :attr_portal_url => { kind: :property, name: "attrPortalUrl", is_optional: false },
    :attr_root_domain_unit_id => { kind: :property, name: "attrRootDomainUnitId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :domain_execution_role => { kind: :property, name: "domainExecutionRole", is_optional: true },
    :domain_version => { kind: :property, name: "domainVersion", is_optional: true },
    :kms_key_identifier => { kind: :property, name: "kmsKeyIdentifier", is_optional: true },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :single_sign_on => { kind: :property, name: "singleSignOn", is_optional: true },
    :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.



429
430
431
432
 
# File 'data_zone/cfn_domain.rb', line 429

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:



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

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:



451
452
453
454
 
# File 'data_zone/cfn_domain.rb', line 451

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:



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

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.


519
520
521
522
523
 
# File 'data_zone/cfn_domain.rb', line 519

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.



529
530
531
532
 
# File 'data_zone/cfn_domain.rb', line 529

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.



541
542
543
544
545
 
# File 'data_zone/cfn_domain.rb', line 541

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:



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

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:



576
577
578
579
580
581
 
# File 'data_zone/cfn_domain.rb', line 576

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

The ARN of the Amazon DataZone domain.

Returns:

  • (String) 


228
229
230
 
# File 'data_zone/cfn_domain.rb', line 228

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

A timestamp of when a Amazon DataZone domain was created.

Returns:

  • (String) 


235
236
237
 
# File 'data_zone/cfn_domain.rb', line 235

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_id ⇒ String

The ID of the Amazon DataZone domain.

Returns:

  • (String) 


242
243
244
 
# File 'data_zone/cfn_domain.rb', line 242

def attr_id()
  jsii_get_property("attrId")
end

#attr_last_updated_at ⇒ String

A timestamp of when a Amazon DataZone domain was last updated.

Returns:

  • (String) 


249
250
251
 
# File 'data_zone/cfn_domain.rb', line 249

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_managed_account_id ⇒ String

The identifier of the AWS account that manages the domain.

Returns:

  • (String) 


256
257
258
 
# File 'data_zone/cfn_domain.rb', line 256

def ()
  jsii_get_property("attrManagedAccountId")
end

#attr_portal_url ⇒ String

The data portal URL for the Amazon DataZone domain.

Returns:

  • (String) 


263
264
265
 
# File 'data_zone/cfn_domain.rb', line 263

def attr_portal_url()
  jsii_get_property("attrPortalUrl")
end

#attr_root_domain_unit_id ⇒ String

The ID of the root domain unit.

Returns:

  • (String) 


270
271
272
 
# File 'data_zone/cfn_domain.rb', line 270

def attr_root_domain_unit_id()
  jsii_get_property("attrRootDomainUnitId")
end

#attr_status ⇒ String

The status of the Amazon DataZone domain.

Returns:

  • (String) 


277
278
279
 
# File 'data_zone/cfn_domain.rb', line 277

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



284
285
286
 
# File 'data_zone/cfn_domain.rb', line 284

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'data_zone/cfn_domain.rb', line 179

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


585
586
587
588
 
# File 'data_zone/cfn_domain.rb', line 585

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


184
185
186
 
# File 'data_zone/cfn_domain.rb', line 184

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


191
192
193
 
# File 'data_zone/cfn_domain.rb', line 191

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


136
137
138
 
# File 'data_zone/cfn_domain.rb', line 136

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the Amazon DataZone domain.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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_execution_role ⇒ String?

The domain execution role that is created when an Amazon DataZone domain is created.

Returns:

  • (String, nil) 


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

def domain_execution_role()
  jsii_get_property("domainExecutionRole")
end

#domain_execution_role=(value) ⇒ Object 



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

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

#domain_ref ⇒ AWSCDK::Interfaces::AWSDatazone::DomainReference

A reference to a Domain resource.

Returns:



291
292
293
 
# File 'data_zone/cfn_domain.rb', line 291

def domain_ref()
  jsii_get_property("domainRef")
end

#domain_version ⇒ String?

The domain version.

Returns:

  • (String, nil) 


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

def domain_version()
  jsii_get_property("domainVersion")
end

#domain_version=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



196
197
198
 
# File 'data_zone/cfn_domain.rb', line 196

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



598
599
600
601
602
 
# File 'data_zone/cfn_domain.rb', line 598

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:



609
610
611
612
 
# File 'data_zone/cfn_domain.rb', line 609

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:



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

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

#kms_key_identifier ⇒ String?

The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

Returns:

  • (String, nil) 


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

def kms_key_identifier()
  jsii_get_property("kmsKeyIdentifier")
end

#kms_key_identifier=(value) ⇒ Object 



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

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


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

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the Amazon DataZone domain.

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


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

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:



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

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:



627
628
629
 
# File 'data_zone/cfn_domain.rb', line 627

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.



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

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) 


167
168
169
 
# File 'data_zone/cfn_domain.rb', line 167

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:



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

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


645
646
647
648
 
# File 'data_zone/cfn_domain.rb', line 645

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:



655
656
657
658
659
 
# File 'data_zone/cfn_domain.rb', line 655

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

#service_role ⇒ String?

The service role of the domain.

Returns:

  • (String, nil) 


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

def service_role()
  jsii_get_property("serviceRole")
end

#service_role=(value) ⇒ Object 



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

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



664
665
666
 
# File 'data_zone/cfn_domain.rb', line 664

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

#single_sign_on ⇒ AWSCDK::IResolvable, ...

The single sign-on details in Amazon DataZone.

Returns:



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

def single_sign_on()
  jsii_get_property("singleSignOn")
end

#single_sign_on=(value) ⇒ Object 



374
375
376
377
378
 
# File 'data_zone/cfn_domain.rb', line 374

def single_sign_on=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataZone::CfnDomain::SingleSignOnProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhem9uZS5DZm5Eb21haW4uU2luZ2xlU2lnbk9uUHJvcGVydHkifV19fQ==")), "singleSignOn") unless value.nil?
  jsii_set_property("singleSignOn", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags specified for the Amazon DataZone domain.

Returns:



383
384
385
 
# File 'data_zone/cfn_domain.rb', line 383

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



387
388
389
390
391
 
# File 'data_zone/cfn_domain.rb', line 387

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "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



396
397
398
 
# File 'data_zone/cfn_domain.rb', line 396

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


204
205
206
 
# File 'data_zone/cfn_domain.rb', line 204

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


214
215
216
 
# File 'data_zone/cfn_domain.rb', line 214

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


670
671
672
673
 
# File 'data_zone/cfn_domain.rb', line 670

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) 


409
410
411
412
413
414
 
# File 'data_zone/cfn_domain.rb', line 409

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