Interface Parameter.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Parameter.Builder,Parameter>, SdkBuilder<Parameter.Builder,Parameter>, SdkPojo
Enclosing class:
Parameter
@Mutable @NotThreadSafe public static interface Parameter.Builder extends SdkPojo, CopyableBuilder<Parameter.Builder,Parameter>

  • Method Details

    • parameterName

      Parameter.Builder parameterName(String parameterName)

      Specifies the name of the parameter.

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

    • parameterValue

      Parameter.Builder parameterValue(String parameterValue)

      Specifies the value of the parameter. Must be one or more of the cluster parameter's AllowedValues in CSV format:

      Valid values are:

      • enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.

      • disabled: The cluster does not accept secure connections using TLS.

      • fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.

      • tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

      • tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

      Parameters:
      parameterValue - Specifies the value of the parameter. Must be one or more of the cluster parameter's AllowedValues in CSV format:

      Valid values are:

      • enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.

      • disabled: The cluster does not accept secure connections using TLS.

      • fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.

      • tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

      • tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

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

    • description

      Parameter.Builder description(String description)

      Provides a description of the parameter.

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

    • source

      Parameter.Builder source(String source)

      Indicates the source of the parameter value.

      Parameters:
      source - Indicates the source of the parameter value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applyType

      Parameter.Builder applyType(String applyType)

      Specifies the engine-specific parameters type.

      Parameters:
      applyType - Specifies the engine-specific parameters type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataType

      Parameter.Builder dataType(String dataType)

      Specifies the valid data type for the parameter.

      Parameters:
      dataType - Specifies the valid data type for the parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedValues

      Parameter.Builder allowedValues(String allowedValues)

      Specifies the valid range of values for the parameter.

      Parameters:
      allowedValues - Specifies the valid range of values for the parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isModifiable

      Parameter.Builder isModifiable(Boolean isModifiable)

      Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      Parameters:
      isModifiable - Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minimumEngineVersion

      Parameter.Builder minimumEngineVersion(String minimumEngineVersion)

      The earliest engine version to which the parameter can apply.

      Parameters:
      minimumEngineVersion - The earliest engine version to which the parameter can apply.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applyMethod

      Parameter.Builder applyMethod(String applyMethod)

      Indicates when to apply parameter updates.

      Parameters:
      applyMethod - Indicates when to apply parameter updates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • applyMethod

      Parameter.Builder applyMethod(ApplyMethod applyMethod)

      Indicates when to apply parameter updates.

      Parameters:
      applyMethod - Indicates when to apply parameter updates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: