An Elasticsearch Index Lifecycle Management Policy defines the phases and actions to manage the lifecycle of an ES index.
This object has no members.
Enable COLD phase for the ES index.
Default value: false
SDK attribute: coldPhaseEnabled
The number of hours after the rollover of the index until it moves to the cold phase. This value has to be higher than the warm timer value.
Default value: 0
Max value: 45000
SDK attribute: coldTimer
Enable DELETE phase for the ES index
Default value: false
SDK attribute: deletePhaseEnabled
The number of hours after the rollover of the index until it gets deleted. This value has to be higher than the cold timer value.
Default value: 168
Max value: 45000
SDK attribute: deleteTimer
Description of the Elasticsearch Index Lifecycle Management Policy.
Format: free
Max length: 255
SDK attribute: description
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
The type of EsIlm Policy.
Allowed values: CUSTOM, DEFAULT
SDK attribute: esIlmPolicyType
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Enable the Force Merge action for the ES index when moving to the warm phase.
Default value: false
SDK attribute: forceMergeEnabled
Max number of segments for Force Merge
Default value: 1
Min value: 1
Max value: 100
SDK attribute: forceMergeMaxNumSegments
Mark the ES index as frozen when moving to the cold phase. This will freeze the index by calling the Freeze Index API.
Default value: false
SDK attribute: indexFreeze
Mark the ES index as readonly in the warm phase
Default value: false
SDK attribute: indexReadOnly
A unique name of the EsIlmPolicy object
Format: free
Min length: 1
Max length: 100
SDK attribute: name
The number of hours after which the index is rolled over in case it isn't rolled over based on size or number of documents.
Default value: 0
Max value: 45000
SDK attribute: rolloverMaxAge
The number of documents after which the index is rolled over in case it isn't rolled over based on size or age.
Default value: 0
Max value: 10000000000
SDK attribute: rolloverMaxDocs
The max size in GB after which the index is rolled over in case it isn't rolled over based on age or number of documents.
Default value: 150
Max value: 1024
SDK attribute: rolloverMaxSize
Enable WARM phase for the ES index
Default value: false
SDK attribute: warmPhaseEnabled
The number of hours after the rollover of the index until it moves to the warm phase.
Default value: 0
Max value: 45000
SDK attribute: warmTimer