- Resource: Instance
- GcsBackupSource
- ManagedBackupSource
- State
- StateInfo
- UpdateInfo
- AuthorizationMode
- TransitEncryptionMode
- DiscoveryEndpoint
- PersistenceConfig
- PersistenceMode
- RDBConfig
- SnapshotPeriod
- AOFConfig
- AppendFsync
- NodeConfig
- ZoneDistributionConfig
- ZoneDistributionMode
- PscAutoConnection
- PscConnectionStatus
- ConnectionType
- PscAttachmentDetail
- InstanceEndpoint
- ConnectionDetail
- PscConnection
- Mode
- MaintenancePolicy
- WeeklyMaintenanceWindow
- MaintenanceSchedule
- CrossInstanceReplicationConfig
- InstanceRole
- RemoteInstance
- Membership
- AutomatedBackupConfig
- FixedFrequencySchedule
- AutomatedBackupMode
- Methods
Resource: Instance
A Memorystore instance.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum ( |
Fields | |
---|---|
name |
Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance} |
createTime |
Output only. Creation timestamp of the instance. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Latest update timestamp of the instance. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
labels |
Optional. Labels to represent user-provided metadata. An object containing a list of |
state |
Output only. Current state of the instance. |
stateInfo |
Output only. Additional information about the state of the instance. |
uid |
Output only. System assigned, unique identifier for the instance. |
authorizationMode |
Optional. Immutable. Authorization mode of the instance. |
transitEncryptionMode |
Optional. Immutable. In-transit encryption mode of the instance. |
shardCount |
Optional. Number of shards for the instance. |
discoveryEndpoints[] |
Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead. |
nodeType |
Optional. Machine type for individual nodes of the instance. |
persistenceConfig |
Optional. Persistence configuration of the instance. |
engineVersion |
Optional. Engine version of the instance. |
engineConfigs |
Optional. User-provided engine configurations for the instance. An object containing a list of |
nodeConfig |
Output only. Configuration of individual nodes of the instance. |
zoneDistributionConfig |
Optional. Immutable. Zone distribution configuration of the instance for node allocation. |
pscAutoConnections[] |
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead. |
pscAttachmentDetails[] |
Output only. Service attachment details to configure PSC connections. |
endpoints[] |
Optional. Endpoints for the instance. |
mode |
Optional. The mode config for the instance. |
maintenancePolicy |
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule. |
maintenanceSchedule |
Output only. Published maintenance schedule. |
crossInstanceReplicationConfig |
Optional. The config for cross instance replication. |
automatedBackupConfig |
Optional. The automated backup config for the instance. |
Union field import_sources . The source to import from. import_sources can be only one of the following: |
|
gcsSource |
Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects. |
managedBackupSource |
Optional. Immutable. Backups that generated and managed by memorystore service. |
replicaCount |
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. |
deletionProtectionEnabled |
Optional. If set to true deletion of the instance will fail. |
ondemandMaintenance |
Optional. Input only. Ondemand maintenance for the instance. |
asyncInstanceEndpointsDeletionEnabled |
Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted. |
backupCollection |
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} |
GcsBackupSource
Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances.
JSON representation |
---|
{ "uris": [ string ] } |
Fields | |
---|---|
uris[] |
Optional. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 |
ManagedBackupSource
Backups that generated and managed by memorystore.
JSON representation |
---|
{ "backup": string } |
Fields | |
---|---|
backup |
Optional. Example: //memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} In this case, it assumes the backup is under memorystore.googleapis.com. |
State
Possible states of the instance.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not set. |
CREATING |
Instance is being created. |
ACTIVE |
Instance has been created and is usable. |
UPDATING |
Instance is being updated. |
DELETING |
Instance is being deleted. |
StateInfo
Additional information about the state of the instance.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
updateInfo |
Output only. Describes ongoing update when instance state is UPDATING. |
UpdateInfo
Represents information about instance with state UPDATING.
JSON representation |
---|
{
"targetShardCount": integer,
"targetReplicaCount": integer,
"targetEngineVersion": string,
"targetNodeType": enum ( |
Fields | |
---|---|
targetShardCount |
Output only. Target number of shards for the instance. |
targetReplicaCount |
Output only. Target number of replica nodes per shard for the instance. |
targetEngineVersion |
Output only. Target engine version for the instance. |
targetNodeType |
Output only. Target node type for the instance. |
AuthorizationMode
Possible authorization modes of the instance.
Enums | |
---|---|
AUTHORIZATION_MODE_UNSPECIFIED |
Not set. |
AUTH_DISABLED |
Authorization disabled. |
IAM_AUTH |
IAM basic authorization. |
TransitEncryptionMode
Possible in-transit encryption modes of the instance.
Enums | |
---|---|
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED |
Not set. |
TRANSIT_ENCRYPTION_DISABLED |
In-transit encryption is disabled. |
SERVER_AUTHENTICATION |
Server-managed encryption is used for in-transit encryption. |
DiscoveryEndpoint
Represents an endpoint for clients to connect to the instance.
JSON representation |
---|
{ "address": string, "port": integer, "network": string } |
Fields | |
---|---|
address |
Output only. IP address of the exposed endpoint clients connect to. |
port |
Output only. The port number of the exposed endpoint. |
network |
Output only. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{networkProject}/global/networks/{network_id}. |
PersistenceConfig
Represents persistence configuration for a instance.
JSON representation |
---|
{ "mode": enum ( |
Fields | |
---|---|
mode |
Optional. Current persistence mode. |
rdbConfig |
Optional. RDB configuration. This field will be ignored if mode is not RDB. |
aofConfig |
Optional. AOF configuration. This field will be ignored if mode is not AOF. |
PersistenceMode
Possible persistence modes.
Enums | |
---|---|
PERSISTENCE_MODE_UNSPECIFIED |
Not set. |
DISABLED |
Persistence is disabled, and any snapshot data is deleted. |
RDB |
RDB based persistence is enabled. |
AOF |
AOF based persistence is enabled. |
RDBConfig
Configuration for RDB based persistence.
JSON representation |
---|
{
"rdbSnapshotPeriod": enum ( |
Fields | |
---|---|
rdbSnapshotPeriod |
Optional. Period between RDB snapshots. |
rdbSnapshotStartTime |
Optional. Time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
SnapshotPeriod
Possible snapshot periods.
Enums | |
---|---|
SNAPSHOT_PERIOD_UNSPECIFIED |
Not set. |
ONE_HOUR |
One hour. |
SIX_HOURS |
Six hours. |
TWELVE_HOURS |
Twelve hours. |
TWENTY_FOUR_HOURS |
Twenty four hours. |
AOFConfig
Configuration for AOF based persistence.
JSON representation |
---|
{
"appendFsync": enum ( |
Fields | |
---|---|
appendFsync |
Optional. The fsync mode. |
AppendFsync
Possible fsync modes.
Enums | |
---|---|
APPEND_FSYNC_UNSPECIFIED |
Not set. Default: EVERY_SEC |
NEVER |
Never fsync. Normally Linux will flush data every 30 seconds with this configuration, but it's up to the kernel's exact tuning. |
EVERY_SEC |
Fsync every second. You may lose 1 second of data if there is a disaster. |
ALWAYS |
Fsync every time new write commands are appended to the AOF. The best data loss protection at the cost of performance. |
NodeConfig
Represents configuration for nodes of the instance.
JSON representation |
---|
{ "sizeGb": number } |
Fields | |
---|---|
sizeGb |
Output only. Memory size in GB of the node. |
ZoneDistributionConfig
Zone distribution configuration for allocation of instance resources.
JSON representation |
---|
{
"zone": string,
"mode": enum ( |
Fields | |
---|---|
zone |
Optional. Defines zone where all resources will be allocated with SINGLE_ZONE mode. Ignored for MULTI_ZONE mode. |
mode |
Optional. Current zone distribution mode. Defaults to MULTI_ZONE. |
ZoneDistributionMode
Possible zone distribution modes.
Enums | |
---|---|
ZONE_DISTRIBUTION_MODE_UNSPECIFIED |
Not Set. Default: MULTI_ZONE |
MULTI_ZONE |
Distribute resources across 3 zones picked at random within the region. |
SINGLE_ZONE |
Provision resources in a single zone. Zone field must be specified. |
PscAutoConnection
Details of consumer resources in a PSC connection.
JSON representation |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
Fields | |
---|---|
pscConnectionId |
Output only. The PSC connection id of the forwarding rule connected to the service attachment. |
ipAddress |
Output only. The IP allocated on the consumer network for the PSC forwarding rule. |
forwardingRule |
Output only. The URI of the consumer side forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule} |
projectId |
Required. The consumer projectId where PSC connections are established. This should be the same projectId that the instance is being created in. |
network |
Required. The network where the PSC endpoints are created, in the form of projects/{projectId}/global/networks/{network_id}. |
serviceAttachment |
Output only. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Output only. The status of the PSC connection: whether a connection exists and ACTIVE or it no longer exists. Please note that this value is updated periodically. Please use Private Service Connect APIs for the latest status. |
connectionType |
Output only. Type of the PSC connection. |
Union field ports . Ports of the exposed endpoint. ports can be only one of the following: |
|
port |
Optional. port will only be set for Primary/Reader or Discovery endpoint. |
PscConnectionStatus
Status of the PSC connection.
Enums | |
---|---|
PSC_CONNECTION_STATUS_UNSPECIFIED |
PSC connection status is not specified. |
ACTIVE |
The connection is active |
NOT_FOUND |
Connection not found |
ConnectionType
Type of a PSC connection
Enums | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
Connection Type is not set |
CONNECTION_TYPE_DISCOVERY |
Connection that will be used for topology discovery. |
CONNECTION_TYPE_PRIMARY |
Connection that will be used as primary endpoint to access primary. |
CONNECTION_TYPE_READER |
Connection that will be used as reader endpoint to access replicas. |
PscAttachmentDetail
Configuration of a service attachment of the cluster, for creating PSC connections.
JSON representation |
---|
{
"serviceAttachment": string,
"connectionType": enum ( |
Fields | |
---|---|
serviceAttachment |
Output only. Service attachment URI which your self-created PscConnection should use as target. |
connectionType |
Output only. Type of Psc endpoint. |
InstanceEndpoint
InstanceEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the instance. In each group, there shall be one connection for each service attachment in the cluster.
JSON representation |
---|
{
"connections": [
{
object ( |
Fields | |
---|---|
connections[] |
Optional. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. |
ConnectionDetail
Information of each PSC connection.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field connection . A PSC connection to an instance could either be created through Service Connectivity Automation (auto connection) during the cluster creation, or it could be created by customer themeslves (user-created connection). connection can be only one of the following: |
|
pscAutoConnection |
Immutable. Detailed information of a PSC connection that is created through service connectivity automation. |
pscConnection |
Detailed information of a PSC connection that is created by the user. |
PscConnection
User created Psc connection configuration.
JSON representation |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
Fields | |
---|---|
pscConnectionId |
Required. The PSC connection id of the forwarding rule connected to the service attachment. |
ipAddress |
Required. The IP allocated on the consumer network for the PSC forwarding rule. |
forwardingRule |
Required. The URI of the consumer side forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwardingRule} |
projectId |
Output only. The consumer projectId where the forwarding rule is created from. |
network |
Required. The consumer network where the IP address resides, in the form of projects/{projectId}/global/networks/{network_id}. |
serviceAttachment |
Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
pscConnectionStatus |
Output only. The status of the PSC connection: whether a connection exists and ACTIVE or it no longer exists. Please note that this value is updated periodically. Please use Private Service Connect APIs for the latest status. |
connectionType |
Output only. Type of the PSC connection. |
Union field ports . Ports of the exposed endpoint. ports can be only one of the following: |
|
port |
Optional. port will only be set for Primary/Reader or Discovery endpoint. |
Mode
The mode config, which is used to enable/disable cluster mode.
Enums | |
---|---|
MODE_UNSPECIFIED |
Mode is not specified. |
STANDALONE |
Deprecated: Use CLUSTER_DISABLED instead. |
CLUSTER |
Instance is in cluster mode. |
CLUSTER_DISABLED |
Cluster mode is disabled for the instance. |
MaintenancePolicy
Maintenance policy per instance.
JSON representation |
---|
{
"createTime": string,
"updateTime": string,
"weeklyMaintenanceWindow": [
{
object ( |
Fields | |
---|---|
createTime |
Output only. The time when the policy was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. The time when the policy was updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
weeklyMaintenanceWindow[] |
Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one. |
WeeklyMaintenanceWindow
Time window specified for weekly operations.
JSON representation |
---|
{ "day": enum ( |
Fields | |
---|---|
day |
Optional. Allows to define schedule that runs specified day of the week. |
startTime |
Optional. Start time of the window in UTC. |
MaintenanceSchedule
Upcoming maintenance schedule.
JSON representation |
---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
Output only. The start time of any upcoming scheduled maintenance for this instance. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
endTime |
Output only. The end time of any upcoming scheduled maintenance for this instance. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
CrossInstanceReplicationConfig
Cross instance replication config.
JSON representation |
---|
{ "instanceRole": enum ( |
Fields | |
---|---|
instanceRole |
Required. The role of the instance in cross instance replication. |
primaryInstance |
Optional. Details of the primary instance that is used as the replication source for this secondary instance. This field is only set for a secondary instance. |
secondaryInstances[] |
Optional. List of secondary instances that are replicating from this primary instance. This field is only set for a primary instance. |
updateTime |
Output only. The last time cross instance replication config was updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
membership |
Output only. An output only view of all the member instances participating in the cross instance replication. This view will be provided by every member instance irrespective of its instance role(primary or secondary). A primary instance can provide information about all the secondary instances replicating from it. However, a secondary instance only knows about the primary instance from which it is replicating. However, for scenarios, where the primary instance is unavailable(e.g. regional outage), a Getinstance request can be sent to any other member instance and this field will list all the member instances participating in cross instance replication. |
InstanceRole
The role of the instance in cross instance replication.
Enums | |
---|---|
INSTANCE_ROLE_UNSPECIFIED |
instance role is not set. The behavior is equivalent to NONE. |
NONE |
This instance does not participate in cross instance replication. It is an independent instance and does not replicate to or from any other instances. |
PRIMARY |
A instance that allows both reads and writes. Any data written to this instance is also replicated to the attached secondary instances. |
SECONDARY |
A instance that allows only reads and replicates data from a primary instance. |
RemoteInstance
Details of the remote instance associated with this instance in a cross instance replication setup.
JSON representation |
---|
{ "instance": string, "uid": string } |
Fields | |
---|---|
instance |
Optional. The full resource path of the remote instance in the format: projects/ |
uid |
Output only. The unique identifier of the remote instance. |
Membership
An output only view of all the member instances participating in the cross instance replication.
JSON representation |
---|
{ "primaryInstance": { object ( |
Fields | |
---|---|
primaryInstance |
Output only. The primary instance that acts as the source of replication for the secondary instances. |
secondaryInstances[] |
Output only. The list of secondary instances replicating from the primary instance. |
AutomatedBackupConfig
The automated backup config for an instance.
JSON representation |
---|
{ "automatedBackupMode": enum ( |
Fields | |
---|---|
automatedBackupMode |
Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored. |
retention |
Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. A duration in seconds with up to nine fractional digits, ending with ' |
Union field schedule . The schedule of automated backups. schedule can be only one of the following: |
|
fixedFrequencySchedule |
Optional. Trigger automated backups at a fixed frequency. |
FixedFrequencySchedule
This schedule allows the backup to be triggered at a fixed frequency (currently only daily is supported).
JSON representation |
---|
{
"startTime": {
object ( |
Fields | |
---|---|
startTime |
Required. The start time of every automated backup in UTC. It must be set to the start of an hour. This field is required. |
AutomatedBackupMode
The automated backup mode.
Enums | |
---|---|
AUTOMATED_BACKUP_MODE_UNSPECIFIED |
Default value. Automated backup config is not specified. |
DISABLED |
Automated backup config disabled. |
ENABLED |
Automated backup config enabled. |
Methods |
|
---|---|
|
Backup Instance. |
|
Creates a new Instance in a given project and location. |
|
Deletes a single Instance. |
|
Gets details of a single Instance. |
|
Gets details about the certificate authority for an Instance. |
|
Lists Instances in a given project and location. |
|
Updates the parameters of a single Instance. |
|
Reschedules upcoming maintenance event. |