Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } LINT.IfChange

Attributes

• consumerDefinedName (type: String.t, default: nil) - consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the name field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).
• createTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was created.
• instanceType (type: String.t, default: nil) - Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.
• labels (type: map(), default: nil) - Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.
• maintenancePolicyNames (type: map(), default: nil) - Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set.
• maintenanceSchedules (type: %{optional(String.t) => GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule.t}, default: nil) - The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.
• maintenanceSettings (type: GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings.t, default: nil) - Optional. The MaintenanceSettings associated with instance.
• name (type: String.t, default: nil) - Unique name of the resource. It uses the form: projects/{project_number}/locations/{location_id}/instances/{instance_id} Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.
• notificationParameters (type: %{optional(String.t) => GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter.t}, default: nil) - Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.
• producerMetadata (type: map(), default: nil) - Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.
• provisionedResources (type: list(GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource.t), default: nil) - Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.
• slmInstanceTemplate (type: String.t, default: nil) - Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.
• sloMetadata (type: GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata.t, default: nil) - Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.
• softwareVersions (type: map(), default: nil) - Software versions that are used to deploy this instance. This can be mutated by rollout services.
• state (type: String.t, default: nil) - Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
• tenantProjectId (type: String.t, default: nil) - Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.
• updateTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was last modified.