Class: AWSCDK::GlobalAccelerator::CfnEndpointGroup

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSGlobalaccelerator::IEndpointGroupRef
Defined in:
global_accelerator/cfn_endpoint_group.rb

Overview

The AWS::GlobalAccelerator::EndpointGroup resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener.

An endpoint group is a collection of endpoints in one AWS Region .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEndpointGroup

Create a new AWS::GlobalAccelerator::EndpointGroup.

Parameters:



19
20
21
22
23
24
25
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 19

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

Class Method Details

.arn_for_endpoint_group(resource) ⇒ String

Parameters:

Returns:

  • (String) 


81
82
83
84
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 81

def self.arn_for_endpoint_group(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nbG9iYWxhY2NlbGVyYXRvci5JRW5kcG9pbnRHcm91cFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_globalaccelerator.CfnEndpointGroup", "arnForEndpointGroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


188
189
190
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 188

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

.is_cfn_endpoint_group(x) ⇒ Boolean

Checks whether the given object is a CfnEndpointGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 90

def self.is_cfn_endpoint_group(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_globalaccelerator.CfnEndpointGroup", "isCfnEndpointGroup", [x])
end

.jsii_overridable_methods ⇒ Object 



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 'global_accelerator/cfn_endpoint_group.rb', line 27

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_endpoint_group_arn => { kind: :property, name: "attrEndpointGroupArn", is_optional: false },
    :endpoint_group_ref => { kind: :property, name: "endpointGroupRef", is_optional: false },
    :endpoint_group_region => { kind: :property, name: "endpointGroupRegion", is_optional: false },
    :listener_arn => { kind: :property, name: "listenerArn", is_optional: false },
    :endpoint_configurations => { kind: :property, name: "endpointConfigurations", is_optional: true },
    :health_check_interval_seconds => { kind: :property, name: "healthCheckIntervalSeconds", is_optional: true },
    :health_check_path => { kind: :property, name: "healthCheckPath", is_optional: true },
    :health_check_port => { kind: :property, name: "healthCheckPort", is_optional: true },
    :health_check_protocol => { kind: :property, name: "healthCheckProtocol", is_optional: true },
    :port_overrides => { kind: :property, name: "portOverrides", is_optional: true },
    :threshold_count => { kind: :property, name: "thresholdCount", is_optional: true },
    :traffic_dial_percentage => { kind: :property, name: "trafficDialPercentage", 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.



362
363
364
365
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 362

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:



374
375
376
377
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 374

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:



384
385
386
387
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 384

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:



395
396
397
398
399
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 395

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.


452
453
454
455
456
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 452

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.



462
463
464
465
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 462

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.



474
475
476
477
478
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 474

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:



487
488
489
490
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 487

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:



509
510
511
512
513
514
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 509

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

The ARN of the endpoint group, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu .

Returns:

  • (String) 


195
196
197
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 195

def attr_endpoint_group_arn()
  jsii_get_property("attrEndpointGroupArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



141
142
143
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 141

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


146
147
148
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 146

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


518
519
520
521
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 518

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


151
152
153
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 151

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


158
159
160
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 158

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


103
104
105
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 103

def creation_stack()
  jsii_get_property("creationStack")
end

#endpoint_configurations ⇒ AWSCDK::IResolvable, ...

The list of endpoint objects.

Returns:



233
234
235
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 233

def endpoint_configurations()
  jsii_get_property("endpointConfigurations")
end

#endpoint_configurations=(value) ⇒ Object 



237
238
239
240
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 237

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

#endpoint_group_ref ⇒ AWSCDK::Interfaces::AWSGlobalaccelerator::EndpointGroupReference

A reference to a EndpointGroup resource.

Returns:



202
203
204
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 202

def endpoint_group_ref()
  jsii_get_property("endpointGroupRef")
end

#endpoint_group_region ⇒ String

The AWS Regions where the endpoint group is located.

Returns:

  • (String) 


209
210
211
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 209

def endpoint_group_region()
  jsii_get_property("endpointGroupRegion")
end

#endpoint_group_region=(value) ⇒ Object 



213
214
215
216
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 213

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



163
164
165
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 163

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:



531
532
533
534
535
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 531

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:



542
543
544
545
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 542

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

#health_check_interval_seconds ⇒ Numeric?

The time—10 seconds or 30 seconds—between health checks for each endpoint.

Returns:

  • (Numeric, nil) 


245
246
247
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 245

def health_check_interval_seconds()
  jsii_get_property("healthCheckIntervalSeconds")
end

#health_check_interval_seconds=(value) ⇒ Object 



249
250
251
252
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 249

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

#health_check_path ⇒ String?

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.

Returns:

  • (String, nil) 


257
258
259
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 257

def health_check_path()
  jsii_get_property("healthCheckPath")
end

#health_check_path=(value) ⇒ Object 



261
262
263
264
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 261

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

#health_check_port ⇒ Numeric?

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

Returns:

  • (Numeric, nil) 


269
270
271
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 269

def health_check_port()
  jsii_get_property("healthCheckPort")
end

#health_check_port=(value) ⇒ Object 



273
274
275
276
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 273

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

#health_check_protocol ⇒ String?

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

Returns:

  • (String, nil) 


281
282
283
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 281

def health_check_protocol()
  jsii_get_property("healthCheckProtocol")
end

#health_check_protocol=(value) ⇒ Object 



285
286
287
288
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 285

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



612
613
614
615
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 612

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

#listener_arn ⇒ String

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String) 


221
222
223
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 221

def listener_arn()
  jsii_get_property("listenerArn")
end

#listener_arn=(value) ⇒ Object 



225
226
227
228
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 225

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

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


115
116
117
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 115

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


98
99
100
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 98

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:



553
554
555
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 553

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:



560
561
562
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 560

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.



353
354
355
356
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 353

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

#port_overrides ⇒ AWSCDK::IResolvable, ...

Allows you to override the destination ports used to route traffic to an endpoint.

Returns:



293
294
295
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 293

def port_overrides()
  jsii_get_property("portOverrides")
end

#port_overrides=(value) ⇒ Object 



297
298
299
300
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 297

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

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


134
135
136
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 134

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:



571
572
573
574
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 571

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


578
579
580
581
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 578

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:



588
589
590
591
592
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 588

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.



597
598
599
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 597

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:



124
125
126
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 124

def stack()
  jsii_get_property("stack")
end

#threshold_count ⇒ Numeric?

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

Returns:

  • (Numeric, nil) 


305
306
307
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 305

def threshold_count()
  jsii_get_property("thresholdCount")
end

#threshold_count=(value) ⇒ Object 



309
310
311
312
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 309

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



329
330
331
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 329

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

#traffic_dial_percentage ⇒ Numeric?

The percentage of traffic to send to an AWS Regions .

Returns:

  • (Numeric, nil) 


317
318
319
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 317

def traffic_dial_percentage()
  jsii_get_property("trafficDialPercentage")
end

#traffic_dial_percentage=(value) ⇒ Object 



321
322
323
324
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 321

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


171
172
173
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 171

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


181
182
183
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 181

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


603
604
605
606
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 603

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) 


342
343
344
345
346
347
 
# File 'global_accelerator/cfn_endpoint_group.rb', line 342

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