Class: AWSCDK::ElasticLoadBalancingv2::CfnLoadBalancer

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

Overview

Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ElasticLoadBalancingV2::LoadBalancer.

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::CfnLoadBalancerProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 18

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

Class Method Details

.arn_for_load_balancer(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 90

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_load_balancer(x) ⇒ Boolean

Checks whether the given object is a CfnLoadBalancer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 99

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_elasticloadbalancingv2.CfnLoadBalancer", "isCfnLoadBalancer", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_canonical_hosted_zone_id => { kind: :property, name: "attrCanonicalHostedZoneId", is_optional: false },
    :attr_dns_name => { kind: :property, name: "attrDnsName", is_optional: false },
    :attr_load_balancer_arn => { kind: :property, name: "attrLoadBalancerArn", is_optional: false },
    :attr_load_balancer_full_name => { kind: :property, name: "attrLoadBalancerFullName", is_optional: false },
    :attr_load_balancer_name => { kind: :property, name: "attrLoadBalancerName", is_optional: false },
    :attr_security_groups => { kind: :property, name: "attrSecurityGroups", is_optional: false },
    :load_balancer_ref => { kind: :property, name: "loadBalancerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :enable_capacity_reservation_provision_stabilize => { kind: :property, name: "enableCapacityReservationProvisionStabilize", is_optional: true },
    :enable_prefix_for_ipv6_source_nat => { kind: :property, name: "enablePrefixForIpv6SourceNat", is_optional: true },
    :enforce_security_group_inbound_rules_on_private_link_traffic => { kind: :property, name: "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :ipv4_ipam_pool_id => { kind: :property, name: "ipv4IpamPoolId", is_optional: true },
    :load_balancer_attributes => { kind: :property, name: "loadBalancerAttributes", is_optional: true },
    :minimum_load_balancer_capacity => { kind: :property, name: "minimumLoadBalancerCapacity", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :scheme => { kind: :property, name: "scheme", is_optional: true },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: true },
    :subnet_mappings => { kind: :property, name: "subnetMappings", is_optional: true },
    :subnets => { kind: :property, name: "subnets", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :type => { kind: :property, name: "type", 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.



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

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:



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

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:



495
496
497
498
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 495

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:



506
507
508
509
510
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 506

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.


563
564
565
566
567
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 563

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.



573
574
575
576
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 573

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.



585
586
587
588
589
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 585

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:



598
599
600
601
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 598

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:



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

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

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

For example, Z2P70J7EXAMPLE .

Returns:

  • (String) 


206
207
208
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 206

def attr_canonical_hosted_zone_id()
  jsii_get_property("attrCanonicalHostedZoneId")
end

#attr_dns_name ⇒ String

The DNS name for the load balancer.

For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com .

Returns:

  • (String) 


215
216
217
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 215

def attr_dns_name()
  jsii_get_property("attrDnsName")
end

#attr_load_balancer_arn ⇒ String

The Amazon Resource Name (ARN) of the load balancer.

Returns:

  • (String) 


222
223
224
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 222

def attr_load_balancer_arn()
  jsii_get_property("attrLoadBalancerArn")
end

#attr_load_balancer_full_name ⇒ String

The full name of the load balancer.

For example, app/my-load-balancer/50dc6c495c0c9188 .

Returns:

  • (String) 


231
232
233
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 231

def attr_load_balancer_full_name()
  jsii_get_property("attrLoadBalancerFullName")
end

#attr_load_balancer_name ⇒ String

The name of the load balancer.

For example, my-load-balancer .

Returns:

  • (String) 


240
241
242
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 240

def attr_load_balancer_name()
  jsii_get_property("attrLoadBalancerName")
end

#attr_security_groups ⇒ Array<String>

The IDs of the security groups for the load balancer.

Returns:

  • (Array<String>) 


247
248
249
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 247

def attr_security_groups()
  jsii_get_property("attrSecurityGroups")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


629
630
631
632
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 629

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_capacity_reservation_provision_stabilize ⇒ Boolean, ...

Indicates whether to enable stabilization when creating or updating an LCU reservation.

Returns:



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

def enable_capacity_reservation_provision_stabilize()
  jsii_get_property("enableCapacityReservationProvisionStabilize")
end

#enable_capacity_reservation_provision_stabilize=(value) ⇒ Object 



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

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

#enable_prefix_for_ipv6_source_nat ⇒ String?

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.

Returns:

  • (String, nil) 


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

def enable_prefix_for_ipv6_source_nat()
  jsii_get_property("enablePrefixForIpv6SourceNat")
end

#enable_prefix_for_ipv6_source_nat=(value) ⇒ Object 



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

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

#enforce_security_group_inbound_rules_on_private_link_traffic ⇒ String?

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .

Returns:

  • (String, nil) 


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

def enforce_security_group_inbound_rules_on_private_link_traffic()
  jsii_get_property("enforceSecurityGroupInboundRulesOnPrivateLinkTraffic")
end

#enforce_security_group_inbound_rules_on_private_link_traffic=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



642
643
644
645
646
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 642

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:



653
654
655
656
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 653

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



723
724
725
726
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 723

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.

Internal load balancers must use ipv4 .

Returns:

  • (String, nil) 


306
307
308
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 306

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



310
311
312
313
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 310

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

#ipv4_ipam_pool_id ⇒ String?

The ID of the IPv4 IPAM pool.

Returns:

  • (String, nil) 


318
319
320
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 318

def ipv4_ipam_pool_id()
  jsii_get_property("ipv4IpamPoolId")
end

#ipv4_ipam_pool_id=(value) ⇒ Object 



322
323
324
325
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 322

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

#load_balancer_attributes ⇒ AWSCDK::IResolvable, ...

The load balancer attributes.

Returns:



330
331
332
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 330

def load_balancer_attributes()
  jsii_get_property("loadBalancerAttributes")
end

#load_balancer_attributes=(value) ⇒ Object 



334
335
336
337
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 334

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

#load_balancer_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancingv2::LoadBalancerReference

A reference to a LoadBalancer resource.

Returns:



254
255
256
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 254

def load_balancer_ref()
  jsii_get_property("loadBalancerRef")
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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#minimum_load_balancer_capacity ⇒ AWSCDK::IResolvable, ...

The minimum capacity for a load balancer.

Returns:



342
343
344
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 342

def minimum_load_balancer_capacity()
  jsii_get_property("minimumLoadBalancerCapacity")
end

#minimum_load_balancer_capacity=(value) ⇒ Object 



346
347
348
349
350
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 346

def minimum_load_balancer_capacity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::CfnLoadBalancer::MinimumLoadBalancerCapacityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLkNmbkxvYWRCYWxhbmNlci5NaW5pbXVtTG9hZEJhbGFuY2VyQ2FwYWNpdHlQcm9wZXJ0eSJ9XX19")), "minimumLoadBalancerCapacity") unless value.nil?
  jsii_set_property("minimumLoadBalancerCapacity", value)
end

#name ⇒ String?

The name of the load balancer.

Returns:

  • (String, nil) 


355
356
357
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 355

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



359
360
361
362
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 359

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) 


107
108
109
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 107

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:



664
665
666
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 664

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:



671
672
673
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 671

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.



464
465
466
467
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 464

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

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

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

Returns:

  • (String) 


143
144
145
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 143

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:



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

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


689
690
691
692
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 689

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:



699
700
701
702
703
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 699

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

#scheme ⇒ String?

The nodes of an Internet-facing load balancer have public IP addresses.

Returns:

  • (String, nil) 


367
368
369
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 367

def scheme()
  jsii_get_property("scheme")
end

#scheme=(value) ⇒ Object 



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

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

[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.

Returns:

  • (Array<String>, nil) 


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

def security_groups()
  jsii_get_property("securityGroups")
end

#security_groups=(value) ⇒ Object 



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

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



708
709
710
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 708

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:



133
134
135
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 133

def stack()
  jsii_get_property("stack")
end

#subnet_mappings ⇒ AWSCDK::IResolvable, ...

The IDs of the subnets.

Returns:



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

def subnet_mappings()
  jsii_get_property("subnetMappings")
end

#subnet_mappings=(value) ⇒ Object 



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

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

#subnets ⇒ Array<String>?

The IDs of the subnets.

Returns:

  • (Array<String>, nil) 


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

def subnets()
  jsii_get_property("subnets")
end

#subnets=(value) ⇒ Object 



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

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to assign to the load balancer.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



440
441
442
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 440

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

#type ⇒ String?

The type of load balancer.

Returns:

  • (String, nil) 


428
429
430
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 428

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



432
433
434
435
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 432

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 180

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


190
191
192
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


714
715
716
717
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 714

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) 


453
454
455
456
457
458
 
# File 'elastic_load_balancingv2/cfn_load_balancer.rb', line 453

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