Package software.amazon.awssdk.services.rds.model

Interface OptionGroupOption.Builder

    • Method Detail

      • name

        OptionGroupOption.Builder name​(String name)

        The name of the option.

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

      • description

        OptionGroupOption.Builder description​(String description)

        The description of the option.

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

      • engineName

        OptionGroupOption.Builder engineName​(String engineName)

        The name of the engine that this option can be applied to.

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

      • majorEngineVersion

        OptionGroupOption.Builder majorEngineVersion​(String majorEngineVersion)

        Indicates the major engine version that the option is available for.

        Parameters:
        majorEngineVersion - Indicates the major engine version that the option is available for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minimumRequiredMinorEngineVersion

        OptionGroupOption.Builder minimumRequiredMinorEngineVersion​(String minimumRequiredMinorEngineVersion)

        The minimum required engine version for the option to be applied.

        Parameters:
        minimumRequiredMinorEngineVersion - The minimum required engine version for the option to be applied.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portRequired

        OptionGroupOption.Builder portRequired​(Boolean portRequired)

        Indicates whether the option requires a port.

        Parameters:
        portRequired - Indicates whether the option requires a port.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultPort

        OptionGroupOption.Builder defaultPort​(Integer defaultPort)

        If the option requires a port, specifies the default port for the option.

        Parameters:
        defaultPort - If the option requires a port, specifies the default port for the option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionsDependedOn

        OptionGroupOption.Builder optionsDependedOn​(Collection<String> optionsDependedOn)

        The options that are prerequisites for this option.

        Parameters:
        optionsDependedOn - The options that are prerequisites for this option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionsDependedOn

        OptionGroupOption.Builder optionsDependedOn​(String... optionsDependedOn)

        The options that are prerequisites for this option.

        Parameters:
        optionsDependedOn - The options that are prerequisites for this option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionsConflictsWith

        OptionGroupOption.Builder optionsConflictsWith​(Collection<String> optionsConflictsWith)

        The options that conflict with this option.

        Parameters:
        optionsConflictsWith - The options that conflict with this option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionsConflictsWith

        OptionGroupOption.Builder optionsConflictsWith​(String... optionsConflictsWith)

        The options that conflict with this option.

        Parameters:
        optionsConflictsWith - The options that conflict with this option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • persistent

        OptionGroupOption.Builder persistent​(Boolean persistent)

        Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

        Parameters:
        persistent - Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • permanent

        OptionGroupOption.Builder permanent​(Boolean permanent)

        Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

        Parameters:
        permanent - Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requiresAutoMinorEngineVersionUpgrade

        OptionGroupOption.Builder requiresAutoMinorEngineVersionUpgrade​(Boolean requiresAutoMinorEngineVersionUpgrade)

        If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

        Parameters:
        requiresAutoMinorEngineVersionUpgrade - If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcOnly

        OptionGroupOption.Builder vpcOnly​(Boolean vpcOnly)

        If true, you can only use this option with a DB instance that is in a VPC.

        Parameters:
        vpcOnly - If true, you can only use this option with a DB instance that is in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsOptionVersionDowngrade

        OptionGroupOption.Builder supportsOptionVersionDowngrade​(Boolean supportsOptionVersionDowngrade)

        If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

        Parameters:
        supportsOptionVersionDowngrade - If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupOptionSettings

        OptionGroupOption.Builder optionGroupOptionSettings​(Collection<OptionGroupOptionSetting> optionGroupOptionSettings)

        The option settings that are available (and the default value) for each option in an option group.

        Parameters:
        optionGroupOptionSettings - The option settings that are available (and the default value) for each option in an option group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupOptionSettings

        OptionGroupOption.Builder optionGroupOptionSettings​(OptionGroupOptionSetting... optionGroupOptionSettings)

        The option settings that are available (and the default value) for each option in an option group.

        Parameters:
        optionGroupOptionSettings - The option settings that are available (and the default value) for each option in an option group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupOptionVersions

        OptionGroupOption.Builder optionGroupOptionVersions​(Collection<OptionVersion> optionGroupOptionVersions)

        The versions that are available for the option.

        Parameters:
        optionGroupOptionVersions - The versions that are available for the option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupOptionVersions

        OptionGroupOption.Builder optionGroupOptionVersions​(OptionVersion... optionGroupOptionVersions)

        The versions that are available for the option.

        Parameters:
        optionGroupOptionVersions - The versions that are available for the option.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupOptionVersions

        OptionGroupOption.Builder optionGroupOptionVersions​(Consumer<OptionVersion.Builder>... optionGroupOptionVersions)

        The versions that are available for the option.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #optionGroupOptionVersions(List).

        Parameters:
        optionGroupOptionVersions - a consumer that will call methods on OptionVersion.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #optionGroupOptionVersions(java.util.Collection)

      • copyableCrossAccount

        OptionGroupOption.Builder copyableCrossAccount​(Boolean copyableCrossAccount)

        Indicates whether the option can be copied across Amazon Web Services accounts.

        Parameters:
        copyableCrossAccount - Indicates whether the option can be copied across Amazon Web Services accounts.
        Returns:
        Returns a reference to this object so that method calls can be chained together.