Class: AWSCDK::EMRContainers::CfnEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEmrcontainers::IEndpointRef
Defined in:
emr_containers/cfn_endpoint.rb

Overview

Resource Schema of AWS::EMRContainers::Endpoint Type.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEndpoint

Create a new AWS::EMRContainers::Endpoint.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EMRContainers::CfnEndpointProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'emr_containers/cfn_endpoint.rb', line 18

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

Class Method Details

.arn_for_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'emr_containers/cfn_endpoint.rb', line 86

def self.arn_for_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbXJjb250YWluZXJzLklFbmRwb2ludFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_emrcontainers.CfnEndpoint", "arnForEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'emr_containers/cfn_endpoint.rb', line 193

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

.is_cfn_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'emr_containers/cfn_endpoint.rb', line 95

def self.is_cfn_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_emrcontainers.CfnEndpoint", "isCfnEndpoint", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'emr_containers/cfn_endpoint.rb', line 26

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_certificate_authority => { kind: :property, name: "attrCertificateAuthority", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_security_group => { kind: :property, name: "attrSecurityGroup", is_optional: false },
    :attr_server_url => { kind: :property, name: "attrServerUrl", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_state_details => { kind: :property, name: "attrStateDetails", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :endpoint_ref => { kind: :property, name: "endpointRef", is_optional: false },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: false },
    :release_label => { kind: :property, name: "releaseLabel", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :virtual_cluster_id => { kind: :property, name: "virtualClusterId", is_optional: false },
    :configuration_overrides => { kind: :property, name: "configurationOverrides", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



392
393
394
395
 
# File 'emr_containers/cfn_endpoint.rb', line 392

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:



404
405
406
407
 
# File 'emr_containers/cfn_endpoint.rb', line 404

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:



414
415
416
417
 
# File 'emr_containers/cfn_endpoint.rb', line 414

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:



425
426
427
428
429
 
# File 'emr_containers/cfn_endpoint.rb', line 425

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.


482
483
484
485
486
 
# File 'emr_containers/cfn_endpoint.rb', line 482

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.



492
493
494
495
 
# File 'emr_containers/cfn_endpoint.rb', line 492

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.



504
505
506
507
508
 
# File 'emr_containers/cfn_endpoint.rb', line 504

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:



517
518
519
520
 
# File 'emr_containers/cfn_endpoint.rb', line 517

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:



539
540
541
542
543
544
 
# File 'emr_containers/cfn_endpoint.rb', line 539

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the managed endpoint.

Returns:

  • (String) 


200
201
202
 
# File 'emr_containers/cfn_endpoint.rb', line 200

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_certificate_authority ⇒ AWSCDK::IResolvable

Returns:



205
206
207
 
# File 'emr_containers/cfn_endpoint.rb', line 205

def attr_certificate_authority()
  jsii_get_property("attrCertificateAuthority")
end

#attr_created_at ⇒ String

The date and time when the managed endpoint was created.

Returns:

  • (String) 


212
213
214
 
# File 'emr_containers/cfn_endpoint.rb', line 212

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reason ⇒ String

The reason for a failed managed endpoint.

Returns:

  • (String) 


219
220
221
 
# File 'emr_containers/cfn_endpoint.rb', line 219

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_id ⇒ String

The ID of the managed endpoint.

Returns:

  • (String) 


226
227
228
 
# File 'emr_containers/cfn_endpoint.rb', line 226

def attr_id()
  jsii_get_property("attrId")
end

#attr_security_group ⇒ String

The security group associated with the managed endpoint.

Returns:

  • (String) 


233
234
235
 
# File 'emr_containers/cfn_endpoint.rb', line 233

def attr_security_group()
  jsii_get_property("attrSecurityGroup")
end

#attr_server_url ⇒ String

The server URL of the managed endpoint.

Returns:

  • (String) 


240
241
242
 
# File 'emr_containers/cfn_endpoint.rb', line 240

def attr_server_url()
  jsii_get_property("attrServerUrl")
end

#attr_state ⇒ String

The state of the managed endpoint.

Returns:

  • (String) 


247
248
249
 
# File 'emr_containers/cfn_endpoint.rb', line 247

def attr_state()
  jsii_get_property("attrState")
end

#attr_state_details ⇒ String

Additional details about the state of the managed endpoint.

Returns:

  • (String) 


254
255
256
 
# File 'emr_containers/cfn_endpoint.rb', line 254

def attr_state_details()
  jsii_get_property("attrStateDetails")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



261
262
263
 
# File 'emr_containers/cfn_endpoint.rb', line 261

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



146
147
148
 
# File 'emr_containers/cfn_endpoint.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'emr_containers/cfn_endpoint.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


548
549
550
551
 
# File 'emr_containers/cfn_endpoint.rb', line 548

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


156
157
158
 
# File 'emr_containers/cfn_endpoint.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'emr_containers/cfn_endpoint.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_overrides ⇒ AWSCDK::IResolvable, ...

Returns:



321
322
323
 
# File 'emr_containers/cfn_endpoint.rb', line 321

def configuration_overrides()
  jsii_get_property("configurationOverrides")
end

#configuration_overrides=(value) ⇒ Object 



325
326
327
328
329
 
# File 'emr_containers/cfn_endpoint.rb', line 325

def configuration_overrides=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EMRContainers::CfnEndpoint::ConfigurationOverridesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbXJjb250YWluZXJzLkNmbkVuZHBvaW50LkNvbmZpZ3VyYXRpb25PdmVycmlkZXNQcm9wZXJ0eSJ9XX19")), "configurationOverrides") unless value.nil?
  jsii_set_property("configurationOverrides", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'emr_containers/cfn_endpoint.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#endpoint_ref ⇒ AWSCDK::Interfaces::AWSEmrcontainers::EndpointReference

A reference to a Endpoint resource.

Returns:



268
269
270
 
# File 'emr_containers/cfn_endpoint.rb', line 268

def endpoint_ref()
  jsii_get_property("endpointRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'emr_containers/cfn_endpoint.rb', line 168

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String

The execution role ARN for the managed endpoint.

Returns:

  • (String) 


275
276
277
 
# File 'emr_containers/cfn_endpoint.rb', line 275

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



279
280
281
282
 
# File 'emr_containers/cfn_endpoint.rb', line 279

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



561
562
563
564
565
 
# File 'emr_containers/cfn_endpoint.rb', line 561

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:



572
573
574
575
 
# File 'emr_containers/cfn_endpoint.rb', line 572

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



642
643
644
645
 
# File 'emr_containers/cfn_endpoint.rb', line 642

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) 


120
121
122
 
# File 'emr_containers/cfn_endpoint.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the managed endpoint.

Returns:

  • (String, nil) 


334
335
336
 
# File 'emr_containers/cfn_endpoint.rb', line 334

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



338
339
340
341
 
# File 'emr_containers/cfn_endpoint.rb', line 338

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'emr_containers/cfn_endpoint.rb', line 103

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:



583
584
585
 
# File 'emr_containers/cfn_endpoint.rb', line 583

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:



590
591
592
 
# File 'emr_containers/cfn_endpoint.rb', line 590

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.



383
384
385
386
 
# File 'emr_containers/cfn_endpoint.rb', line 383

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) 


139
140
141
 
# File 'emr_containers/cfn_endpoint.rb', line 139

def ref()
  jsii_get_property("ref")
end

#release_label ⇒ String

The Amazon EMR release label.

Returns:

  • (String) 


287
288
289
 
# File 'emr_containers/cfn_endpoint.rb', line 287

def release_label()
  jsii_get_property("releaseLabel")
end

#release_label=(value) ⇒ Object 



291
292
293
294
 
# File 'emr_containers/cfn_endpoint.rb', line 291

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



601
602
603
604
 
# File 'emr_containers/cfn_endpoint.rb', line 601

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


608
609
610
611
 
# File 'emr_containers/cfn_endpoint.rb', line 608

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:



618
619
620
621
622
 
# File 'emr_containers/cfn_endpoint.rb', line 618

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.



627
628
629
 
# File 'emr_containers/cfn_endpoint.rb', line 627

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:



129
130
131
 
# File 'emr_containers/cfn_endpoint.rb', line 129

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this managed endpoint.

Returns:



346
347
348
 
# File 'emr_containers/cfn_endpoint.rb', line 346

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



350
351
352
353
354
 
# File 'emr_containers/cfn_endpoint.rb', line 350

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



359
360
361
 
# File 'emr_containers/cfn_endpoint.rb', line 359

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

#type ⇒ String

The type of the managed endpoint.

Returns:

  • (String) 


299
300
301
 
# File 'emr_containers/cfn_endpoint.rb', line 299

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



303
304
305
306
 
# File 'emr_containers/cfn_endpoint.rb', line 303

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'emr_containers/cfn_endpoint.rb', line 176

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


186
187
188
 
# File 'emr_containers/cfn_endpoint.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


633
634
635
636
 
# File 'emr_containers/cfn_endpoint.rb', line 633

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

#virtual_cluster_id ⇒ String

The ID of the virtual cluster for which the managed endpoint is created.

Returns:

  • (String) 


311
312
313
 
# File 'emr_containers/cfn_endpoint.rb', line 311

def virtual_cluster_id()
  jsii_get_property("virtualClusterId")
end

#virtual_cluster_id=(value) ⇒ Object 



315
316
317
318
 
# File 'emr_containers/cfn_endpoint.rb', line 315

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


372
373
374
375
376
377
 
# File 'emr_containers/cfn_endpoint.rb', line 372

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