Class: AWSCDK::ElasticLoadBalancingv2::CfnLoadBalancerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elastic_load_balancingv2/cfn_load_balancer_props.rb

Overview

Properties for defining a CfnLoadBalancer.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enable_capacity_reservation_provision_stabilize: nil, enable_prefix_for_ipv6_source_nat: nil, enforce_security_group_inbound_rules_on_private_link_traffic: nil, ip_address_type: nil, ipv4_ipam_pool_id: nil, load_balancer_attributes: nil, minimum_load_balancer_capacity: nil, name: nil, scheme: nil, security_groups: nil, subnet_mappings: nil, subnets: nil, tags: nil, type: nil) ⇒ CfnLoadBalancerProps

Returns a new instance of CfnLoadBalancerProps.

Parameters:



23
24
25
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
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 23

def initialize(enable_capacity_reservation_provision_stabilize: nil, enable_prefix_for_ipv6_source_nat: nil, enforce_security_group_inbound_rules_on_private_link_traffic: nil, ip_address_type: nil, ipv4_ipam_pool_id: nil, load_balancer_attributes: nil, minimum_load_balancer_capacity: nil, name: nil, scheme: nil, security_groups: nil, subnet_mappings: nil, subnets: nil, tags: nil, type: nil)
  @enable_capacity_reservation_provision_stabilize = enable_capacity_reservation_provision_stabilize
  Jsii::Type.check_type(@enable_capacity_reservation_provision_stabilize, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableCapacityReservationProvisionStabilize") unless @enable_capacity_reservation_provision_stabilize.nil?
  @enable_prefix_for_ipv6_source_nat = enable_prefix_for_ipv6_source_nat
  Jsii::Type.check_type(@enable_prefix_for_ipv6_source_nat, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enablePrefixForIpv6SourceNat") unless @enable_prefix_for_ipv6_source_nat.nil?
  @enforce_security_group_inbound_rules_on_private_link_traffic = enforce_security_group_inbound_rules_on_private_link_traffic
  Jsii::Type.check_type(@enforce_security_group_inbound_rules_on_private_link_traffic, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic") unless @enforce_security_group_inbound_rules_on_private_link_traffic.nil?
  @ip_address_type = ip_address_type
  Jsii::Type.check_type(@ip_address_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless @ip_address_type.nil?
  @ipv4_ipam_pool_id = ipv4_ipam_pool_id
  Jsii::Type.check_type(@ipv4_ipam_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipv4IpamPoolId") unless @ipv4_ipam_pool_id.nil?
  @load_balancer_attributes = load_balancer_attributes
  Jsii::Type.check_type(@load_balancer_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5DZm5Mb2FkQmFsYW5jZXIuTG9hZEJhbGFuY2VyQXR0cmlidXRlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "loadBalancerAttributes") unless @load_balancer_attributes.nil?
  @minimum_load_balancer_capacity = minimum_load_balancer_capacity.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::CfnLoadBalancer::MinimumLoadBalancerCapacityProperty.new(**minimum_load_balancer_capacity.transform_keys(&:to_sym)) : minimum_load_balancer_capacity
  Jsii::Type.check_type(@minimum_load_balancer_capacity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLkNmbkxvYWRCYWxhbmNlci5NaW5pbXVtTG9hZEJhbGFuY2VyQ2FwYWNpdHlQcm9wZXJ0eSJ9XX19")), "minimumLoadBalancerCapacity") unless @minimum_load_balancer_capacity.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @scheme = scheme
  Jsii::Type.check_type(@scheme, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheme") unless @scheme.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU2VjdXJpdHlHcm91cFJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") unless @security_groups.nil?
  @subnet_mappings = subnet_mappings
  Jsii::Type.check_type(@subnet_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5DZm5Mb2FkQmFsYW5jZXIuU3VibmV0TWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "subnetMappings") unless @subnet_mappings.nil?
  @subnets = subnets
  Jsii::Type.check_type(@subnets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU3VibmV0UmVmIn1dfX0sImtpbmQiOiJhcnJheSJ9fQ==")), "subnets") unless @subnets.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#enable_capacity_reservation_provision_stabilize ⇒ Boolean, ... (readonly)

Note:

Default: - false

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

This ensures that the final stack status reflects the status of the LCU reservation. The default is false .

Returns:

See Also:



61
62
63
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 61

def enable_capacity_reservation_provision_stabilize
  @enable_capacity_reservation_provision_stabilize
end

#enable_prefix_for_ipv6_source_nat ⇒ String? (readonly)

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

The IP address type must be dualstack . The default value is off .

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 68

def enable_prefix_for_ipv6_source_nat
  @enable_prefix_for_ipv6_source_nat
end

#enforce_security_group_inbound_rules_on_private_link_traffic ⇒ String? (readonly)

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

The default is on .

You can't configure this property on a Network Load Balancer unless you associated a security group with the load balancer when you created it.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 77

def enforce_security_group_inbound_rules_on_private_link_traffic
  @enforce_security_group_inbound_rules_on_private_link_traffic
end

#ip_address_type ⇒ String? (readonly)

The IP address type. Internal load balancers must use ipv4 .

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 88

def ip_address_type
  @ip_address_type
end

#ipv4_ipam_pool_id ⇒ String? (readonly)

The ID of the IPv4 IPAM pool.

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 93

def ipv4_ipam_pool_id
  @ipv4_ipam_pool_id
end

#load_balancer_attributes ⇒ AWSCDK::IResolvable, ... (readonly)

The load balancer attributes.

Attributes that you do not modify retain their current values.

Returns:

See Also:



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

def load_balancer_attributes
  @load_balancer_attributes
end

#minimum_load_balancer_capacity ⇒ AWSCDK::IResolvable, ... (readonly)

The minimum capacity for a load balancer.

Returns:

See Also:



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

def minimum_load_balancer_capacity
  @minimum_load_balancer_capacity
end

#name ⇒ String? (readonly)

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.

Returns:

  • (String, nil)

See Also:



114
115
116
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 114

def name
  @name
end

#scheme ⇒ String? (readonly)

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

The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

You can't specify a scheme for a Gateway Load Balancer.

Returns:

  • (String, nil)

See Also:



127
128
129
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 127

def scheme
  @scheme
end

#security_groups ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>? (readonly)

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

Returns:

See Also:



132
133
134
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 132

def security_groups
  @security_groups
end

#subnet_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

The IDs of the subnets.

You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.

Returns:

See Also:



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

def subnet_mappings
  @subnet_mappings
end

#subnets ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISubnetRef>? (readonly)

The IDs of the subnets.

You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

Returns:

See Also:



164
165
166
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 164

def subnets
  @subnets
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to assign to the load balancer.

Returns:

See Also:



169
170
171
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 169

def tags
  @tags
end

#type ⇒ String? (readonly)

The type of load balancer.

The default is application .

Returns:

  • (String, nil)

See Also:



176
177
178
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 176

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 178

def self.jsii_properties
  {
    :enable_capacity_reservation_provision_stabilize => "enableCapacityReservationProvisionStabilize",
    :enable_prefix_for_ipv6_source_nat => "enablePrefixForIpv6SourceNat",
    :enforce_security_group_inbound_rules_on_private_link_traffic => "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic",
    :ip_address_type => "ipAddressType",
    :ipv4_ipam_pool_id => "ipv4IpamPoolId",
    :load_balancer_attributes => "loadBalancerAttributes",
    :minimum_load_balancer_capacity => "minimumLoadBalancerCapacity",
    :name => "name",
    :scheme => "scheme",
    :security_groups => "securityGroups",
    :subnet_mappings => "subnetMappings",
    :subnets => "subnets",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'elastic_load_balancingv2/cfn_load_balancer_props.rb', line 197

def to_jsii
  result = {}
  result.merge!({
    "enableCapacityReservationProvisionStabilize" => @enable_capacity_reservation_provision_stabilize,
    "enablePrefixForIpv6SourceNat" => @enable_prefix_for_ipv6_source_nat,
    "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic" => @enforce_security_group_inbound_rules_on_private_link_traffic,
    "ipAddressType" => @ip_address_type,
    "ipv4IpamPoolId" => @ipv4_ipam_pool_id,
    "loadBalancerAttributes" => @load_balancer_attributes,
    "minimumLoadBalancerCapacity" => @minimum_load_balancer_capacity,
    "name" => @name,
    "scheme" => @scheme,
    "securityGroups" => @security_groups,
    "subnetMappings" => @subnet_mappings,
    "subnets" => @subnets,
    "tags" => @tags,
    "type" => @type,
  })
  result.compact
end