Class: AWSCDK::DataZone::CfnEnvironment

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

Overview

The AWS::DataZone::Environment resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEnvironment

Create a new AWS::DataZone::Environment.

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

    Resource properties.



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

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

Class Method Details

.arn_for_environment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'data_zone/cfn_environment.rb', line 93

def self.arn_for_environment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kYXRhem9uZS5JRW52aXJvbm1lbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datazone.CfnEnvironment", "arnForEnvironment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


200
201
202
 
# File 'data_zone/cfn_environment.rb', line 200

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

.is_cfn_environment(x) ⇒ Boolean

Checks whether the given object is a CfnEnvironment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'data_zone/cfn_environment.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_aws_account_id => { kind: :property, name: "attrAwsAccountId", is_optional: false },
    :attr_aws_account_region => { kind: :property, name: "attrAwsAccountRegion", 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_blueprint_id => { kind: :property, name: "attrEnvironmentBlueprintId", is_optional: false },
    :attr_environment_profile_id => { kind: :property, name: "attrEnvironmentProfileId", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_project_id => { kind: :property, name: "attrProjectId", is_optional: false },
    :attr_provider => { kind: :property, name: "attrProvider", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :environment_ref => { kind: :property, name: "environmentRef", is_optional: false },
    :domain_identifier => { kind: :property, name: "domainIdentifier", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :project_identifier => { kind: :property, name: "projectIdentifier", is_optional: false },
    :deployment_order => { kind: :property, name: "deploymentOrder", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :environment_account_identifier => { kind: :property, name: "environmentAccountIdentifier", is_optional: true },
    :environment_account_region => { kind: :property, name: "environmentAccountRegion", is_optional: true },
    :environment_blueprint_identifier => { kind: :property, name: "environmentBlueprintIdentifier", is_optional: true },
    :environment_configuration_id => { kind: :property, name: "environmentConfigurationId", is_optional: true },
    :environment_profile_identifier => { kind: :property, name: "environmentProfileIdentifier", is_optional: true },
    :environment_role_arn => { kind: :property, name: "environmentRoleArn", is_optional: true },
    :glossary_terms => { kind: :property, name: "glossaryTerms", is_optional: true },
    :user_parameters => { kind: :property, name: "userParameters", 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.



487
488
489
490
 
# File 'data_zone/cfn_environment.rb', line 487

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:



499
500
501
502
 
# File 'data_zone/cfn_environment.rb', line 499

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:



509
510
511
512
 
# File 'data_zone/cfn_environment.rb', line 509

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:



520
521
522
523
524
 
# File 'data_zone/cfn_environment.rb', line 520

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.


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

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.



587
588
589
590
 
# File 'data_zone/cfn_environment.rb', line 587

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.



599
600
601
602
603
 
# File 'data_zone/cfn_environment.rb', line 599

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:



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

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:



634
635
636
637
638
639
 
# File 'data_zone/cfn_environment.rb', line 634

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

The identifier of the AWS account in which an environment exists.

Returns:

  • (String) 


207
208
209
 
# File 'data_zone/cfn_environment.rb', line 207

def ()
  jsii_get_property("attrAwsAccountId")
end

#attr_aws_account_region ⇒ String

The AWS Region in which an environment exists.

Returns:

  • (String) 


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

def ()
  jsii_get_property("attrAwsAccountRegion")
end

#attr_created_at ⇒ String

The timestamp of when the environment was created.

Returns:

  • (String) 


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

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_created_by ⇒ String

The Amazon DataZone user who created the environment.

Returns:

  • (String) 


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

def attr_created_by()
  jsii_get_property("attrCreatedBy")
end

#attr_domain_id ⇒ String

The identifier of the Amazon DataZone domain in which the environment exists.

Returns:

  • (String) 


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

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_environment_blueprint_id ⇒ String

The identifier of a blueprint with which an environment profile is created.

Returns:

  • (String) 


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

def attr_environment_blueprint_id()
  jsii_get_property("attrEnvironmentBlueprintId")
end

#attr_environment_profile_id ⇒ String

The identifier of the environment profile with which the environment was created.

Returns:

  • (String) 


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

def attr_environment_profile_id()
  jsii_get_property("attrEnvironmentProfileId")
end

#attr_id ⇒ String

The identifier of the environment.

Returns:

  • (String) 


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

def attr_id()
  jsii_get_property("attrId")
end

#attr_project_id ⇒ String

The identifier of the project in which the environment exists.

Returns:

  • (String) 


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

def attr_project_id()
  jsii_get_property("attrProjectId")
end

#attr_provider ⇒ String

The provider of the environment.

Returns:

  • (String) 


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

def attr_provider()
  jsii_get_property("attrProvider")
end

#attr_status ⇒ String

The status of the environment.

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The timestamp of when the environment was updated.

Returns:

  • (String) 


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

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



153
154
155
 
# File 'data_zone/cfn_environment.rb', line 153

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


158
159
160
 
# File 'data_zone/cfn_environment.rb', line 158

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


643
644
645
646
 
# File 'data_zone/cfn_environment.rb', line 643

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


163
164
165
 
# File 'data_zone/cfn_environment.rb', line 163

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


170
171
172
 
# File 'data_zone/cfn_environment.rb', line 170

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


115
116
117
 
# File 'data_zone/cfn_environment.rb', line 115

def creation_stack()
  jsii_get_property("creationStack")
end

#deployment_order ⇒ Numeric?

The deployment order for the environment.

Returns:

  • (Numeric, nil) 


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

def deployment_order()
  jsii_get_property("deploymentOrder")
end

#deployment_order=(value) ⇒ Object 



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

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

#description ⇒ String?

The description of the environment.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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 identifier of the Amazon DataZone domain in which the environment is created.

Returns:

  • (String) 


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

def domain_identifier()
  jsii_get_property("domainIdentifier")
end

#domain_identifier=(value) ⇒ Object 



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

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:



175
176
177
 
# File 'data_zone/cfn_environment.rb', line 175

def env()
  jsii_get_property("env")
end

#environment_account_identifier ⇒ String?

The identifier of the AWS account in which an environment exists.

Returns:

  • (String, nil) 


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

def ()
  jsii_get_property("environmentAccountIdentifier")
end

#environment_account_identifier=(value) ⇒ Object 



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

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

#environment_account_region ⇒ String?

The AWS Region in which an environment exists.

Returns:

  • (String, nil) 


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

def ()
  jsii_get_property("environmentAccountRegion")
end

#environment_account_region=(value) ⇒ Object 



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

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

#environment_blueprint_identifier ⇒ String?

The identifier of the environment blueprint.

Returns:

  • (String, nil) 


382
383
384
 
# File 'data_zone/cfn_environment.rb', line 382

def environment_blueprint_identifier()
  jsii_get_property("environmentBlueprintIdentifier")
end

#environment_blueprint_identifier=(value) ⇒ Object 



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

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

#environment_configuration_id ⇒ String?

The identifier of the environment configuration.

Returns:

  • (String, nil) 


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

def environment_configuration_id()
  jsii_get_property("environmentConfigurationId")
end

#environment_configuration_id=(value) ⇒ Object 



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

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

#environment_profile_identifier ⇒ String?

The identifier of the environment profile that is used to create this Amazon DataZone environment.

Returns:

  • (String, nil) 


406
407
408
 
# File 'data_zone/cfn_environment.rb', line 406

def environment_profile_identifier()
  jsii_get_property("environmentProfileIdentifier")
end

#environment_profile_identifier=(value) ⇒ Object 



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

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

#environment_ref ⇒ AWSCDK::Interfaces::AWSDatazone::EnvironmentReference

A reference to a Environment resource.

Returns:



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

def environment_ref()
  jsii_get_property("environmentRef")
end

#environment_role_arn ⇒ String?

The ARN of the environment role.

Returns:

  • (String, nil) 


418
419
420
 
# File 'data_zone/cfn_environment.rb', line 418

def environment_role_arn()
  jsii_get_property("environmentRoleArn")
end

#environment_role_arn=(value) ⇒ Object 



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

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



656
657
658
659
660
 
# File 'data_zone/cfn_environment.rb', line 656

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:



667
668
669
670
 
# File 'data_zone/cfn_environment.rb', line 667

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#glossary_terms ⇒ Array<String>?

The glossary terms that can be used in this Amazon DataZone environment.

Returns:

  • (Array<String>, nil) 


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

def glossary_terms()
  jsii_get_property("glossaryTerms")
end

#glossary_terms=(value) ⇒ Object 



434
435
436
437
 
# File 'data_zone/cfn_environment.rb', line 434

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



737
738
739
740
 
# File 'data_zone/cfn_environment.rb', line 737

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) 


127
128
129
 
# File 'data_zone/cfn_environment.rb', line 127

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the Amazon DataZone environment.

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


110
111
112
 
# File 'data_zone/cfn_environment.rb', line 110

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:



678
679
680
 
# File 'data_zone/cfn_environment.rb', line 678

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:



685
686
687
 
# File 'data_zone/cfn_environment.rb', line 685

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.



478
479
480
481
 
# File 'data_zone/cfn_environment.rb', line 478

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

#project_identifier ⇒ String

The identifier of the Amazon DataZone project in which this environment is created.

Returns:

  • (String) 


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

def project_identifier()
  jsii_get_property("projectIdentifier")
end

#project_identifier=(value) ⇒ Object 



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

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


146
147
148
 
# File 'data_zone/cfn_environment.rb', line 146

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:



696
697
698
699
 
# File 'data_zone/cfn_environment.rb', line 696

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


703
704
705
706
 
# File 'data_zone/cfn_environment.rb', line 703

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:



713
714
715
716
717
 
# File 'data_zone/cfn_environment.rb', line 713

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.



722
723
724
 
# File 'data_zone/cfn_environment.rb', line 722

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:



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

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



454
455
456
 
# File 'data_zone/cfn_environment.rb', line 454

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


183
184
185
 
# File 'data_zone/cfn_environment.rb', line 183

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


193
194
195
 
# File 'data_zone/cfn_environment.rb', line 193

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_parameters ⇒ AWSCDK::IResolvable, ...

The user parameters of this Amazon DataZone environment.

Returns:



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

def user_parameters()
  jsii_get_property("userParameters")
end

#user_parameters=(value) ⇒ Object 



446
447
448
449
 
# File 'data_zone/cfn_environment.rb', line 446

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


728
729
730
731
 
# File 'data_zone/cfn_environment.rb', line 728

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) 


467
468
469
470
471
472
 
# File 'data_zone/cfn_environment.rb', line 467

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