This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
/
credentials.py
233 lines (191 loc) · 7.42 KB
/
credentials.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
84
85
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
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
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
"""Module handling AWS credentials"""
from enum import Enum
from typing import Any, Optional, Union
import boto3
from mypy_boto3_s3 import S3Client
from prefect.blocks.abstract import CredentialsBlock
from pydantic import Field, SecretStr
from prefect_aws.client_parameters import AwsClientParameters
class ClientType(Enum):
S3 = "s3"
ECS = "ecs"
BATCH = "batch"
SECRETS_MANAGER = "secretsmanager"
class AwsCredentials(CredentialsBlock):
"""
Block used to manage authentication with AWS. AWS authentication is
handled via the `boto3` module. Refer to the
[boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html)
for more info about the possible credential configurations.
Example:
Load stored AWS credentials:
```python
from prefect_aws import AwsCredentials
aws_credentials_block = AwsCredentials.load("BLOCK_NAME")
```
""" # noqa E501
_logo_url = "https://images.ctfassets.net/gm98wzqotmnx/1jbV4lceHOjGgunX15lUwT/db88e184d727f721575aeb054a37e277/aws.png?h=250" # noqa
_block_type_name = "AWS Credentials"
aws_access_key_id: Optional[str] = Field(
default=None,
description="A specific AWS access key ID.",
title="AWS Access Key ID",
)
aws_secret_access_key: Optional[SecretStr] = Field(
default=None,
description="A specific AWS secret access key.",
title="AWS Access Key Secret",
)
aws_session_token: Optional[str] = Field(
default=None,
description=(
"The session key for your AWS account. "
"This is only needed when you are using temporary credentials."
),
title="AWS Session Token",
)
profile_name: Optional[str] = Field(
default=None, description="The profile to use when creating your session."
)
region_name: Optional[str] = Field(
default=None,
description="The AWS Region where you want to create new connections.",
)
aws_client_parameters: AwsClientParameters = Field(
default_factory=AwsClientParameters,
description="Extra parameters to initialize the Client.",
title="AWS Client Parameters",
)
def get_boto3_session(self) -> boto3.Session:
"""
Returns an authenticated boto3 session that can be used to create clients
for AWS services
Example:
Create an S3 client from an authorized boto3 session:
```python
aws_credentials = AwsCredentials(
aws_access_key_id = "access_key_id",
aws_secret_access_key = "secret_access_key"
)
s3_client = aws_credentials.get_boto3_session().client("s3")
```
"""
if self.aws_secret_access_key:
aws_secret_access_key = self.aws_secret_access_key.get_secret_value()
else:
aws_secret_access_key = None
return boto3.Session(
aws_access_key_id=self.aws_access_key_id,
aws_secret_access_key=aws_secret_access_key,
aws_session_token=self.aws_session_token,
profile_name=self.profile_name,
region_name=self.region_name,
)
def get_client(self, client_type: Union[str, ClientType]) -> Any:
"""
Helper method to dynamically get a client type.
Args:
client_type: The client's service name.
Returns:
An authenticated client.
Raises:
ValueError: if the client is not supported.
"""
if isinstance(client_type, ClientType):
client_type = client_type.value
client = self.get_boto3_session().client(
service_name=client_type, **self.aws_client_parameters.get_params_override()
)
return client
def get_s3_client(self) -> S3Client:
"""
Gets an authenticated S3 client.
Returns:
An authenticated S3 client.
"""
return self.get_client(client_type=ClientType.S3)
class MinIOCredentials(CredentialsBlock):
"""
Block used to manage authentication with MinIO. Refer to the
[MinIO docs](https://docs.min.io/docs/minio-server-configuration-guide.html)
for more info about the possible credential configurations.
Attributes:
minio_root_user: Admin or root user.
minio_root_password: Admin or root password.
region_name: Location of server, e.g. "us-east-1".
Example:
Load stored MinIO credentials:
```python
from prefect_aws import MinIOCredentials
minio_credentials_block = MinIOCredentials.load("BLOCK_NAME")
```
""" # noqa E501
_logo_url = "https://images.ctfassets.net/gm98wzqotmnx/22vXcxsOrVeFrUwHfSoaeT/7607b876eb589a9028c8126e78f4c7b4/imageedit_7_2837870043.png?h=250" # noqa
_block_type_name = "MinIO Credentials"
_description = (
"Block used to manage authentication with MinIO. Refer to the MinIO "
"docs: https://docs.min.io/docs/minio-server-configuration-guide.html "
"for more info about the possible credential configurations."
)
minio_root_user: str = Field(default=..., description="Admin or root user.")
minio_root_password: SecretStr = Field(
default=..., description="Admin or root password."
)
region_name: Optional[str] = Field(
default=None,
description="The AWS Region where you want to create new connections.",
)
aws_client_parameters: AwsClientParameters = Field(
default_factory=AwsClientParameters,
description="Extra parameters to initialize the Client.",
)
def get_boto3_session(self) -> boto3.Session:
"""
Returns an authenticated boto3 session that can be used to create clients
and perform object operations on MinIO server.
Example:
Create an S3 client from an authorized boto3 session
```python
minio_credentials = MinIOCredentials(
minio_root_user = "minio_root_user",
minio_root_password = "minio_root_password"
)
s3_client = minio_credentials.get_boto3_session().client(
service="s3",
endpoint_url="http://localhost:9000"
)
```
"""
minio_root_password = (
self.minio_root_password.get_secret_value()
if self.minio_root_password
else None
)
return boto3.Session(
aws_access_key_id=self.minio_root_user,
aws_secret_access_key=minio_root_password,
region_name=self.region_name,
)
def get_client(self, client_type: Union[str, ClientType]) -> Any:
"""
Helper method to dynamically get a client type.
Args:
client_type: The client's service name.
Returns:
An authenticated client.
Raises:
ValueError: if the client is not supported.
"""
if isinstance(client_type, ClientType):
client_type = client_type.value
client = self.get_boto3_session().client(
service_name=client_type, **self.aws_client_parameters.get_params_override()
)
return client
def get_s3_client(self) -> S3Client:
"""
Gets an authenticated S3 client.
Returns:
An authenticated S3 client.
"""
return self.get_client(client_type=ClientType.S3)