# Class Instance (0.6.0)

0.6.0 (latest) 0.5.0 0.4.0 0.3.0 0.2.0 0.1.17

    Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A resource that represents a Secure Source Manager instance.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `name` | `str` Identifier. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` `project_number`: Maps to a unique int64 id assigned to each project. `location_id`: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. `instance_id`: User provided name for the instance, must be unique for a project_number and location_id combination. |
| `create_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Create timestamp. |
| `update_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Update timestamp. |
| `labels` | `MutableMapping[str, str]` Optional. Labels as key value pairs. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. For more information, see \`Requirements for labels |
| `private_config` | `https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.Instance.PrivateConfig` Optional. Private settings for private instance. |
| `state` | `https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.Instance.State` Output only. Current state of the instance. |
| `state_note` | `https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.Instance.StateNote` Output only. An optional field providing information about the current instance state. |
| `kms_key` | `str` Optional. Immutable. Customer-managed encryption key name, in the format projects/\*/locations/\*/keyRings/\*/cryptoKeys/\*. |
| `host_config` | `https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.Instance.HostConfig` Output only. A list of hostnames for this instance. |
| `workforce_identity_federation_config` | `https://docs.cloud.google.com/python/docs/reference/securesourcemanager/latest/google.cloud.securesourcemanager_v1.types.Instance.WorkforceIdentityFederationConfig` Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP. |

## Classes

### HostConfig

    HostConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

HostConfig has different instance endpoints.

### LabelsEntry

    LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `kwargs` | `dict` Keys and values corresponding to the fields of the message. |
| `mapping` | ``Union[dict, `.Message`]`` A dictionary or message to be used to determine the values for this message. |
| `ignore_unknown_fields` | `Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters. |

### PrivateConfig

    PrivateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

PrivateConfig includes settings for private instance.

### State

    State(value)

Secure Source Manager instance state.

### StateNote

    StateNote(value)

Provides information about the current instance state.

### WorkforceIdentityFederationConfig

    WorkforceIdentityFederationConfig(
        mapping=None, *, ignore_unknown_fields=False, **kwargs
    )

WorkforceIdentityFederationConfig allows this instance to
support users from external identity providers.