Class CfnLoadBalancerProps
Properties for defining a CfnLoadBalancer.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLoadBalancerProps : Object, ICfnLoadBalancerPropsSyntax (vb)
Public Class CfnLoadBalancerProps
Inherits Object
Implements ICfnLoadBalancerPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
var cfnLoadBalancerProps = new CfnLoadBalancerProps {
EnablePrefixForIpv6SourceNat = "enablePrefixForIpv6SourceNat",
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic = "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic",
IpAddressType = "ipAddressType",
LoadBalancerAttributes = new [] { new LoadBalancerAttributeProperty {
Key = "key",
Value = "value"
} },
MinimumLoadBalancerCapacity = new MinimumLoadBalancerCapacityProperty {
CapacityUnits = 123
},
Name = "name",
Scheme = "scheme",
SecurityGroups = new [] { "securityGroups" },
SubnetMappings = new [] { new SubnetMappingProperty {
SubnetId = "subnetId",
// the properties below are optional
AllocationId = "allocationId",
IPv6Address = "iPv6Address",
PrivateIPv4Address = "privateIPv4Address",
SourceNatIpv6Prefix = "sourceNatIpv6Prefix"
} },
Subnets = new [] { "subnets" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
};Synopsis
Constructors
| Cfn |
Properties
| Enable |
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. |
| Enforce |
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink . |
| Ip |
The IP address type. Internal load balancers must use |
| Load |
The load balancer attributes. |
| Minimum |
The minimum capacity for a load balancer. |
| Name | The name of the load balancer. |
| Scheme | The nodes of an Internet-facing load balancer have public IP addresses. |
| Security |
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
| Subnet |
The IDs of the subnets. |
| Subnets | The IDs of the subnets. |
| Tags | The tags to assign to the load balancer. |
| Type | The type of load balancer. |
Constructors
CfnLoadBalancerProps()
public CfnLoadBalancerProps()Properties
EnablePrefixForIpv6SourceNat
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
public string EnablePrefixForIpv6SourceNat { get; set; }Property Value
System.
Remarks
The IP address type must be dualstack . The default value is off .
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .
public string EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic { get; set; }Property Value
System.
Remarks
IpAddressType
The IP address type. Internal load balancers must use ipv4 .
public string IpAddressType { get; set; }Property Value
System.
Remarks
[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).
LoadBalancerAttributes
The load balancer attributes.
public object LoadBalancerAttributes { get; set; }Property Value
System.
Remarks
MinimumLoadBalancerCapacity
The minimum capacity for a load balancer.
public object MinimumLoadBalancerCapacity { get; set; }Property Value
System.
Remarks
Name
The name of the load balancer.
public string Name { get; set; }Property Value
System.
Remarks
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.
Scheme
The nodes of an Internet-facing load balancer have public IP addresses.
public string Scheme { get; set; }Property Value
System.
Remarks
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.
SecurityGroups
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
public string[] SecurityGroups { get; set; }Property Value
System.
Remarks
SubnetMappings
The IDs of the subnets.
public object SubnetMappings { get; set; }Property Value
System.
Remarks
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.
Subnets
The IDs of the subnets.
public string[] Subnets { get; set; }Property Value
System.
Remarks
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.
Tags
The tags to assign to the load balancer.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
Type
The type of load balancer.
public string Type { get; set; }Property Value
System.