Interface PortProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
PortProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-09-06T01:36:37.935Z") @Stability(Experimental) public interface PortProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties to create a port range.

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.gamelift.alpha.*;
 PortProps portProps = PortProps.builder()
         .fromPort(123)
         .protocol(Protocol.TCP)
         // the properties below are optional
         .toPort(123)
         .build();
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for PortProps
    static final class 
    An implementation for PortProps
  • Method Summary

    Modifier and Type
    Method
    Description
     
    (experimental) A starting value for a range of allowed port numbers.
    (experimental) The protocol for the range.
    default Number
    (experimental) An ending value for a range of allowed port numbers.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getFromPort

      @Stability(Experimental) @NotNull Number getFromPort()
      (experimental) A starting value for a range of allowed port numbers.

      For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

    • getProtocol

      @Stability(Experimental) @NotNull Protocol getProtocol()
      (experimental) The protocol for the range.
    • getToPort

      @Stability(Experimental) @Nullable default Number getToPort()
      (experimental) An ending value for a range of allowed port numbers.

      Port numbers are end-inclusive. This value must be higher than fromPort.

      For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

      Default: the `fromPort` value

    • builder

      @Stability(Experimental) static PortProps.Builder builder()
      Returns:
      a PortProps.Builder of PortProps