/AWS1/CL_MEMCLUSTER¶
Contains all of the attributes of a specific cluster.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_NAME TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
IV_DESCRIPTION TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
A description of the cluster
IV_STATUS TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The status of the cluster. For example, Available, Updating, Creating.
IO_PENDINGUPDATES TYPE REF TO /AWS1/CL_MEMCLUSTPENDINGUPDS /AWS1/CL_MEMCLUSTPENDINGUPDS¶
A group of settings that are currently being applied.
IV_MULTIREGIONCLUSTERNAME TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The name of the multi-Region cluster that this cluster belongs to.
IV_NUMBEROFSHARDS TYPE /AWS1/MEMINTEGEROPTIONAL /AWS1/MEMINTEGEROPTIONAL¶
The number of shards in the cluster
IT_SHARDS TYPE /AWS1/CL_MEMSHARD=>TT_SHARDLIST TT_SHARDLIST¶
A list of shards that are members of the cluster.
IV_AVAILABILITYMODE TYPE /AWS1/MEMAZSTATUS /AWS1/MEMAZSTATUS¶
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
IO_CLUSTERENDPOINT TYPE REF TO /AWS1/CL_MEMENDPOINT /AWS1/CL_MEMENDPOINT¶
The cluster's configuration endpoint
IV_NODETYPE TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The cluster's node type
IV_ENGINE TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The name of the engine used by the cluster.
IV_ENGINEVERSION TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The Redis OSS engine version used by the cluster
IV_ENGINEPATCHVERSION TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The Redis OSS engine patch version used by the cluster
IV_PARAMETERGROUPNAME TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The name of the parameter group used by the cluster
IV_PARAMETERGROUPSTATUS TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
IT_SECURITYGROUPS TYPE /AWS1/CL_MEMSECGROUPMEMBERSHIP=>TT_SECURITYGROUPMEMBERSHIPLIST TT_SECURITYGROUPMEMBERSHIPLIST¶
A list of security groups used by the cluster
IV_SUBNETGROUPNAME TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The name of the subnet group used by the cluster
IV_TLSENABLED TYPE /AWS1/MEMBOOLEANOPTIONAL /AWS1/MEMBOOLEANOPTIONAL¶
A flag to indicate if In-transit encryption is enabled
IV_KMSKEYID TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The ID of the KMS key used to encrypt the cluster
IV_ARN TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The Amazon Resource Name (ARN) of the cluster.
IV_SNSTOPICARN TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The Amazon Resource Name (ARN) of the SNS notification topic
IV_SNSTOPICSTATUS TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The SNS topic must be in Active status to receive notifications
IV_SNAPSHOTRETENTIONLIMIT TYPE /AWS1/MEMINTEGEROPTIONAL /AWS1/MEMINTEGEROPTIONAL¶
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
IV_MAINTENANCEWINDOW TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
IV_SNAPSHOTWINDOW TYPE /AWS1/MEMSTRING /AWS1/MEMSTRING¶
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
IV_ACLNAME TYPE /AWS1/MEMACLNAME /AWS1/MEMACLNAME¶
The name of the Access Control List associated with this cluster.
IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/MEMBOOLEANOPTIONAL /AWS1/MEMBOOLEANOPTIONAL¶
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
IV_DATATIERING TYPE /AWS1/MEMDATATIERINGSTATUS /AWS1/MEMDATATIERINGSTATUS¶
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Queryable Attributes¶
Name¶
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Description¶
A description of the cluster
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 |
Status¶
The status of the cluster. For example, Available, Updating, Creating.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
PendingUpdates¶
A group of settings that are currently being applied.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PENDINGUPDATES() |
Getter for PENDINGUPDATES |
MultiRegionClusterName¶
The name of the multi-Region cluster that this cluster belongs to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MULTIREGIONCLUSTERNAME() |
Getter for MULTIREGIONCLUSTERNAME, with configurable default |
ASK_MULTIREGIONCLUSTERNAME() |
Getter for MULTIREGIONCLUSTERNAME w/ exceptions if field has |
HAS_MULTIREGIONCLUSTERNAME() |
Determine if MULTIREGIONCLUSTERNAME has a value |
NumberOfShards¶
The number of shards in the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBEROFSHARDS() |
Getter for NUMBEROFSHARDS, with configurable default |
ASK_NUMBEROFSHARDS() |
Getter for NUMBEROFSHARDS w/ exceptions if field has no valu |
HAS_NUMBEROFSHARDS() |
Determine if NUMBEROFSHARDS has a value |
Shards¶
A list of shards that are members of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHARDS() |
Getter for SHARDS, with configurable default |
ASK_SHARDS() |
Getter for SHARDS w/ exceptions if field has no value |
HAS_SHARDS() |
Determine if SHARDS has a value |
AvailabilityMode¶
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYMODE() |
Getter for AVAILABILITYMODE, with configurable default |
ASK_AVAILABILITYMODE() |
Getter for AVAILABILITYMODE w/ exceptions if field has no va |
HAS_AVAILABILITYMODE() |
Determine if AVAILABILITYMODE has a value |
ClusterEndpoint¶
The cluster's configuration endpoint
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERENDPOINT() |
Getter for CLUSTERENDPOINT |
NodeType¶
The cluster's node type
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NODETYPE() |
Getter for NODETYPE, with configurable default |
ASK_NODETYPE() |
Getter for NODETYPE w/ exceptions if field has no value |
HAS_NODETYPE() |
Determine if NODETYPE has a value |
Engine¶
The name of the engine used by the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGINE() |
Getter for ENGINE, with configurable default |
ASK_ENGINE() |
Getter for ENGINE w/ exceptions if field has no value |
HAS_ENGINE() |
Determine if ENGINE has a value |
EngineVersion¶
The Redis OSS engine version used by the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGINEVERSION() |
Getter for ENGINEVERSION, with configurable default |
ASK_ENGINEVERSION() |
Getter for ENGINEVERSION w/ exceptions if field has no value |
HAS_ENGINEVERSION() |
Determine if ENGINEVERSION has a value |
EnginePatchVersion¶
The Redis OSS engine patch version used by the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGINEPATCHVERSION() |
Getter for ENGINEPATCHVERSION, with configurable default |
ASK_ENGINEPATCHVERSION() |
Getter for ENGINEPATCHVERSION w/ exceptions if field has no |
HAS_ENGINEPATCHVERSION() |
Determine if ENGINEPATCHVERSION has a value |
ParameterGroupName¶
The name of the parameter group used by the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARAMETERGROUPNAME() |
Getter for PARAMETERGROUPNAME, with configurable default |
ASK_PARAMETERGROUPNAME() |
Getter for PARAMETERGROUPNAME w/ exceptions if field has no |
HAS_PARAMETERGROUPNAME() |
Determine if PARAMETERGROUPNAME has a value |
ParameterGroupStatus¶
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARAMETERGROUPSTATUS() |
Getter for PARAMETERGROUPSTATUS, with configurable default |
ASK_PARAMETERGROUPSTATUS() |
Getter for PARAMETERGROUPSTATUS w/ exceptions if field has n |
HAS_PARAMETERGROUPSTATUS() |
Determine if PARAMETERGROUPSTATUS has a value |
SecurityGroups¶
A list of security groups used by the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECURITYGROUPS() |
Getter for SECURITYGROUPS, with configurable default |
ASK_SECURITYGROUPS() |
Getter for SECURITYGROUPS w/ exceptions if field has no valu |
HAS_SECURITYGROUPS() |
Determine if SECURITYGROUPS has a value |
SubnetGroupName¶
The name of the subnet group used by the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBNETGROUPNAME() |
Getter for SUBNETGROUPNAME, with configurable default |
ASK_SUBNETGROUPNAME() |
Getter for SUBNETGROUPNAME w/ exceptions if field has no val |
HAS_SUBNETGROUPNAME() |
Determine if SUBNETGROUPNAME has a value |
TLSEnabled¶
A flag to indicate if In-transit encryption is enabled
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TLSENABLED() |
Getter for TLSENABLED, with configurable default |
ASK_TLSENABLED() |
Getter for TLSENABLED w/ exceptions if field has no value |
HAS_TLSENABLED() |
Determine if TLSENABLED has a value |
KmsKeyId¶
The ID of the KMS key used to encrypt the cluster
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
ARN¶
The Amazon Resource Name (ARN) of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
SnsTopicArn¶
The Amazon Resource Name (ARN) of the SNS notification topic
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SNSTOPICARN() |
Getter for SNSTOPICARN, with configurable default |
ASK_SNSTOPICARN() |
Getter for SNSTOPICARN w/ exceptions if field has no value |
HAS_SNSTOPICARN() |
Determine if SNSTOPICARN has a value |
SnsTopicStatus¶
The SNS topic must be in Active status to receive notifications
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SNSTOPICSTATUS() |
Getter for SNSTOPICSTATUS, with configurable default |
ASK_SNSTOPICSTATUS() |
Getter for SNSTOPICSTATUS w/ exceptions if field has no valu |
HAS_SNSTOPICSTATUS() |
Determine if SNSTOPICSTATUS has a value |
SnapshotRetentionLimit¶
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SNAPSHOTRETENTIONLIMIT() |
Getter for SNAPSHOTRETENTIONLIMIT, with configurable default |
ASK_SNAPSHOTRETENTIONLIMIT() |
Getter for SNAPSHOTRETENTIONLIMIT w/ exceptions if field has |
HAS_SNAPSHOTRETENTIONLIMIT() |
Determine if SNAPSHOTRETENTIONLIMIT has a value |
MaintenanceWindow¶
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAINTENANCEWINDOW() |
Getter for MAINTENANCEWINDOW, with configurable default |
ASK_MAINTENANCEWINDOW() |
Getter for MAINTENANCEWINDOW w/ exceptions if field has no v |
HAS_MAINTENANCEWINDOW() |
Determine if MAINTENANCEWINDOW has a value |
SnapshotWindow¶
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SNAPSHOTWINDOW() |
Getter for SNAPSHOTWINDOW, with configurable default |
ASK_SNAPSHOTWINDOW() |
Getter for SNAPSHOTWINDOW w/ exceptions if field has no valu |
HAS_SNAPSHOTWINDOW() |
Determine if SNAPSHOTWINDOW has a value |
ACLName¶
The name of the Access Control List associated with this cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACLNAME() |
Getter for ACLNAME, with configurable default |
ASK_ACLNAME() |
Getter for ACLNAME w/ exceptions if field has no value |
HAS_ACLNAME() |
Determine if ACLNAME has a value |
AutoMinorVersionUpgrade¶
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTOMINORVERSIONUPGRADE() |
Getter for AUTOMINORVERSIONUPGRADE, with configurable defaul |
ASK_AUTOMINORVERSIONUPGRADE() |
Getter for AUTOMINORVERSIONUPGRADE w/ exceptions if field ha |
HAS_AUTOMINORVERSIONUPGRADE() |
Determine if AUTOMINORVERSIONUPGRADE has a value |
DataTiering¶
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATATIERING() |
Getter for DATATIERING, with configurable default |
ASK_DATATIERING() |
Getter for DATATIERING w/ exceptions if field has no value |
HAS_DATATIERING() |
Determine if DATATIERING 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_CLUSTERLIST¶
TYPES TT_CLUSTERLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_MEMCLUSTER WITH DEFAULT KEY
.