Class: AWSCDK::ElasticLoadBalancing::CfnLoadBalancer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSElasticloadbalancing::ILoadBalancerRef
Defined in:
elastic_load_balancing/cfn_load_balancer.rb

Overview

Specifies a Classic Load Balancer.

If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLoadBalancer

Create a new AWS::ElasticLoadBalancing::LoadBalancer.

Parameters:



20
21
22
23
24
25
26
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 20

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

Class Method Details

.arn_for_load_balancer(resource) ⇒ String

Parameters:

Returns:

  • (String)


94
95
96
97
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 94

def self.arn_for_load_balancer(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZy5JTG9hZEJhbGFuY2VyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancing.CfnLoadBalancer", "arnForLoadBalancer", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


214
215
216
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 214

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

.from_load_balancer_name(scope, id, load_balancer_name) ⇒ AWSCDK::Interfaces::AWSElasticloadbalancing::ILoadBalancerRef

Creates a new ILoadBalancerRef from a loadBalancerName.

Parameters:

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

Returns:



105
106
107
108
109
110
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 105

def self.from_load_balancer_name(scope, id, load_balancer_name)
  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(load_balancer_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancing.CfnLoadBalancer", "fromLoadBalancerName", [scope, id, load_balancer_name])
end

.is_cfn_load_balancer(x) ⇒ Boolean

Checks whether the given object is a CfnLoadBalancer.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


116
117
118
119
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 116

def self.is_cfn_load_balancer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancing.CfnLoadBalancer", "isCfnLoadBalancer", [x])
end

.jsii_overridable_methodsObject



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
# File 'elastic_load_balancing/cfn_load_balancer.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_canonical_hosted_zone_name => { kind: :property, name: "attrCanonicalHostedZoneName", is_optional: false },
    :attr_canonical_hosted_zone_name_id => { kind: :property, name: "attrCanonicalHostedZoneNameId", is_optional: false },
    :attr_dns_name => { kind: :property, name: "attrDnsName", is_optional: false },
    :attr_source_security_group => { kind: :property, name: "attrSourceSecurityGroup", is_optional: false },
    :attr_source_security_group_group_name => { kind: :property, name: "attrSourceSecurityGroupGroupName", is_optional: false },
    :attr_source_security_group_owner_alias => { kind: :property, name: "attrSourceSecurityGroupOwnerAlias", is_optional: false },
    :load_balancer_ref => { kind: :property, name: "loadBalancerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :listeners => { kind: :property, name: "listeners", is_optional: false },
    :access_logging_policy => { kind: :property, name: "accessLoggingPolicy", is_optional: true },
    :app_cookie_stickiness_policy => { kind: :property, name: "appCookieStickinessPolicy", is_optional: true },
    :availability_zones => { kind: :property, name: "availabilityZones", is_optional: true },
    :connection_draining_policy => { kind: :property, name: "connectionDrainingPolicy", is_optional: true },
    :connection_settings => { kind: :property, name: "connectionSettings", is_optional: true },
    :cross_zone => { kind: :property, name: "crossZone", is_optional: true },
    :health_check => { kind: :property, name: "healthCheck", is_optional: true },
    :instances => { kind: :property, name: "instances", is_optional: true },
    :lb_cookie_stickiness_policy => { kind: :property, name: "lbCookieStickinessPolicy", is_optional: true },
    :load_balancer_name => { kind: :property, name: "loadBalancerName", is_optional: true },
    :policies => { kind: :property, name: "policies", is_optional: true },
    :scheme => { kind: :property, name: "scheme", is_optional: true },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: true },
    :subnets => { kind: :property, name: "subnets", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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

#access_logging_policyAWSCDK::IResolvable, ...

Information about where and how access logs are stored for the load balancer.



291
292
293
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 291

def access_logging_policy()
  jsii_get_property("accessLoggingPolicy")
end

#access_logging_policy=(value) ⇒ Object



295
296
297
298
299
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 295

def access_logging_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::AccessLoggingPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZy5DZm5Mb2FkQmFsYW5jZXIuQWNjZXNzTG9nZ2luZ1BvbGljeVByb3BlcnR5In1dfX0=")), "accessLoggingPolicy") unless value.nil?
  jsii_set_property("accessLoggingPolicy", value)
end

#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.



513
514
515
516
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 513

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:



525
526
527
528
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 525

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:



535
536
537
538
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 535

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.



546
547
548
549
550
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 546

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

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


603
604
605
606
607
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 603

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.



613
614
615
616
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 613

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.



625
626
627
628
629
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 625

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

Information about a policy for application-controlled session stickiness.



304
305
306
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 304

def app_cookie_stickiness_policy()
  jsii_get_property("appCookieStickinessPolicy")
end


308
309
310
311
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 308

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



638
639
640
641
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 638

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:



660
661
662
663
664
665
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 660

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_canonical_hosted_zone_nameString

The name of the Route 53 hosted zone that is associated with the load balancer.

Internal-facing load balancers don't use this value, use DNSName instead.

Returns:

  • (String)


223
224
225
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 223

def attr_canonical_hosted_zone_name()
  jsii_get_property("attrCanonicalHostedZoneName")
end

#attr_canonical_hosted_zone_name_idString

The ID of the Route 53 hosted zone name that is associated with the load balancer.

Returns:

  • (String)


230
231
232
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 230

def attr_canonical_hosted_zone_name_id()
  jsii_get_property("attrCanonicalHostedZoneNameId")
end

#attr_dns_nameString

The DNS name for the load balancer.

Returns:

  • (String)


237
238
239
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 237

def attr_dns_name()
  jsii_get_property("attrDnsName")
end

#attr_source_security_groupAWSCDK::IResolvable

Returns:



242
243
244
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 242

def attr_source_security_group()
  jsii_get_property("attrSourceSecurityGroup")
end

#attr_source_security_group_group_nameString

The name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.

Returns:

  • (String)


249
250
251
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 249

def attr_source_security_group_group_name()
  jsii_get_property("attrSourceSecurityGroupGroupName")
end

#attr_source_security_group_owner_aliasString

The owner of the source security group.

Returns:

  • (String)


256
257
258
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 256

def attr_source_security_group_owner_alias()
  jsii_get_property("attrSourceSecurityGroupOwnerAlias")
end

#availability_zonesArray<String>?

The Availability Zones for a load balancer in a default VPC.

Returns:

  • (Array<String>, nil)


316
317
318
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 316

def availability_zones()
  jsii_get_property("availabilityZones")
end

#availability_zones=(value) ⇒ Object



320
321
322
323
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 320

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

#cfn_optionsAWSCDK::ICfnResourceOptions

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



167
168
169
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 167

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


172
173
174
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 172

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


669
670
671
672
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 669

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


177
178
179
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 177

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


184
185
186
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 184

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connection_draining_policyAWSCDK::IResolvable, ...

If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.



328
329
330
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 328

def connection_draining_policy()
  jsii_get_property("connectionDrainingPolicy")
end

#connection_draining_policy=(value) ⇒ Object



332
333
334
335
336
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 332

def connection_draining_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::ConnectionDrainingPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZy5DZm5Mb2FkQmFsYW5jZXIuQ29ubmVjdGlvbkRyYWluaW5nUG9saWN5UHJvcGVydHkifV19fQ==")), "connectionDrainingPolicy") unless value.nil?
  jsii_set_property("connectionDrainingPolicy", value)
end

#connection_settingsAWSCDK::IResolvable, ...

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.



341
342
343
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 341

def connection_settings()
  jsii_get_property("connectionSettings")
end

#connection_settings=(value) ⇒ Object



345
346
347
348
349
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 345

def connection_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::ConnectionSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZy5DZm5Mb2FkQmFsYW5jZXIuQ29ubmVjdGlvblNldHRpbmdzUHJvcGVydHkifV19fQ==")), "connectionSettings") unless value.nil?
  jsii_set_property("connectionSettings", value)
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


129
130
131
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 129

def creation_stack()
  jsii_get_property("creationStack")
end

#cross_zoneBoolean, ...

If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

Returns:



354
355
356
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 354

def cross_zone()
  jsii_get_property("crossZone")
end

#cross_zone=(value) ⇒ Object



358
359
360
361
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 358

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

#envAWSCDK::Interfaces::ResourceEnvironment



189
190
191
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 189

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:



682
683
684
685
686
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 682

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.



693
694
695
696
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 693

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

#health_checkAWSCDK::IResolvable, ...

The health check settings to use when evaluating the health of your EC2 instances.



366
367
368
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 366

def health_check()
  jsii_get_property("healthCheck")
end

#health_check=(value) ⇒ Object



370
371
372
373
374
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 370

def health_check=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::HealthCheckProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZy5DZm5Mb2FkQmFsYW5jZXIuSGVhbHRoQ2hlY2tQcm9wZXJ0eSJ9XX19")), "healthCheck") unless value.nil?
  jsii_set_property("healthCheck", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



763
764
765
766
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 763

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

#instancesArray<String>?

The IDs of the instances for the load balancer.

Returns:

  • (Array<String>, nil)


379
380
381
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 379

def instances()
  jsii_get_property("instances")
end

#instances=(value) ⇒ Object



383
384
385
386
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 383

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

Information about a policy for duration-based session stickiness.



391
392
393
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 391

def lb_cookie_stickiness_policy()
  jsii_get_property("lbCookieStickinessPolicy")
end


395
396
397
398
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 395

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

#listenersAWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::ListenersProperty>

The listeners for the load balancer.

You can specify at most one listener per port.



279
280
281
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 279

def listeners()
  jsii_get_property("listeners")
end

#listeners=(value) ⇒ Object



283
284
285
286
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 283

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

#load_balancer_nameString?

The name of the load balancer.

Returns:

  • (String, nil)


403
404
405
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 403

def load_balancer_name()
  jsii_get_property("loadBalancerName")
end

#load_balancer_name=(value) ⇒ Object



407
408
409
410
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 407

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

#load_balancer_refAWSCDK::Interfaces::AWSElasticloadbalancing::LoadBalancerReference

A reference to a LoadBalancer resource.



263
264
265
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 263

def load_balancer_ref()
  jsii_get_property("loadBalancerRef")
end

#logical_idString

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


141
142
143
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 141

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


124
125
126
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 124

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



704
705
706
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 704

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



711
712
713
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 711

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.



504
505
506
507
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 504

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

#policiesAWSCDK::IResolvable, ...

The policies defined for your Classic Load Balancer.



415
416
417
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 415

def policies()
  jsii_get_property("policies")
end

#policies=(value) ⇒ Object



419
420
421
422
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 419

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

#refString

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

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

Returns:

  • (String)


160
161
162
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 160

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:



722
723
724
725
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 722

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


729
730
731
732
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 729

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:



739
740
741
742
743
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 739

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

#schemeString?

The type of load balancer.

Valid only for load balancers in a VPC.

Returns:

  • (String, nil)


429
430
431
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 429

def scheme()
  jsii_get_property("scheme")
end

#scheme=(value) ⇒ Object



433
434
435
436
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 433

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

#security_groupsArray<String>?

The security groups for the load balancer.

Returns:

  • (Array<String>, nil)


441
442
443
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 441

def security_groups()
  jsii_get_property("securityGroups")
end

#security_groups=(value) ⇒ Object



445
446
447
448
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 445

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

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



748
749
750
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 748

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



150
151
152
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 150

def stack()
  jsii_get_property("stack")
end

#subnetsArray<String>?

The IDs of the subnets for the load balancer.

You can specify at most one subnet per Availability Zone.

Returns:

  • (Array<String>, nil)


455
456
457
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 455

def subnets()
  jsii_get_property("subnets")
end

#subnets=(value) ⇒ Object



459
460
461
462
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 459

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

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



270
271
272
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 270

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

The tags associated with a load balancer.

Returns:



467
468
469
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 467

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



471
472
473
474
475
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 471

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



480
481
482
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 480

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

#updated_properitesHash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object})


197
198
199
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 197

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


207
208
209
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 207

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


754
755
756
757
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 754

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)


493
494
495
496
497
498
# File 'elastic_load_balancing/cfn_load_balancer.rb', line 493

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