Class: AWSCDK::DataZone::CfnEnvironmentBlueprintConfiguration

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

Overview

The configuration details of an environment blueprint.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEnvironmentBlueprintConfiguration

Create a new AWS::DataZone::EnvironmentBlueprintConfiguration.

Parameters:



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

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

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


181
182
183
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 181

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

.is_cfn_environment_blueprint_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnEnvironmentBlueprintConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


83
84
85
86
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 83

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

.jsii_overridable_methodsObject



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
# File 'data_zone/cfn_environment_blueprint_configuration.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_created_at => { kind: :property, name: "attrCreatedAt", 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_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :environment_blueprint_configuration_ref => { kind: :property, name: "environmentBlueprintConfigurationRef", is_optional: false },
    :domain_identifier => { kind: :property, name: "domainIdentifier", is_optional: false },
    :enabled_regions => { kind: :property, name: "enabledRegions", is_optional: false },
    :environment_blueprint_identifier => { kind: :property, name: "environmentBlueprintIdentifier", is_optional: false },
    :environment_role_permission_boundary => { kind: :property, name: "environmentRolePermissionBoundary", is_optional: true },
    :global_parameters => { kind: :property, name: "globalParameters", is_optional: true },
    :manage_access_role_arn => { kind: :property, name: "manageAccessRoleArn", is_optional: true },
    :provisioning_configurations => { kind: :property, name: "provisioningConfigurations", is_optional: true },
    :provisioning_role_arn => { kind: :property, name: "provisioningRoleArn", is_optional: true },
    :regional_parameters => { kind: :property, name: "regionalParameters", 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.



366
367
368
369
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 366

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:



378
379
380
381
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 378

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:



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

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.



399
400
401
402
403
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 399

def (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.


456
457
458
459
460
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 456

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.



466
467
468
469
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 466

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.



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

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:



491
492
493
494
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 491

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:



513
514
515
516
517
518
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 513

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_atString

The timestamp of when an environment blueprint was created.

Returns:

  • (String)


188
189
190
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 188

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_domain_idString

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

Returns:

  • (String)


195
196
197
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 195

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_environment_blueprint_idString

The identifier of the environment blueprint.

This identifier should be used when creating environment profiles.

Returns:

  • (String)


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

def attr_environment_blueprint_id()
  jsii_get_property("attrEnvironmentBlueprintId")
end

#attr_updated_atString

The timestamp of when the environment blueprint was updated.

Returns:

  • (String)


211
212
213
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 211

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



134
135
136
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 134

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


139
140
141
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 139

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


522
523
524
525
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 522

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


144
145
146
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 144

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


151
152
153
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 151

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


96
97
98
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 96

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_identifierString

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

Returns:

  • (String)


225
226
227
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 225

def domain_identifier()
  jsii_get_property("domainIdentifier")
end

#domain_identifier=(value) ⇒ Object



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

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

#enabled_regionsArray<String>

The enabled AWS Regions specified in a blueprint configuration.

Returns:

  • (Array<String>)


237
238
239
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 237

def enabled_regions()
  jsii_get_property("enabledRegions")
end

#enabled_regions=(value) ⇒ Object



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

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

#envAWSCDK::Interfaces::ResourceEnvironment



156
157
158
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 156

def env()
  jsii_get_property("env")
end

#environment_blueprint_configuration_refAWSCDK::Interfaces::AWSDatazone::EnvironmentBlueprintConfigurationReference

A reference to a EnvironmentBlueprintConfiguration resource.



218
219
220
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 218

def environment_blueprint_configuration_ref()
  jsii_get_property("environmentBlueprintConfigurationRef")
end

#environment_blueprint_identifierString

The identifier of the environment blueprint.

Returns:

  • (String)


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

def environment_blueprint_identifier()
  jsii_get_property("environmentBlueprintIdentifier")
end

#environment_blueprint_identifier=(value) ⇒ Object



253
254
255
256
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 253

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

#environment_role_permission_boundaryString?

The environment role permission boundary.

Returns:

  • (String, nil)


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

def environment_role_permission_boundary()
  jsii_get_property("environmentRolePermissionBoundary")
end

#environment_role_permission_boundary=(value) ⇒ Object



265
266
267
268
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 265

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



535
536
537
538
539
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 535

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.



546
547
548
549
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 546

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

#global_parametersAWSCDK::IResolvable, ...

Region-agnostic environment blueprint parameters.

Returns:



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

def global_parameters()
  jsii_get_property("globalParameters")
end

#global_parameters=(value) ⇒ Object



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



616
617
618
619
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 616

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

#logical_idString

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)


108
109
110
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 108

def logical_id()
  jsii_get_property("logicalId")
end

#manage_access_role_arnString?

The ARN of the manage access role.

Returns:

  • (String, nil)


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

def manage_access_role_arn()
  jsii_get_property("manageAccessRoleArn")
end

#manage_access_role_arn=(value) ⇒ Object



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

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


91
92
93
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 91

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



557
558
559
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 557

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



564
565
566
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 564

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.



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

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

#provisioning_configurationsAWSCDK::IResolvable, ...

The provisioning configuration of a blueprint.



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

def provisioning_configurations()
  jsii_get_property("provisioningConfigurations")
end

#provisioning_configurations=(value) ⇒ Object



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

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

#provisioning_role_arnString?

The ARN of the provisioning role.

Returns:

  • (String, nil)


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

def provisioning_role_arn()
  jsii_get_property("provisioningRoleArn")
end

#provisioning_role_arn=(value) ⇒ Object



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

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

#refString

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)


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

def ref()
  jsii_get_property("ref")
end

#regional_parametersAWSCDK::IResolvable, ...

The regional parameters of the environment blueprint.



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

def regional_parameters()
  jsii_get_property("regionalParameters")
end

#regional_parameters=(value) ⇒ Object



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

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



575
576
577
578
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 575

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


582
583
584
585
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 582

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:



592
593
594
595
596
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 592

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_synthesizeBoolean

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.



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

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



117
118
119
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 117

def stack()
  jsii_get_property("stack")
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



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

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

#updated_properitesHash{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})


164
165
166
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 164

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


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

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)


346
347
348
349
350
351
# File 'data_zone/cfn_environment_blueprint_configuration.rb', line 346

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