Creates a new Instance in a given location.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: memcache1-beta2 --scope <scope> projects locations-instances-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Instance:
  authorized-network: string
  create-time: string
  discovery-endpoint: string
  display-name: string
  labels: { string: string }
  maintenance-policy:
    create-time: string
    description: string
    update-time: string
  maintenance-schedule:
    end-time: string
    schedule-deadline-time: string
    start-time: string
  memcache-full-version: string
  memcache-version: string
  name: string
  node-config:
    cpu-count: integer
    memory-size-mb: integer
  node-count: integer
  parameters:
    id: string
    params: { string: string }
  reserved-ip-range-id: [string]
  state: string
  update-available: boolean
  update-time: string
  zones: [string]

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . authorized-network=takimata
    • 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=amet.
    • Output only. The time the instance was created.
  • discovery-endpoint=duo
    • Output only. Endpoint for the Discovery API.
  • display-name=ipsum
    • User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
  • labels=key=gubergren
    • Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    • the value will be associated with the given key
  • maintenance-policy create-time=lorem
    • Output only. The time when the policy was created.
  • description=gubergren
    • Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

  • update-time=eos

    • Output only. The time when the policy was updated.

  • ..maintenance-schedule end-time=dolor

    • Output only. The end time of any upcoming scheduled maintenance for this instance.
  • schedule-deadline-time=ea
    • Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.

  • start-time=ipsum

    • Output only. The start time of any upcoming scheduled maintenance for this instance.

  • .. memcache-full-version=invidunt

    • 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-version=amet
    • 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.
  • name=duo
    • 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 cpu-count=51
    • Required. Number of cpus per Memcached node.

  • memory-size-mb=8

    • Required. Memory size in MiB for each Memcached node.

  • .. node-count=64

    • Required. Number of nodes in the Memcached instance.
  • parameters id=gubergren
    • 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.

  • params=key=rebum.

    • User defined set of parameters to use in the memcached process.
    • the value will be associated with the given key

  • .. reserved-ip-range-id=est

    • 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.
    • Each invocation of this argument appends the given value to the array.
  • state=ipsum
    • Output only. The state of this Memcached instance.
  • update-available=true
    • Output only. Returns true if there is an update waiting to be applied
  • update-time=est
    • Output only. The time the instance was updated.
  • zones=gubergren
    • 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.
    • Each invocation of this argument appends the given value to the array.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p instance-id=string
    • Required. The logical name of the Memcached instance in the user project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").