---
title: "CloudRedisInstance"
slug: "common-vapidatatype-cloudredisinstance"
updated: 2026-09-17T09:57:01Z
published: 2026-09-17T09:57:01Z
canonical: "api.ncloud-docs.com/common-vapidatatype-cloudredisinstance"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudRedisInstance

VPC環境で利用できます。

Cloud DB for Cacheインスタンスです。

## 構文

構文は次の通りです。

```
private String cloudRedisInstanceNo;
private String cloudRedisServiceName;
private String cloudRedisInstanceStatusName;
private CommonCode cloudRedisInstanceStatus;
private CommonCode cloudRedisInstanceOperation;
private String cloudRedisImageProductCode;
private String engineVersion;
private CommonCode licence;
private Integer cloudRedisPort;
private Boolean isHa;
private String cloudRedisServerPrefix;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String backupSchedule;
private Date createDate;
private Integer shardCount;
private Integer shardCopyCount;
private AccessControlGroupNoList accessControlGroupNoList;
private String configGroupNo;
private String configGroupName;
private CommonCode role;
private List<CloudRedisServerInstance> cloudRedisServerInstanceList;
```

## フィールド

フィールドの詳細は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `cloudRedisInstanceNo` | String | Required | Cloud DB for Cacheインスタンス番号 |
| `cloudRedisServiceName` | String | Required | Cloud DB for Cacheサービス名 |
| `cloudRedisInstanceStatusName` | String | Required | Cloud DB for Cacheインスタンスの状態名 - `creating` \| `deleted` \| `deleting` \| `downgrading` \| `pending` \| `recovering` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` |
| `cloudRedisInstanceStatus` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Required | Cloud DB for Cacheインスタンスの状態 - `INIT` \| `CREAT` \| `DEL` - `INIT`: Initiated - `CREAT`: Created - `DEL`: Deleted |
| `cloudRedisInstanceOperation` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Required | Cloud DB for Cacheインスタンスの運用状態 - `CREAT` \| `DEL` \| `FO` \| `NULL` \| `SETUP` \| `UPGD` \| `DWGD` \| `BKP` - `CREAT`: Create - `DEL`: Delete - `FO`: Failover - `NULL`: No Operation - `SETUP`: Setup - `UPGD`: Upgrade - `DWGD`: Downgrade - `BKP`: Backup |
| `cloudRedisImageProductCode` | String | Optional | Cloud DB for Cacheイメージ商品コード |
| `engineVersion` | String | Optional | Cloud DB for Cacheエンジンバージョン |
| `license` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Optional | Cloud DB for Cacheライセンス |
| `cloudRedisPort` | Integer | Optional | Cloud DB for Cacheポート |
| `isHa` | Boolean | Required | 高可用性かどうか - `true` \| `false` |
| `cloudRedisServerPrefix` | String | Optional | Cloud Redisサーバ名の Prefix |
| `isBackup` | Boolean | Optional | バックアップの有無 - `true` \| `false` |
| `backupFileRetentionPeriod` | Integer | Optional | バックアップファイルの保管期間 |
| `backupTime` | String | Optional | バックアップ時間 |
| `backupSchedule` | String | Optional | 自動バックアップ設定の有無 |
| `createDate` | Date | Optional | 作成日時 |
| `shardCount` | Integer | Optional | Cloud DB for Cacheのシャード数 |
| `shardCopyCount` | Integer | Optional | Cloud DB for Cacheシャード1個当たりのコピー数 |
| `accessControlGroupNoList` | [AccessControlGroupNoList](/docs/ja/common-vapidatatype-accesscontrolgroupnolist) | Optional | ACG番号リスト |
| `configGroupNo` | configGroupNo | Optional | Cloud DB for Cache Configグループ番号 |
| `configGroupName` | configGroupName | Optional | Cloud DB for Cache Configグループの名前 |
| `role` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Required | Cloud DB for Cacheの構成 |
| `cloudRedisServerInstanceList` | List<[CloudRedisServerInstance](/docs/ja/common-vapidatatype-cloudredisserverinstance)> | Required | Cloud DB for Cacheサーバインスタンスリスト |