Package software.amazon.awssdk.services.elasticbeanstalk.model

Interface ConfigurationOptionDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>, SdkBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>, SdkPojo
Enclosing class:
ConfigurationOptionDescription
public static interface ConfigurationOptionDescription.Builder extends SdkPojo, CopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>

  • Method Details

    • namespace

      ConfigurationOptionDescription.Builder namespace(String namespace)

      A unique namespace identifying the option's associated AWS resource.

      Parameters:
      namespace - A unique namespace identifying the option's associated AWS resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ConfigurationOptionDescription.Builder name(String name)

      The name of the configuration option.

      Parameters:
      name - The name of the configuration option.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultValue

      ConfigurationOptionDescription.Builder defaultValue(String defaultValue)

      The default value for this configuration option.

      Parameters:
      defaultValue - The default value for this configuration option.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeSeverity

      ConfigurationOptionDescription.Builder changeSeverity(String changeSeverity)

      An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.

      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

      Parameters:
      changeSeverity - An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.

      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userDefined

      ConfigurationOptionDescription.Builder userDefined(Boolean userDefined)

      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Parameters:
      userDefined - An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • valueType

      ConfigurationOptionDescription.Builder valueType(String valueType)

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

      • List : Values for this option are multiple selections from the possible values.

      • Boolean : Values for this option are either true or false .

      • Json : Values for this option are a JSON representation of a ConfigDocument.

      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

      • List : Values for this option are multiple selections from the possible values.

      • Boolean : Values for this option are either true or false .

      • Json : Values for this option are a JSON representation of a ConfigDocument.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • valueType

      ConfigurationOptionDescription.Builder valueType(ConfigurationOptionValueType valueType)

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

      • List : Values for this option are multiple selections from the possible values.

      • Boolean : Values for this option are either true or false .

      • Json : Values for this option are a JSON representation of a ConfigDocument.

      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

      • List : Values for this option are multiple selections from the possible values.

      • Boolean : Values for this option are either true or false .

      • Json : Values for this option are a JSON representation of a ConfigDocument.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • valueOptions

      ConfigurationOptionDescription.Builder valueOptions(Collection<String> valueOptions)

      If specified, values for the configuration option are selected from this list.

      Parameters:
      valueOptions - If specified, values for the configuration option are selected from this list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • valueOptions

      ConfigurationOptionDescription.Builder valueOptions(String... valueOptions)

      If specified, values for the configuration option are selected from this list.

      Parameters:
      valueOptions - If specified, values for the configuration option are selected from this list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minValue

      ConfigurationOptionDescription.Builder minValue(Integer minValue)

      If specified, the configuration option must be a numeric value greater than this value.

      Parameters:
      minValue - If specified, the configuration option must be a numeric value greater than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxValue

      ConfigurationOptionDescription.Builder maxValue(Integer maxValue)

      If specified, the configuration option must be a numeric value less than this value.

      Parameters:
      maxValue - If specified, the configuration option must be a numeric value less than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxLength

      ConfigurationOptionDescription.Builder maxLength(Integer maxLength)

      If specified, the configuration option must be a string value no longer than this value.

      Parameters:
      maxLength - If specified, the configuration option must be a string value no longer than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regex

      ConfigurationOptionDescription.Builder regex(OptionRestrictionRegex regex)

      If specified, the configuration option must be a string value that satisfies this regular expression.

      Parameters:
      regex - If specified, the configuration option must be a string value that satisfies this regular expression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regex

      default ConfigurationOptionDescription.Builder regex(Consumer<OptionRestrictionRegex.Builder> regex)

      If specified, the configuration option must be a string value that satisfies this regular expression.

      This is a convenience method that creates an instance of the OptionRestrictionRegex.Builder avoiding the need to create one manually via OptionRestrictionRegex.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regex(OptionRestrictionRegex).

      Parameters:
      regex - a consumer that will call methods on OptionRestrictionRegex.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: