/AWS1/CL_DODPARAMETER

Detailed information about an individual parameter.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_parametername TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Specifies the name of the parameter.

iv_parametervalue TYPE /AWS1/DODSTRING /AWS1/DODSTRING

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).

iv_description TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Provides a description of the parameter.

iv_source TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Indicates the source of the parameter value.

iv_applytype TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Specifies the engine-specific parameters type.

iv_datatype TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Specifies the valid data type for the parameter.

iv_allowedvalues TYPE /AWS1/DODSTRING /AWS1/DODSTRING

Specifies the valid range of values for the parameter.

iv_ismodifiable TYPE /AWS1/DODBOOLEAN /AWS1/DODBOOLEAN

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

iv_minimumengineversion TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The earliest engine version to which the parameter can apply.

iv_applymethod TYPE /AWS1/DODAPPLYMETHOD /AWS1/DODAPPLYMETHOD

Indicates when to apply parameter updates.

---

Queryable Attributes

ParameterName

Specifies the name of the parameter.

Accessible with the following methods

Method	Description
GET_PARAMETERNAME()	Getter for PARAMETERNAME, with configurable default
ASK_PARAMETERNAME()	Getter for PARAMETERNAME w/ exceptions if field has no value
HAS_PARAMETERNAME()	Determine if PARAMETERNAME has a value

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).

Accessible with the following methods

Method	Description
GET_PARAMETERVALUE()	Getter for PARAMETERVALUE, with configurable default
ASK_PARAMETERVALUE()	Getter for PARAMETERVALUE w/ exceptions if field has no valu
HAS_PARAMETERVALUE()	Determine if PARAMETERVALUE has a value

Description

Provides a description of the parameter.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Source

Indicates the source of the parameter value.

Accessible with the following methods

Method	Description
GET_SOURCE()	Getter for SOURCE, with configurable default
ASK_SOURCE()	Getter for SOURCE w/ exceptions if field has no value
HAS_SOURCE()	Determine if SOURCE has a value

ApplyType

Specifies the engine-specific parameters type.

Accessible with the following methods

Method	Description
GET_APPLYTYPE()	Getter for APPLYTYPE, with configurable default
ASK_APPLYTYPE()	Getter for APPLYTYPE w/ exceptions if field has no value
HAS_APPLYTYPE()	Determine if APPLYTYPE has a value

DataType

Specifies the valid data type for the parameter.

Accessible with the following methods

Method	Description
GET_DATATYPE()	Getter for DATATYPE, with configurable default
ASK_DATATYPE()	Getter for DATATYPE w/ exceptions if field has no value
HAS_DATATYPE()	Determine if DATATYPE has a value

AllowedValues

Specifies the valid range of values for the parameter.

Accessible with the following methods

Method	Description
GET_ALLOWEDVALUES()	Getter for ALLOWEDVALUES, with configurable default
ASK_ALLOWEDVALUES()	Getter for ALLOWEDVALUES w/ exceptions if field has no value
HAS_ALLOWEDVALUES()	Determine if ALLOWEDVALUES has a value

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.

Accessible with the following methods

Method	Description
GET_ISMODIFIABLE()	Getter for ISMODIFIABLE, with configurable default
ASK_ISMODIFIABLE()	Getter for ISMODIFIABLE w/ exceptions if field has no value
HAS_ISMODIFIABLE()	Determine if ISMODIFIABLE has a value

MinimumEngineVersion

The earliest engine version to which the parameter can apply.

Accessible with the following methods

Method	Description
GET_MINIMUMENGINEVERSION()	Getter for MINIMUMENGINEVERSION, with configurable default
ASK_MINIMUMENGINEVERSION()	Getter for MINIMUMENGINEVERSION w/ exceptions if field has n
HAS_MINIMUMENGINEVERSION()	Determine if MINIMUMENGINEVERSION has a value

ApplyMethod

Indicates when to apply parameter updates.

Accessible with the following methods

Method	Description
GET_APPLYMETHOD()	Getter for APPLYMETHOD, with configurable default
ASK_APPLYMETHOD()	Getter for APPLYMETHOD w/ exceptions if field has no value
HAS_APPLYMETHOD()	Determine if APPLYMETHOD has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PARAMETERSLIST

TYPES TT_PARAMETERSLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_DODPARAMETER WITH DEFAULT KEY
.