Class: AWSCDK::EMR::CfnStudio

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEMR::IStudioRef
Defined in:
emr/cfn_studio.rb

Overview

The AWS::EMR::Studio resource specifies an Amazon EMR Studio.

An EMR Studio is a web-based, integrated development environment for fully managed Jupyter notebooks that run on Amazon EMR clusters. For more information, see the Amazon EMR Management Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStudio

Create a new AWS::EMR::Studio.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EMR::CfnStudioProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'emr/cfn_studio.rb', line 20

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

Class Method Details

.arn_for_studio(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'emr/cfn_studio.rb', line 92

def self.arn_for_studio(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbXIuSVN0dWRpb1JlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_emr.CfnStudio", "arnForStudio", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


225
226
227
 
# File 'emr/cfn_studio.rb', line 225

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

.from_studio_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEMR::IStudioRef

Creates a new IStudioRef from an ARN.

Parameters:

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

Returns:



103
104
105
106
107
108
 
# File 'emr/cfn_studio.rb', line 103

def self.from_studio_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_emr.CfnStudio", "fromStudioArn", [scope, id, arn])
end

.from_studio_id(scope, id, studio_id) ⇒ AWSCDK::Interfaces::AWSEMR::IStudioRef

Creates a new IStudioRef from a studioId.

Parameters:

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

Returns:



116
117
118
119
120
121
 
# File 'emr/cfn_studio.rb', line 116

def self.from_studio_id(scope, id, studio_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(studio_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "studioId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_emr.CfnStudio", "fromStudioId", [scope, id, studio_id])
end

.is_cfn_studio(x) ⇒ Boolean

Checks whether the given object is a CfnStudio.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'emr/cfn_studio.rb', line 127

def self.is_cfn_studio(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_emr.CfnStudio", "isCfnStudio", [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
85
86
87
88
 
# File 'emr/cfn_studio.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_studio_id => { kind: :property, name: "attrStudioId", is_optional: false },
    :attr_url => { kind: :property, name: "attrUrl", is_optional: false },
    :studio_ref => { kind: :property, name: "studioRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :auth_mode => { kind: :property, name: "authMode", is_optional: false },
    :default_s3_location => { kind: :property, name: "defaultS3Location", is_optional: false },
    :engine_security_group_id => { kind: :property, name: "engineSecurityGroupId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :service_role => { kind: :property, name: "serviceRole", is_optional: false },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: false },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: false },
    :workspace_security_group_id => { kind: :property, name: "workspaceSecurityGroupId", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_key_arn => { kind: :property, name: "encryptionKeyArn", is_optional: true },
    :idc_instance_arn => { kind: :property, name: "idcInstanceArn", is_optional: true },
    :idc_user_assignment => { kind: :property, name: "idcUserAssignment", is_optional: true },
    :idp_auth_url => { kind: :property, name: "idpAuthUrl", is_optional: true },
    :idp_relay_state_parameter_name => { kind: :property, name: "idpRelayStateParameterName", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :trusted_identity_propagation_enabled => { kind: :property, name: "trustedIdentityPropagationEnabled", is_optional: true },
    :user_role => { kind: :property, name: "userRole", 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.



511
512
513
514
 
# File 'emr/cfn_studio.rb', line 511

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:



523
524
525
526
 
# File 'emr/cfn_studio.rb', line 523

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:



533
534
535
536
 
# File 'emr/cfn_studio.rb', line 533

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:



544
545
546
547
548
 
# File 'emr/cfn_studio.rb', line 544

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.


601
602
603
604
605
 
# File 'emr/cfn_studio.rb', line 601

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.



611
612
613
614
 
# File 'emr/cfn_studio.rb', line 611

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.



623
624
625
626
627
 
# File 'emr/cfn_studio.rb', line 623

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:



636
637
638
639
 
# File 'emr/cfn_studio.rb', line 636

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:



658
659
660
661
662
663
 
# File 'emr/cfn_studio.rb', line 658

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 Amazon Resource Name (ARN) of the Amazon EMR Studio.

For example: arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX .

Returns:

  • (String) 


234
235
236
 
# File 'emr/cfn_studio.rb', line 234

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_studio_id ⇒ String

The ID of the Amazon EMR Studio.

For example: es-EXAMPLE12345678XXXXXXXXXXX .

Returns:

  • (String) 


243
244
245
 
# File 'emr/cfn_studio.rb', line 243

def attr_studio_id()
  jsii_get_property("attrStudioId")
end

#attr_url ⇒ String

The unique access URL of the Amazon EMR Studio.

For example: https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com .

Returns:

  • (String) 


252
253
254
 
# File 'emr/cfn_studio.rb', line 252

def attr_url()
  jsii_get_property("attrUrl")
end

#auth_mode ⇒ String

Specifies whether the Studio authenticates users using SSO or IAM.

Returns:

  • (String) 


273
274
275
 
# File 'emr/cfn_studio.rb', line 273

def auth_mode()
  jsii_get_property("authMode")
end

#auth_mode=(value) ⇒ Object 



277
278
279
280
 
# File 'emr/cfn_studio.rb', line 277

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



178
179
180
 
# File 'emr/cfn_studio.rb', line 178

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'emr/cfn_studio.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


667
668
669
670
 
# File 'emr/cfn_studio.rb', line 667

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


188
189
190
 
# File 'emr/cfn_studio.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


195
196
197
 
# File 'emr/cfn_studio.rb', line 195

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


140
141
142
 
# File 'emr/cfn_studio.rb', line 140

def creation_stack()
  jsii_get_property("creationStack")
end

#default_s3_location ⇒ String

The Amazon S3 location to back up EMR Studio Workspaces and notebook files.

Returns:

  • (String) 


285
286
287
 
# File 'emr/cfn_studio.rb', line 285

def default_s3_location()
  jsii_get_property("defaultS3Location")
end

#default_s3_location=(value) ⇒ Object 



289
290
291
292
 
# File 'emr/cfn_studio.rb', line 289

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

#description ⇒ String?

A detailed description of the Amazon EMR Studio.

Returns:

  • (String, nil) 


369
370
371
 
# File 'emr/cfn_studio.rb', line 369

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



373
374
375
376
 
# File 'emr/cfn_studio.rb', line 373

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

#encryption_key_arn ⇒ String?

The AWS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

Returns:

  • (String, nil) 


381
382
383
 
# File 'emr/cfn_studio.rb', line 381

def encryption_key_arn()
  jsii_get_property("encryptionKeyArn")
end

#encryption_key_arn=(value) ⇒ Object 



385
386
387
388
 
# File 'emr/cfn_studio.rb', line 385

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

#engine_security_group_id ⇒ String

The ID of the Amazon EMR Studio Engine security group.

Returns:

  • (String) 


297
298
299
 
# File 'emr/cfn_studio.rb', line 297

def engine_security_group_id()
  jsii_get_property("engineSecurityGroupId")
end

#engine_security_group_id=(value) ⇒ Object 



301
302
303
304
 
# File 'emr/cfn_studio.rb', line 301

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



200
201
202
 
# File 'emr/cfn_studio.rb', line 200

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:



680
681
682
683
684
 
# File 'emr/cfn_studio.rb', line 680

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:



691
692
693
694
 
# File 'emr/cfn_studio.rb', line 691

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

#idc_instance_arn ⇒ String?

The ARN of the IAM Identity Center instance the Studio application belongs to.

Returns:

  • (String, nil) 


393
394
395
 
# File 'emr/cfn_studio.rb', line 393

def idc_instance_arn()
  jsii_get_property("idcInstanceArn")
end

#idc_instance_arn=(value) ⇒ Object 



397
398
399
400
 
# File 'emr/cfn_studio.rb', line 397

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

#idc_user_assignment ⇒ String?

Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.

Returns:

  • (String, nil) 


405
406
407
 
# File 'emr/cfn_studio.rb', line 405

def idc_user_assignment()
  jsii_get_property("idcUserAssignment")
end

#idc_user_assignment=(value) ⇒ Object 



409
410
411
412
 
# File 'emr/cfn_studio.rb', line 409

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

#idp_auth_url ⇒ String?

Your identity provider's authentication endpoint.

Returns:

  • (String, nil) 


417
418
419
 
# File 'emr/cfn_studio.rb', line 417

def idp_auth_url()
  jsii_get_property("idpAuthUrl")
end

#idp_auth_url=(value) ⇒ Object 



421
422
423
424
 
# File 'emr/cfn_studio.rb', line 421

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

#idp_relay_state_parameter_name ⇒ String?

The name of your identity provider's RelayState parameter.

Returns:

  • (String, nil) 


429
430
431
 
# File 'emr/cfn_studio.rb', line 429

def idp_relay_state_parameter_name()
  jsii_get_property("idpRelayStateParameterName")
end

#idp_relay_state_parameter_name=(value) ⇒ Object 



433
434
435
436
 
# File 'emr/cfn_studio.rb', line 433

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



761
762
763
764
 
# File 'emr/cfn_studio.rb', line 761

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) 


152
153
154
 
# File 'emr/cfn_studio.rb', line 152

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A descriptive name for the Amazon EMR Studio.

Returns:

  • (String) 


309
310
311
 
# File 'emr/cfn_studio.rb', line 309

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



313
314
315
316
 
# File 'emr/cfn_studio.rb', line 313

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) 


135
136
137
 
# File 'emr/cfn_studio.rb', line 135

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:



702
703
704
 
# File 'emr/cfn_studio.rb', line 702

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:



709
710
711
 
# File 'emr/cfn_studio.rb', line 709

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.



502
503
504
505
 
# File 'emr/cfn_studio.rb', line 502

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) 


171
172
173
 
# File 'emr/cfn_studio.rb', line 171

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:



720
721
722
723
 
# File 'emr/cfn_studio.rb', line 720

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


727
728
729
730
 
# File 'emr/cfn_studio.rb', line 727

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:



737
738
739
740
741
 
# File 'emr/cfn_studio.rb', line 737

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 Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.

Returns:

  • (String) 


321
322
323
 
# File 'emr/cfn_studio.rb', line 321

def service_role()
  jsii_get_property("serviceRole")
end

#service_role=(value) ⇒ Object 



325
326
327
328
 
# File 'emr/cfn_studio.rb', line 325

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



746
747
748
 
# File 'emr/cfn_studio.rb', line 746

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:



161
162
163
 
# File 'emr/cfn_studio.rb', line 161

def stack()
  jsii_get_property("stack")
end

#studio_ref ⇒ AWSCDK::Interfaces::AWSEMR::StudioReference

A reference to a Studio resource.

Returns:



259
260
261
 
# File 'emr/cfn_studio.rb', line 259

def studio_ref()
  jsii_get_property("studioRef")
end

#subnet_ids ⇒ Array<String>

A list of subnet IDs to associate with the Amazon EMR Studio.

Returns:

  • (Array<String>) 


333
334
335
 
# File 'emr/cfn_studio.rb', line 333

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



337
338
339
340
 
# File 'emr/cfn_studio.rb', line 337

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



266
267
268
 
# File 'emr/cfn_studio.rb', line 266

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



441
442
443
 
# File 'emr/cfn_studio.rb', line 441

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



445
446
447
448
449
 
# File 'emr/cfn_studio.rb', line 445

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



478
479
480
 
# File 'emr/cfn_studio.rb', line 478

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

#trusted_identity_propagation_enabled ⇒ Boolean, ...

Indicates whether the Studio has Trusted identity propagation enabled.

Returns:



454
455
456
 
# File 'emr/cfn_studio.rb', line 454

def trusted_identity_propagation_enabled()
  jsii_get_property("trustedIdentityPropagationEnabled")
end

#trusted_identity_propagation_enabled=(value) ⇒ Object 



458
459
460
461
 
# File 'emr/cfn_studio.rb', line 458

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


208
209
210
 
# File 'emr/cfn_studio.rb', line 208

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


218
219
220
 
# File 'emr/cfn_studio.rb', line 218

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_role ⇒ String?

The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.

Returns:

  • (String, nil) 


466
467
468
 
# File 'emr/cfn_studio.rb', line 466

def user_role()
  jsii_get_property("userRole")
end

#user_role=(value) ⇒ Object 



470
471
472
473
 
# File 'emr/cfn_studio.rb', line 470

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


752
753
754
755
 
# File 'emr/cfn_studio.rb', line 752

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_id ⇒ String

The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

Returns:

  • (String) 


345
346
347
 
# File 'emr/cfn_studio.rb', line 345

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



349
350
351
352
 
# File 'emr/cfn_studio.rb', line 349

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


491
492
493
494
495
496
 
# File 'emr/cfn_studio.rb', line 491

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

#workspace_security_group_id ⇒ String

The ID of the Workspace security group associated with the Amazon EMR Studio.

Returns:

  • (String) 


357
358
359
 
# File 'emr/cfn_studio.rb', line 357

def workspace_security_group_id()
  jsii_get_property("workspaceSecurityGroupId")
end

#workspace_security_group_id=(value) ⇒ Object 



361
362
363
364
 
# File 'emr/cfn_studio.rb', line 361

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