Class: AWSCDK::ElasticLoadBalancingv2::CfnTargetGroup

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSElasticloadbalancingv2::ITargetGroupRef
Defined in:
elastic_load_balancingv2/cfn_target_group.rb

Overview

Specifies a target group for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

Before you register a Lambda function as a target, you must create a AWS::Lambda::Permission resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnTargetGroup

Create a new AWS::ElasticLoadBalancingV2::TargetGroup.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::ElasticLoadBalancingv2::CfnTargetGroupProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::CfnTargetGroupProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5DZm5UYXJnZXRHcm91cFByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_target_group(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 96

def self.arn_for_target_group(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLklUYXJnZXRHcm91cFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancingv2.CfnTargetGroup", "arnForTargetGroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 203

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

.is_cfn_target_group(x) ⇒ Boolean

Checks whether the given object is a CfnTargetGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 105

def self.is_cfn_target_group(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancingv2.CfnTargetGroup", "isCfnTargetGroup", [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
89
90
91
92
 
# File 'elastic_load_balancingv2/cfn_target_group.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_load_balancer_arns => { kind: :property, name: "attrLoadBalancerArns", is_optional: false },
    :attr_target_group_arn => { kind: :property, name: "attrTargetGroupArn", is_optional: false },
    :attr_target_group_full_name => { kind: :property, name: "attrTargetGroupFullName", is_optional: false },
    :attr_target_group_name => { kind: :property, name: "attrTargetGroupName", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :target_group_ref => { kind: :property, name: "targetGroupRef", is_optional: false },
    :health_check_enabled => { kind: :property, name: "healthCheckEnabled", 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 },
    :health_check_timeout_seconds => { kind: :property, name: "healthCheckTimeoutSeconds", is_optional: true },
    :healthy_threshold_count => { kind: :property, name: "healthyThresholdCount", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :matcher => { kind: :property, name: "matcher", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :protocol => { kind: :property, name: "protocol", is_optional: true },
    :protocol_version => { kind: :property, name: "protocolVersion", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :target_control_port => { kind: :property, name: "targetControlPort", is_optional: true },
    :target_group_attributes => { kind: :property, name: "targetGroupAttributes", is_optional: true },
    :targets => { kind: :property, name: "targets", is_optional: true },
    :target_type => { kind: :property, name: "targetType", is_optional: true },
    :unhealthy_threshold_count => { kind: :property, name: "unhealthyThresholdCount", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", 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.



531
532
533
534
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 531

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:



543
544
545
546
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 543

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:



553
554
555
556
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 553

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:



564
565
566
567
568
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 564

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.


621
622
623
624
625
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 621

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.



631
632
633
634
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 631

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.



643
644
645
646
647
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 643

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:



656
657
658
659
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 656

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:



678
679
680
681
682
683
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 678

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_load_balancer_arns ⇒ Array<String>

The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.

Returns:

  • (Array<String>) 


210
211
212
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 210

def attr_load_balancer_arns()
  jsii_get_property("attrLoadBalancerArns")
end

#attr_target_group_arn ⇒ String

The Amazon Resource Name (ARN) of the target group.

Returns:

  • (String) 


217
218
219
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 217

def attr_target_group_arn()
  jsii_get_property("attrTargetGroupArn")
end

#attr_target_group_full_name ⇒ String

The full name of the target group.

For example, targetgroup/my-target-group/cbf133c568e0d028 .

Returns:

  • (String) 


226
227
228
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 226

def attr_target_group_full_name()
  jsii_get_property("attrTargetGroupFullName")
end

#attr_target_group_name ⇒ String

The name of the target group.

For example, my-target-group .

Returns:

  • (String) 


235
236
237
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 235

def attr_target_group_name()
  jsii_get_property("attrTargetGroupName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



156
157
158
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


687
688
689
690
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 687

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


166
167
168
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 178

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:



700
701
702
703
704
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 700

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:



711
712
713
714
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 711

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

#health_check_enabled ⇒ Boolean, ...

Indicates whether health checks are enabled.

Returns:



256
257
258
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 256

def health_check_enabled()
  jsii_get_property("healthCheckEnabled")
end

#health_check_enabled=(value) ⇒ Object 



260
261
262
263
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 260

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

#health_check_interval_seconds ⇒ Numeric?

The approximate amount of time, in seconds, between health checks of an individual target.

Returns:

  • (Numeric, nil) 


268
269
270
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 268

def health_check_interval_seconds()
  jsii_get_property("healthCheckIntervalSeconds")
end

#health_check_interval_seconds=(value) ⇒ Object 



272
273
274
275
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 272

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?

[HTTP/HTTPS health checks] The destination for health checks on the targets.

Returns:

  • (String, nil) 


280
281
282
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 280

def health_check_path()
  jsii_get_property("healthCheckPath")
end

#health_check_path=(value) ⇒ Object 



284
285
286
287
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 284

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

The port the load balancer uses when performing health checks on targets.

Returns:

  • (String, nil) 


292
293
294
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 292

def health_check_port()
  jsii_get_property("healthCheckPort")
end

#health_check_port=(value) ⇒ Object 



296
297
298
299
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 296

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

#health_check_protocol ⇒ String?

The protocol the load balancer uses when performing health checks on targets.

Returns:

  • (String, nil) 


304
305
306
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 304

def health_check_protocol()
  jsii_get_property("healthCheckProtocol")
end

#health_check_protocol=(value) ⇒ Object 



308
309
310
311
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 308

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

#health_check_timeout_seconds ⇒ Numeric?

The amount of time, in seconds, during which no response from a target means a failed health check.

Returns:

  • (Numeric, nil) 


316
317
318
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 316

def health_check_timeout_seconds()
  jsii_get_property("healthCheckTimeoutSeconds")
end

#health_check_timeout_seconds=(value) ⇒ Object 



320
321
322
323
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 320

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

#healthy_threshold_count ⇒ Numeric?

The number of consecutive health check successes required before considering a target healthy.

Returns:

  • (Numeric, nil) 


328
329
330
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 328

def healthy_threshold_count()
  jsii_get_property("healthyThresholdCount")
end

#healthy_threshold_count=(value) ⇒ Object 



332
333
334
335
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 332

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



781
782
783
784
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 781

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

#ip_address_type ⇒ String?

The IP address type.

Returns:

  • (String, nil) 


340
341
342
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 340

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



344
345
346
347
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 344

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


130
131
132
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#matcher ⇒ AWSCDK::IResolvable, ...

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

Returns:



352
353
354
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 352

def matcher()
  jsii_get_property("matcher")
end

#matcher=(value) ⇒ Object 



356
357
358
359
360
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 356

def matcher=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::CfnTargetGroup::MatcherProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLkNmblRhcmdldEdyb3VwLk1hdGNoZXJQcm9wZXJ0eSJ9XX19")), "matcher") unless value.nil?
  jsii_set_property("matcher", value)
end

#name ⇒ String?

The name of the target group.

Returns:

  • (String, nil) 


365
366
367
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 365

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



369
370
371
372
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 369

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) 


113
114
115
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 113

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:



722
723
724
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 722

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:



729
730
731
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 729

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.



522
523
524
525
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 522

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 ⇒ Numeric?

The port on which the targets receive traffic.

Returns:

  • (Numeric, nil) 


377
378
379
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 377

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



381
382
383
384
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 381

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

#protocol ⇒ String?

The protocol to use for routing traffic to the targets.

Returns:

  • (String, nil) 


389
390
391
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 389

def protocol()
  jsii_get_property("protocol")
end

#protocol=(value) ⇒ Object 



393
394
395
396
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 393

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

#protocol_version ⇒ String?

[HTTP/HTTPS protocol] The protocol version.

Returns:

  • (String, nil) 


401
402
403
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 401

def protocol_version()
  jsii_get_property("protocolVersion")
end

#protocol_version=(value) ⇒ Object 



405
406
407
408
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 405

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


149
150
151
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 149

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:



740
741
742
743
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 740

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


747
748
749
750
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 747

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:



757
758
759
760
761
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 757

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.



766
767
768
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 766

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:



139
140
141
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 139

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



242
243
244
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 242

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags.

Returns:



413
414
415
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 413

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



417
418
419
420
421
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 417

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

#target_control_port ⇒ Numeric?

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

Returns:

  • (Numeric, nil) 


426
427
428
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 426

def target_control_port()
  jsii_get_property("targetControlPort")
end

#target_control_port=(value) ⇒ Object 



430
431
432
433
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 430

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

#target_group_attributes ⇒ AWSCDK::IResolvable, ...

The target group attributes.

Returns:



438
439
440
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 438

def target_group_attributes()
  jsii_get_property("targetGroupAttributes")
end

#target_group_attributes=(value) ⇒ Object 



442
443
444
445
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 442

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

#target_group_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancingv2::TargetGroupReference

A reference to a TargetGroup resource.

Returns:



249
250
251
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 249

def target_group_ref()
  jsii_get_property("targetGroupRef")
end

#target_type ⇒ String?

The type of target that you must specify when registering targets with this target group.

Returns:

  • (String, nil) 


462
463
464
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 462

def target_type()
  jsii_get_property("targetType")
end

#target_type=(value) ⇒ Object 



466
467
468
469
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 466

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

#targets ⇒ AWSCDK::IResolvable, ...

The targets.

Returns:



450
451
452
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 450

def targets()
  jsii_get_property("targets")
end

#targets=(value) ⇒ Object 



454
455
456
457
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 454

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



498
499
500
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 498

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

#unhealthy_threshold_count ⇒ Numeric?

The number of consecutive health check failures required before considering a target unhealthy.

Returns:

  • (Numeric, nil) 


474
475
476
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 474

def unhealthy_threshold_count()
  jsii_get_property("unhealthyThresholdCount")
end

#unhealthy_threshold_count=(value) ⇒ Object 



478
479
480
481
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 478

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


186
187
188
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 186

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


196
197
198
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


772
773
774
775
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 772

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 identifier of the virtual private cloud (VPC).

Returns:

  • (String, nil) 


486
487
488
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 486

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



490
491
492
493
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 490

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


511
512
513
514
515
516
 
# File 'elastic_load_balancingv2/cfn_target_group.rb', line 511

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