prefect_gcp.secret_manager
¶
GcpSecret
¶
Bases: SecretBlock
Manages a secret in Google Cloud Platform's Secret Manager.
Attributes:
Name | Type | Description |
---|---|---|
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
secret_name |
str
|
Name of the secret to manage. |
secret_version |
str
|
Version number of the secret to use, or "latest". |
Source code in prefect_gcp/secret_manager.py
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
|
delete_secret
async
¶
Deletes the secret from the secret storage service.
Returns:
Type | Description |
---|---|
str
|
The path that the secret was deleted from. |
Source code in prefect_gcp/secret_manager.py
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
|
read_secret
async
¶
Reads the secret data from the secret storage service.
Returns:
Type | Description |
---|---|
bytes
|
The secret data as bytes. |
Source code in prefect_gcp/secret_manager.py
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
|
write_secret
async
¶
Writes the secret data to the secret storage service; if it doesn't exist it will be created.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_data |
bytes
|
The secret to write. |
required |
Returns:
Type | Description |
---|---|
str
|
The path that the secret was written to. |
Source code in prefect_gcp/secret_manager.py
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
|
create_secret
async
¶
Creates a secret in Google Cloud Platform's Secret Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to retrieve. |
required |
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
required |
timeout |
float
|
The number of seconds the transport should wait for the server response. |
60
|
project |
Optional[str]
|
Name of the project to use; overrides the gcp_credentials project if provided. |
None
|
Returns:
Type | Description |
---|---|
str
|
The path of the created secret. |
Example
from prefect import flow
from prefect_gcp import GcpCredentials
from prefect_gcp.secret_manager import create_secret
@flow()
def example_cloud_storage_create_secret_flow():
gcp_credentials = GcpCredentials(project="project")
secret_path = create_secret("secret_name", gcp_credentials)
return secret_path
example_cloud_storage_create_secret_flow()
Source code in prefect_gcp/secret_manager.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
delete_secret
async
¶
Deletes the specified secret from Google Cloud Platform's Secret Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to delete. |
required |
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
required |
timeout |
float
|
The number of seconds the transport should wait for the server response. |
60
|
project |
Optional[str]
|
Name of the project to use; overrides the gcp_credentials project if provided. |
None
|
Returns:
Type | Description |
---|---|
str
|
The path of the deleted secret. |
Example
from prefect import flow
from prefect_gcp import GcpCredentials
from prefect_gcp.secret_manager import delete_secret
@flow()
def example_cloud_storage_delete_secret_flow():
gcp_credentials = GcpCredentials(project="project")
secret_path = delete_secret("secret_name", gcp_credentials)
return secret_path
example_cloud_storage_delete_secret_flow()
Source code in prefect_gcp/secret_manager.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
delete_secret_version
async
¶
Deletes a version of a given secret from Google Cloud Platform's Secret Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to retrieve. |
required |
version_id |
int
|
Version number of the secret to use; "latest" can NOT be used. |
required |
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
required |
timeout |
float
|
The number of seconds the transport should wait for the server response. |
60
|
project |
Optional[str]
|
Name of the project to use; overrides the gcp_credentials project if provided. |
None
|
Returns:
Type | Description |
---|---|
str
|
The path of the deleted secret version. |
Example
from prefect import flow
from prefect_gcp import GcpCredentials
from prefect_gcp.secret_manager import delete_secret_version
@flow()
def example_cloud_storage_delete_secret_version_flow():
gcp_credentials = GcpCredentials(project="project")
secret_value = delete_secret_version("secret_name", 1, gcp_credentials)
return secret_value
example_cloud_storage_delete_secret_version_flow()
Source code in prefect_gcp/secret_manager.py
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
|
read_secret
async
¶
Reads the value of a given secret from Google Cloud Platform's Secret Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to retrieve. |
required |
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
required |
timeout |
float
|
The number of seconds the transport should wait for the server response. |
60
|
project |
Optional[str]
|
Name of the project to use; overrides the gcp_credentials project if provided. |
None
|
Returns:
Type | Description |
---|---|
str
|
Contents of the specified secret. |
Example
from prefect import flow
from prefect_gcp import GcpCredentials
from prefect_gcp.secret_manager import read_secret
@flow()
def example_cloud_storage_read_secret_flow():
gcp_credentials = GcpCredentials(project="project")
secret_value = read_secret("secret_name", gcp_credentials, version_id=1)
return secret_value
example_cloud_storage_read_secret_flow()
Source code in prefect_gcp/secret_manager.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
|
update_secret
async
¶
Updates a secret in Google Cloud Platform's Secret Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to retrieve. |
required |
secret_value |
Union[str, bytes]
|
Desired value of the secret. Can be either |
required |
gcp_credentials |
GcpCredentials
|
Credentials to use for authentication with GCP. |
required |
timeout |
float
|
The number of seconds the transport should wait for the server response. |
60
|
project |
Optional[str]
|
Name of the project to use; overrides the gcp_credentials project if provided. |
None
|
Returns:
Type | Description |
---|---|
str
|
The path of the updated secret. |
Example
from prefect import flow
from prefect_gcp import GcpCredentials
from prefect_gcp.secret_manager import update_secret
@flow()
def example_cloud_storage_update_secret_flow():
gcp_credentials = GcpCredentials(project="project")
secret_path = update_secret("secret_name", "secret_value", gcp_credentials)
return secret_path
example_cloud_storage_update_secret_flow()
Source code in prefect_gcp/secret_manager.py
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
|