Interface BaseLoadBalancerProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ApplicationLoadBalancerProps, NetworkLoadBalancerProps
All Known Implementing Classes:
ApplicationLoadBalancerProps.Jsii$Proxy, BaseLoadBalancerProps.Jsii$Proxy, NetworkLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:18.824Z") @Stability(Stable) public interface BaseLoadBalancerProps extends software.amazon.jsii.JsiiSerializable
Shared properties of both Application and Network Load Balancers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 BaseLoadBalancerProps baseLoadBalancerProps = BaseLoadBalancerProps.builder()
         .vpc(vpc)
         // the properties below are optional
         .crossZoneEnabled(false)
         .deletionProtection(false)
         .denyAllIgwTraffic(false)
         .internetFacing(false)
         .loadBalancerName("loadBalancerName")
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 
  • Method Details

    • getVpc

      @Stability(Stable) @NotNull IVpc getVpc()
      The VPC network to place the load balancer in.
    • getCrossZoneEnabled

      @Stability(Stable) @Nullable default Boolean getCrossZoneEnabled()
      Indicates whether cross-zone load balancing is enabled.

      Default: - false for Network Load Balancers and true for Application Load Balancers. This can not be `false` for Application Load Balancers.

      See Also:
    • getDeletionProtection

      @Stability(Stable) @Nullable default Boolean getDeletionProtection()
      Indicates whether deletion protection is enabled.

      Default: false

    • getDenyAllIgwTraffic

      @Stability(Stable) @Nullable default Boolean getDenyAllIgwTraffic()
      Indicates whether the load balancer blocks traffic through the Internet Gateway (IGW).

      Default: - false for internet-facing load balancers and true for internal load balancers

    • getInternetFacing

      @Stability(Stable) @Nullable default Boolean getInternetFacing()
      Whether the load balancer has an internet-routable address.

      Default: false

    • getLoadBalancerName

      @Stability(Stable) @Nullable default String getLoadBalancerName()
      Name of the load balancer.

      Default: - Automatically generated name.

    • getVpcSubnets

      @Stability(Stable) @Nullable default SubnetSelection getVpcSubnets()
      Which subnets place the load balancer in.

      Default: - the Vpc default strategy.

    • builder

      @Stability(Stable) static BaseLoadBalancerProps.Builder builder()
      Returns:
      a BaseLoadBalancerProps.Builder of BaseLoadBalancerProps