Interface ICfnLoadBalancerProps
Properties for defining a CfnLoadBalancer.
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public interface ICfnLoadBalancerPropsSyntax (vb)
Public Interface 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 {
IpAddressType = "ipAddressType",
LoadBalancerAttributes = new [] { new LoadBalancerAttributeProperty {
Key = "key",
Value = "value"
} },
Name = "name",
Scheme = "scheme",
SecurityGroups = new [] { "securityGroups" },
SubnetMappings = new [] { new SubnetMappingProperty {
SubnetId = "subnetId",
// the properties below are optional
AllocationId = "allocationId",
IPv6Address = "iPv6Address",
PrivateIPv4Address = "privateIPv4Address"
} },
Subnets = new [] { "subnets" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
};Synopsis
Properties
| IpAddressType | The IP address type. |
| LoadBalancerAttributes | The load balancer attributes. |
| Name | The name of the load balancer. |
| Scheme | The nodes of an Internet-facing load balancer have public IP addresses. |
| SecurityGroups | [Application Load Balancers] The IDs of the security groups for the load balancer. |
| SubnetMappings | The IDs of the public subnets. |
| Subnets | The IDs of the public subnets. |
| Tags | The tags to assign to the load balancer. |
| Type | The type of load balancer. |
Properties
IpAddressType
The IP address type.
virtual string IpAddressType { get; }Property Value
System.String
Remarks
The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
LoadBalancerAttributes
The load balancer attributes.
virtual object LoadBalancerAttributes { get; }Property Value
System.Object
Remarks
Name
The name of the load balancer.
virtual string Name { get; }Property Value
System.String
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.
virtual string Scheme { get; }Property Value
System.String
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 cannot specify a scheme for a Gateway Load Balancer.
SecurityGroups
[Application Load Balancers] The IDs of the security groups for the load balancer.
virtual string[] SecurityGroups { get; }Property Value
System.String[]
Remarks
SubnetMappings
The IDs of the public subnets.
virtual object SubnetMappings { get; }Property Value
System.Object
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 cannot 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 cannot specify Elastic IP addresses for your subnets.
Subnets
The IDs of the public subnets.
virtual string[] Subnets { get; }Property Value
System.String[]
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] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
Tags
The tags to assign to the load balancer.
virtual ICfnTag[] Tags { get; }Property Value
ICfnTag[]
Remarks
Type
The type of load balancer.
virtual string Type { get; }Property Value
System.String