prefect_aws.secrets_manager
¶
Tasks for interacting with AWS Secrets Manager
AwsSecret
¶
Bases: SecretBlock
Manages a secret in AWS's Secrets Manager.
Attributes:
Name | Type | Description |
---|---|---|
aws_credentials |
AwsCredentials
|
The credentials to use for authentication with AWS. |
secret_name |
str
|
The name of the secret. |
Source code in prefect_aws/secrets_manager.py
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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
|
delete_secret
async
¶
Deletes the secret from the secret storage service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
recovery_window_in_days |
int
|
The number of days to wait before permanently deleting the secret. Must be between 7 and 30 days. |
30
|
force_delete_without_recovery |
bool
|
If True, the secret will be deleted immediately without a recovery window. |
False
|
**delete_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to the delete_secret method of the boto3 client. |
{}
|
Returns:
Type | Description |
---|---|
str
|
The path that the secret was deleted from. |
Examples:
Deletes the secret with a recovery window of 15 days.
secrets_manager = SecretsManager.load("MY_BLOCK")
secrets_manager.delete_secret(recovery_window_in_days=15)
Source code in prefect_aws/secrets_manager.py
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
|
read_secret
async
¶
Reads the secret from the secret storage service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
version_id |
str
|
The version of the secret to read. If not provided, the latest version will be read. |
None
|
version_stage |
str
|
The version stage of the secret to read. If not provided, the latest version will be read. |
None
|
read_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to the
|
{}
|
Returns:
Type | Description |
---|---|
bytes
|
The secret data. |
Examples:
Reads a secret.
secrets_manager = SecretsManager.load("MY_BLOCK")
secrets_manager.read_secret()
Source code in prefect_aws/secrets_manager.py
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
|
write_secret
async
¶
Writes the secret to the secret storage service as a SecretBinary; if it doesn't exist, it will be created.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_data |
bytes
|
The secret data to write. |
required |
**put_or_create_secret_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to put_secret_value or create_secret method of the boto3 client. |
{}
|
Returns:
Type | Description |
---|---|
str
|
The path that the secret was written to. |
Examples:
Write some secret data.
secrets_manager = SecretsManager.load("MY_BLOCK")
secrets_manager.write_secret(b"my_secret_data")
Source code in prefect_aws/secrets_manager.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 |
|
create_secret
async
¶
Creates a secret in AWS Secrets Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
The name of the secret to create. |
required |
secret_value |
Union[str, bytes]
|
The value to store in the created secret. |
required |
aws_credentials |
AwsCredentials
|
Credentials to use for authentication with AWS. |
required |
description |
Optional[str]
|
A description for the created secret. |
None
|
tags |
Optional[List[Dict[str, str]]]
|
A list of tags to attach to the secret. Each tag should be specified as a dictionary in the following format:
|
None
|
Returns:
Type | Description |
---|---|
Dict[str, str]
|
A dict containing the secret ARN (Amazon Resource Name), name, and current version ID.
|
```python
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.secrets_manager import create_secret
@flow
def example_create_secret():
aws_credentials = AwsCredentials(
aws_access_key_id="access_key_id",
aws_secret_access_key="secret_access_key"
)
create_secret(
secret_name="life_the_universe_and_everything",
secret_value="42",
aws_credentials=aws_credentials
)
example_create_secret()
```
Source code in prefect_aws/secrets_manager.py
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 196 197 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 244 245 246 247 248 249 250 |
|
delete_secret
async
¶
Deletes a secret from AWS Secrets Manager.
Secrets can either be deleted immediately by setting force_delete_without_recovery
equal to True
. Otherwise, secrets will be marked for deletion and available for
recovery for the number of days specified in recovery_window_in_days
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of the secret to be deleted. |
required |
aws_credentials |
AwsCredentials
|
Credentials to use for authentication with AWS. |
required |
recovery_window_in_days |
int
|
Number of days a secret should be recoverable for
before permanent deletion. Minimum window is 7 days and maximum window
is 30 days. If |
30
|
force_delete_without_recovery |
bool
|
If |
False
|
Returns:
Type | Description |
---|---|
Dict[str, str]
|
A dict containing the secret ARN (Amazon Resource Name),
name, and deletion date of the secret. DeletionDate is the date and
time of the delete request plus the number of days in
|
Examples:
Delete a secret immediately:
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.secrets_manager import delete_secret
@flow
def example_delete_secret_immediately():
aws_credentials = AwsCredentials(
aws_access_key_id="access_key_id",
aws_secret_access_key="secret_access_key"
)
delete_secret(
secret_name="life_the_universe_and_everything",
aws_credentials=aws_credentials,
force_delete_without_recovery: True
)
example_delete_secret_immediately()
Delete a secret with a 90 day recovery window:
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.secrets_manager import delete_secret
@flow
def example_delete_secret_with_recovery_window():
aws_credentials = AwsCredentials(
aws_access_key_id="access_key_id",
aws_secret_access_key="secret_access_key"
)
delete_secret(
secret_name="life_the_universe_and_everything",
aws_credentials=aws_credentials,
recovery_window_in_days=90
)
example_delete_secret_with_recovery_window()
Source code in prefect_aws/secrets_manager.py
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 297 298 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 |
|
read_secret
async
¶
Reads the value of a given secret from AWS Secrets Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of stored secret. |
required |
aws_credentials |
AwsCredentials
|
Credentials to use for authentication with AWS. |
required |
version_id |
Optional[str]
|
Specifies version of secret to read. Defaults to the most recent version if not given. |
None
|
version_stage |
Optional[str]
|
Specifies the version stage of the secret to read. Defaults to AWS_CURRENT if not given. |
None
|
Returns:
Type | Description |
---|---|
Union[str, bytes]
|
The secret values as a |
Example
Read a secret value:
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.secrets_manager import read_secret
@flow
def example_read_secret():
aws_credentials = AwsCredentials(
aws_access_key_id="access_key_id",
aws_secret_access_key="secret_access_key"
)
secret_value = read_secret(
secret_name="db_password",
aws_credentials=aws_credentials
)
example_read_secret()
Source code in prefect_aws/secrets_manager.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 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 |
|
update_secret
async
¶
Updates the value of a given secret in AWS Secrets Manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
secret_name |
str
|
Name of secret to update. |
required |
secret_value |
Union[str, bytes]
|
Desired value of the secret. Can be either |
required |
aws_credentials |
AwsCredentials
|
Credentials to use for authentication with AWS. |
required |
description |
Optional[str]
|
Desired description of the secret. |
None
|
Returns:
Type | Description |
---|---|
Dict[str, str]
|
A dict containing the secret ARN (Amazon Resource Name), name, and current version ID.
|
Example
Update a secret value:
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.secrets_manager import update_secret
@flow
def example_update_secret():
aws_credentials = AwsCredentials(
aws_access_key_id="access_key_id",
aws_secret_access_key="secret_access_key"
)
update_secret(
secret_name="life_the_universe_and_everything",
secret_value="42",
aws_credentials=aws_credentials
)
example_update_secret()
Source code in prefect_aws/secrets_manager.py
86 87 88 89 90 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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
|