> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # secret_manager # `prefect_gcp.secret_manager` ## Functions ### `acreate_secret` ```python theme={null} acreate_secret(secret_name: str, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Creates a secret in Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the created secret. ### `create_secret` ```python theme={null} create_secret(secret_name: str, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Creates a secret in Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the created secret. ### `aupdate_secret` ```python theme={null} aupdate_secret(secret_name: str, secret_value: Union[str, bytes], gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Updates a secret in Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `secret_value`: Desired value of the secret. Can be either `str` or `bytes`. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the updated secret. ### `update_secret` ```python theme={null} update_secret(secret_name: str, secret_value: Union[str, bytes], gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Updates a secret in Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `secret_value`: Desired value of the secret. Can be either `str` or `bytes`. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the updated secret. ### `aread_secret` ```python theme={null} aread_secret(secret_name: str, gcp_credentials: 'GcpCredentials', version_id: Union[str, int] = 'latest', timeout: float = 60, project: Optional[str] = None) -> str ``` Reads the value of a given secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `gcp_credentials`: Credentials to use for authentication with GCP. * `version_id`: Version number of the secret to use, or "latest". * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * Contents of the specified secret. ### `read_secret` ```python theme={null} read_secret(secret_name: str, gcp_credentials: 'GcpCredentials', version_id: Union[str, int] = 'latest', timeout: float = 60, project: Optional[str] = None) -> str ``` Reads the value of a given secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `gcp_credentials`: Credentials to use for authentication with GCP. * `version_id`: Version number of the secret to use, or "latest". * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * Contents of the specified secret. ### `adelete_secret` ```python theme={null} adelete_secret(secret_name: str, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Deletes the specified secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to delete. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the deleted secret. ### `delete_secret` ```python theme={null} delete_secret(secret_name: str, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Deletes the specified secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to delete. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the deleted secret. ### `adelete_secret_version` ```python theme={null} adelete_secret_version(secret_name: str, version_id: int, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Deletes a version of a given secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `version_id`: Version number of the secret to use; "latest" can NOT be used. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the deleted secret version. ### `delete_secret_version` ```python theme={null} delete_secret_version(secret_name: str, version_id: int, gcp_credentials: 'GcpCredentials', timeout: float = 60, project: Optional[str] = None) -> str ``` Deletes a version of a given secret from Google Cloud Platform's Secret Manager. **Args:** * `secret_name`: Name of the secret to retrieve. * `version_id`: Version number of the secret to use; "latest" can NOT be used. * `gcp_credentials`: Credentials to use for authentication with GCP. * `timeout`: The number of seconds the transport should wait for the server response. * `project`: Name of the project to use; overrides the gcp\_credentials project if provided. **Returns:** * The path of the deleted secret version. ## Classes ### `GcpSecret` Manages a secret in Google Cloud Platform's Secret Manager. **Attributes:** * `gcp_credentials`: Credentials to use for authentication with GCP. * `secret_name`: Name of the secret to manage. * `secret_version`: Version number of the secret to use, or "latest". **Methods:** #### `adelete_secret` ```python theme={null} adelete_secret(self) -> str ``` Deletes the secret from the secret storage service (async version). **Returns:** * The path that the secret was deleted from. #### `aread_secret` ```python theme={null} aread_secret(self) -> bytes ``` Reads the secret data from the secret storage service (async version). **Returns:** * The secret data as bytes. #### `awrite_secret` ```python theme={null} awrite_secret(self, secret_data: bytes) -> str ``` Writes the secret data to the secret storage service (async version); if it doesn't exist it will be created. **Args:** * `secret_data`: The secret to write. **Returns:** * The path that the secret was written to. #### `delete_secret` ```python theme={null} delete_secret(self) -> str ``` Deletes the secret from the secret storage service. **Returns:** * The path that the secret was deleted from. #### `read_secret` ```python theme={null} read_secret(self) -> bytes ``` Reads the secret data from the secret storage service. **Returns:** * The secret data as bytes. #### `write_secret` ```python theme={null} write_secret(self, secret_data: bytes) -> str ``` Writes the secret data to the secret storage service; if it doesn't exist it will be created. **Args:** * `secret_data`: The secret to write. **Returns:** * The path that the secret was written to. Built with [Mintlify](https://mintlify.com).