gcp_memcache_instance

ancestors

Type: UNORDERED_LIST_STRING

authorized_network

Type: STRING
Provider name: authorizedNetwork
Description: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the instance was created.

discovery_endpoint

Type: STRING
Provider name: discoveryEndpoint
Description: Output only. Endpoint for the Discovery API.

gcp_display_name

Type: STRING
Provider name: displayName
Description: User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.

instance_messages

Type: UNORDERED_LIST_STRUCT
Provider name: instanceMessages
Description: List of messages that describe the current state of the Memcached instance.

  • code
    Type: STRING
    Provider name: code
    Description: A code that correspond to one type of user-facing message.
    Possible values:
    • CODE_UNSPECIFIED - Message Code not set.
    • ZONE_DISTRIBUTION_UNBALANCED - Memcached nodes are distributed unevenly.
  • message
    Type: STRING
    Provider name: message
    Description: Message on memcached instance which will be exposed to users.

labels

Type: UNORDERED_LIST_STRING

maintenance_policy

Type: STRUCT
Provider name: maintenancePolicy
Description: The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

  • create_time
    Type: TIMESTAMP
    Provider name: createTime
    Description: Output only. The time when the policy was created.
  • description
    Type: STRING
    Provider name: description
    Description: Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
  • update_time
    Type: TIMESTAMP
    Provider name: updateTime
    Description: Output only. The time when the policy was updated.
  • weekly_maintenance_window
    Type: UNORDERED_LIST_STRUCT
    Provider name: weeklyMaintenanceWindow
    Description: Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.
    • day
      Type: STRING
      Provider name: day
      Description: Required. Allows to define schedule that runs specified day of the week.
      Possible values:
      • DAY_OF_WEEK_UNSPECIFIED - The day of the week is unspecified.
      • MONDAY - Monday
      • TUESDAY - Tuesday
      • WEDNESDAY - Wednesday
      • THURSDAY - Thursday
      • FRIDAY - Friday
      • SATURDAY - Saturday
      • SUNDAY - Sunday
    • duration
      Type: STRING
      Provider name: duration
      Description: Required. Duration of the time window.
    • start_time
      Type: STRUCT
      Provider name: startTime
      Description: Required. Start time of the window in UTC.
      • hours
        Type: INT32
        Provider name: hours
        Description: Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.
      • minutes
        Type: INT32
        Provider name: minutes
        Description: Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
      • nanos
        Type: INT32
        Provider name: nanos
        Description: Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
      • seconds
        Type: INT32
        Provider name: seconds
        Description: Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

maintenance_schedule

Type: STRUCT
Provider name: maintenanceSchedule
Description: Output only. Published maintenance schedule.

  • end_time
    Type: TIMESTAMP
    Provider name: endTime
    Description: Output only. The end time of any upcoming scheduled maintenance for this instance.
  • schedule_deadline_time
    Type: TIMESTAMP
    Provider name: scheduleDeadlineTime
    Description: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
  • start_time
    Type: TIMESTAMP
    Provider name: startTime
    Description: Output only. The start time of any upcoming scheduled maintenance for this instance.

memcache_full_version

Type: STRING
Provider name: memcacheFullVersion
Description: Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be “memcached-1.5.16”.

memcache_nodes

Type: UNORDERED_LIST_STRUCT
Provider name: memcacheNodes
Description: Output only. List of Memcached nodes. Refer to Node message for more details.

  • host
    Type: STRING
    Provider name: host
    Description: Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
  • memcache_full_version
    Type: STRING
    Provider name: memcacheFullVersion
    Description: Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16
  • memcache_version
    Type: STRING
    Provider name: memcacheVersion
    Description: Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
    Possible values:
    • MEMCACHE_VERSION_UNSPECIFIED - Memcache version is not specified by customer
    • MEMCACHE_1_5 - Memcached 1.5 version.
    • MEMCACHE_1_6_15 - Memcached 1.6.15 version.
  • node_id
    Type: STRING
    Provider name: nodeId
    Description: Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
  • parameters
    Type: STRUCT
    Provider name: parameters
    Description: User defined parameters currently applied to the node.
    • id
      Type: STRING
      Provider name: id
      Description: Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
  • port
    Type: INT32
    Provider name: port
    Description: Output only. The port number of the Memcached server on this node.
  • state
    Type: STRING
    Provider name: state
    Description: Output only. Current state of the Memcached node.
    Possible values:
    • STATE_UNSPECIFIED - Node state is not set.
    • CREATING - Node is being created.
    • READY - Node has been created and ready to be used.
    • DELETING - Node is being deleted.
    • UPDATING - Node is being updated.
  • zone
    Type: STRING
    Provider name: zone
    Description: Output only. Location (GCP Zone) for the Memcached node.

memcache_version

Type: STRING
Provider name: memcacheVersion
Description: The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
Possible values:

  • MEMCACHE_VERSION_UNSPECIFIED - Memcache version is not specified by customer
  • MEMCACHE_1_5 - Memcached 1.5 version.
  • MEMCACHE_1_6_15 - Memcached 1.6.15 version.

name

Type: STRING
Provider name: name
Description: Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Memcached instances are managed and addressed at the regional level so location_id here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.

node_config

Type: STRUCT
Provider name: nodeConfig
Description: Required. Configuration for Memcached nodes.

  • cpu_count
    Type: INT32
    Provider name: cpuCount
    Description: Required. Number of cpus per Memcached node.
  • memory_size_mb
    Type: INT32
    Provider name: memorySizeMb
    Description: Required. Memory size in MiB for each Memcached node.

node_count

Type: INT32
Provider name: nodeCount
Description: Required. Number of nodes in the Memcached instance.

organization_id

Type: STRING

parameters

Type: STRUCT
Provider name: parameters
Description: User defined parameters to apply to the memcached process on each node.

  • id
    Type: STRING
    Provider name: id
    Description: Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

reserved_ip_range_id

Type: UNORDERED_LIST_STRING
Provider name: reservedIpRangeId
Description: Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, “test-default” associated with IP range 10.0.0.0/29.

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Optional. Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Optional. Output only. Reserved for future use.

state

Type: STRING
Provider name: state
Description: Output only. The state of this Memcached instance.
Possible values:

  • STATE_UNSPECIFIED - State not set.
  • CREATING - Memcached instance is being created.
  • READY - Memcached instance has been created and ready to be used.
  • UPDATING - Memcached instance is updating configuration such as maintenance policy and schedule.
  • DELETING - Memcached instance is being deleted.
  • PERFORMING_MAINTENANCE - Memcached instance is going through maintenance, e.g. data plane rollout.
  • MEMCACHE_VERSION_UPGRADING - Memcached instance is undergoing memcached engine version upgrade.

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time the instance was updated.

zones

Type: UNORDERED_LIST_STRING
Provider name: zones
Description: Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

PREVIEWING: hannahkm/clarify-v2-docs