Interface CfnOptionGroupProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.077Z") @Stability(Stable) public interface CfnOptionGroupProps extends
Properties for defining a CfnOptionGroup.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnOptionGroupProps cfnOptionGroupProps = CfnOptionGroupProps.builder()
         // the properties below are optional
                 // the properties below are optional
  • Method Details

    • getEngineName

      @Stability(Stable) @NotNull String getEngineName()
      Specifies the name of the engine that this option group should be associated with.

      Valid Values:

      • mariadb
      • mysql
      • oracle-ee
      • oracle-ee-cdb
      • oracle-se2
      • oracle-se2-cdb
      • postgres
      • sqlserver-ee
      • sqlserver-se
      • sqlserver-ex
      • sqlserver-web
    • getMajorEngineVersion

      @Stability(Stable) @NotNull String getMajorEngineVersion()
      Specifies the major version of the engine that this option group should be associated with.
    • getOptionGroupDescription

      @Stability(Stable) @NotNull String getOptionGroupDescription()
      The description of the option group.
    • getOptionConfigurations

      @Stability(Stable) @Nullable default Object getOptionConfigurations()
      A list of options and the settings for each option.
    • getOptionGroupName

      @Stability(Stable) @Nullable default String getOptionGroupName()
      The name of the option group to be created.


      • Must be 1 to 255 letters, numbers, or hyphens
      • First character must be a letter
      • Can't end with a hyphen or contain two consecutive hyphens

      Example: myoptiongroup

      If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.

      This value is stored as a lowercase string.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An optional array of key-value pairs to apply to this option group.
    • builder

      @Stability(Stable) static CfnOptionGroupProps.Builder builder()
      a CfnOptionGroupProps.Builder of CfnOptionGroupProps