Interface OptionConfiguration

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:57.166Z") @Stability(Stable) public interface OptionConfiguration extends software.amazon.jsii.JsiiSerializable
Configuration properties for an option.

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.rds.*;
 SecurityGroup securityGroup;
 Vpc vpc;
 OptionConfiguration optionConfiguration = OptionConfiguration.builder()
         .name("name")
         // the properties below are optional
         .port(123)
         .securityGroups(List.of(securityGroup))
         .settings(Map.of(
                 "settingsKey", "settings"))
         .version("version")
         .vpc(vpc)
         .build();
 
  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the option.
    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      The port number that this option uses.

      If port is specified then vpc must also be specified.

      Default: - no port

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<ISecurityGroup> getSecurityGroups()
      Optional list of security groups to use for this option, if vpc is specified.

      If no groups are provided, a default one will be created.

      Default: - a default group will be created if `port` or `vpc` are specified.

    • getSettings

      @Stability(Stable) @Nullable default Map<String,String> getSettings()
      The settings for the option.

      Default: - no settings

    • getVersion

      @Stability(Stable) @Nullable default String getVersion()
      The version for the option.

      Default: - no version

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      The VPC where a security group should be created for this option.

      If vpc is specified then port must also be specified.

      Default: - no VPC

    • builder

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