mypydantic.models.cloudhsmv2

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Mapping, Optional, Sequence
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class BackupRetentionPolicyModel(BaseModel):
 14    type: Optional[Literal["DAYS"]] = Field(default=None, alias="Type")
 15    value: Optional[str] = Field(default=None, alias="Value")
 16
 17
 18class TagModel(BaseModel):
 19    key: str = Field(alias="Key")
 20    value: str = Field(alias="Value")
 21
 22
 23class CertificatesModel(BaseModel):
 24    cluster_csr: Optional[str] = Field(default=None, alias="ClusterCsr")
 25    hsm_certificate: Optional[str] = Field(default=None, alias="HsmCertificate")
 26    aws_hardware_certificate: Optional[str] = Field(
 27        default=None, alias="AwsHardwareCertificate"
 28    )
 29    manufacturer_hardware_certificate: Optional[str] = Field(
 30        default=None, alias="ManufacturerHardwareCertificate"
 31    )
 32    cluster_certificate: Optional[str] = Field(default=None, alias="ClusterCertificate")
 33
 34
 35class HsmModel(BaseModel):
 36    hsm_id: str = Field(alias="HsmId")
 37    availability_zone: Optional[str] = Field(default=None, alias="AvailabilityZone")
 38    cluster_id: Optional[str] = Field(default=None, alias="ClusterId")
 39    subnet_id: Optional[str] = Field(default=None, alias="SubnetId")
 40    eni_id: Optional[str] = Field(default=None, alias="EniId")
 41    eni_ip: Optional[str] = Field(default=None, alias="EniIp")
 42    state: Optional[
 43        Literal[
 44            "ACTIVE", "CREATE_IN_PROGRESS", "DEGRADED", "DELETED", "DELETE_IN_PROGRESS"
 45        ]
 46    ] = Field(default=None, alias="State")
 47    state_message: Optional[str] = Field(default=None, alias="StateMessage")
 48
 49
 50class DestinationBackupModel(BaseModel):
 51    create_timestamp: Optional[datetime] = Field(default=None, alias="CreateTimestamp")
 52    source_region: Optional[str] = Field(default=None, alias="SourceRegion")
 53    source_backup: Optional[str] = Field(default=None, alias="SourceBackup")
 54    source_cluster: Optional[str] = Field(default=None, alias="SourceCluster")
 55
 56
 57class ResponseMetadataModel(BaseModel):
 58    request_id: str = Field(alias="RequestId")
 59    host_id: str = Field(alias="HostId")
 60    http_status_code: int = Field(alias="HTTPStatusCode")
 61    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 62    retry_attempts: int = Field(alias="RetryAttempts")
 63
 64
 65class CreateHsmRequestModel(BaseModel):
 66    cluster_id: str = Field(alias="ClusterId")
 67    availability_zone: str = Field(alias="AvailabilityZone")
 68    ip_address: Optional[str] = Field(default=None, alias="IpAddress")
 69
 70
 71class DeleteBackupRequestModel(BaseModel):
 72    backup_id: str = Field(alias="BackupId")
 73
 74
 75class DeleteClusterRequestModel(BaseModel):
 76    cluster_id: str = Field(alias="ClusterId")
 77
 78
 79class DeleteHsmRequestModel(BaseModel):
 80    cluster_id: str = Field(alias="ClusterId")
 81    hsm_id: Optional[str] = Field(default=None, alias="HsmId")
 82    eni_id: Optional[str] = Field(default=None, alias="EniId")
 83    eni_ip: Optional[str] = Field(default=None, alias="EniIp")
 84
 85
 86class PaginatorConfigModel(BaseModel):
 87    max_items: Optional[int] = Field(default=None, alias="MaxItems")
 88    page_size: Optional[int] = Field(default=None, alias="PageSize")
 89    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
 90
 91
 92class DescribeBackupsRequestModel(BaseModel):
 93    next_token: Optional[str] = Field(default=None, alias="NextToken")
 94    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 95    filters: Optional[Mapping[str, Sequence[str]]] = Field(
 96        default=None, alias="Filters"
 97    )
 98    sort_ascending: Optional[bool] = Field(default=None, alias="SortAscending")
 99
100
101class DescribeClustersRequestModel(BaseModel):
102    filters: Optional[Mapping[str, Sequence[str]]] = Field(
103        default=None, alias="Filters"
104    )
105    next_token: Optional[str] = Field(default=None, alias="NextToken")
106    max_results: Optional[int] = Field(default=None, alias="MaxResults")
107
108
109class InitializeClusterRequestModel(BaseModel):
110    cluster_id: str = Field(alias="ClusterId")
111    signed_cert: str = Field(alias="SignedCert")
112    trust_anchor: str = Field(alias="TrustAnchor")
113
114
115class ListTagsRequestModel(BaseModel):
116    resource_id: str = Field(alias="ResourceId")
117    next_token: Optional[str] = Field(default=None, alias="NextToken")
118    max_results: Optional[int] = Field(default=None, alias="MaxResults")
119
120
121class ModifyBackupAttributesRequestModel(BaseModel):
122    backup_id: str = Field(alias="BackupId")
123    never_expires: bool = Field(alias="NeverExpires")
124
125
126class RestoreBackupRequestModel(BaseModel):
127    backup_id: str = Field(alias="BackupId")
128
129
130class UntagResourceRequestModel(BaseModel):
131    resource_id: str = Field(alias="ResourceId")
132    tag_key_list: Sequence[str] = Field(alias="TagKeyList")
133
134
135class ModifyClusterRequestModel(BaseModel):
136    backup_retention_policy: BackupRetentionPolicyModel = Field(
137        alias="BackupRetentionPolicy"
138    )
139    cluster_id: str = Field(alias="ClusterId")
140
141
142class BackupModel(BaseModel):
143    backup_id: str = Field(alias="BackupId")
144    backup_state: Optional[
145        Literal["CREATE_IN_PROGRESS", "DELETED", "PENDING_DELETION", "READY"]
146    ] = Field(default=None, alias="BackupState")
147    cluster_id: Optional[str] = Field(default=None, alias="ClusterId")
148    create_timestamp: Optional[datetime] = Field(default=None, alias="CreateTimestamp")
149    copy_timestamp: Optional[datetime] = Field(default=None, alias="CopyTimestamp")
150    never_expires: Optional[bool] = Field(default=None, alias="NeverExpires")
151    source_region: Optional[str] = Field(default=None, alias="SourceRegion")
152    source_backup: Optional[str] = Field(default=None, alias="SourceBackup")
153    source_cluster: Optional[str] = Field(default=None, alias="SourceCluster")
154    delete_timestamp: Optional[datetime] = Field(default=None, alias="DeleteTimestamp")
155    tag_list: Optional[List[TagModel]] = Field(default=None, alias="TagList")
156
157
158class CopyBackupToRegionRequestModel(BaseModel):
159    destination_region: str = Field(alias="DestinationRegion")
160    backup_id: str = Field(alias="BackupId")
161    tag_list: Optional[Sequence[TagModel]] = Field(default=None, alias="TagList")
162
163
164class CreateClusterRequestModel(BaseModel):
165    hsm_type: str = Field(alias="HsmType")
166    subnet_ids: Sequence[str] = Field(alias="SubnetIds")
167    backup_retention_policy: Optional[BackupRetentionPolicyModel] = Field(
168        default=None, alias="BackupRetentionPolicy"
169    )
170    source_backup_id: Optional[str] = Field(default=None, alias="SourceBackupId")
171    tag_list: Optional[Sequence[TagModel]] = Field(default=None, alias="TagList")
172
173
174class TagResourceRequestModel(BaseModel):
175    resource_id: str = Field(alias="ResourceId")
176    tag_list: Sequence[TagModel] = Field(alias="TagList")
177
178
179class ClusterModel(BaseModel):
180    backup_policy: Optional[Literal["DEFAULT"]] = Field(
181        default=None, alias="BackupPolicy"
182    )
183    backup_retention_policy: Optional[BackupRetentionPolicyModel] = Field(
184        default=None, alias="BackupRetentionPolicy"
185    )
186    cluster_id: Optional[str] = Field(default=None, alias="ClusterId")
187    create_timestamp: Optional[datetime] = Field(default=None, alias="CreateTimestamp")
188    hsms: Optional[List[HsmModel]] = Field(default=None, alias="Hsms")
189    hsm_type: Optional[str] = Field(default=None, alias="HsmType")
190    pre_co_password: Optional[str] = Field(default=None, alias="PreCoPassword")
191    security_group: Optional[str] = Field(default=None, alias="SecurityGroup")
192    source_backup_id: Optional[str] = Field(default=None, alias="SourceBackupId")
193    state: Optional[
194        Literal[
195            "ACTIVE",
196            "CREATE_IN_PROGRESS",
197            "DEGRADED",
198            "DELETED",
199            "DELETE_IN_PROGRESS",
200            "INITIALIZED",
201            "INITIALIZE_IN_PROGRESS",
202            "UNINITIALIZED",
203            "UPDATE_IN_PROGRESS",
204        ]
205    ] = Field(default=None, alias="State")
206    state_message: Optional[str] = Field(default=None, alias="StateMessage")
207    subnet_mapping: Optional[Dict[str, str]] = Field(
208        default=None, alias="SubnetMapping"
209    )
210    vpc_id: Optional[str] = Field(default=None, alias="VpcId")
211    certificates: Optional[CertificatesModel] = Field(
212        default=None, alias="Certificates"
213    )
214    tag_list: Optional[List[TagModel]] = Field(default=None, alias="TagList")
215
216
217class CopyBackupToRegionResponseModel(BaseModel):
218    destination_backup: DestinationBackupModel = Field(alias="DestinationBackup")
219    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
220
221
222class CreateHsmResponseModel(BaseModel):
223    hsm: HsmModel = Field(alias="Hsm")
224    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
225
226
227class DeleteHsmResponseModel(BaseModel):
228    hsm_id: str = Field(alias="HsmId")
229    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
230
231
232class InitializeClusterResponseModel(BaseModel):
233    state: Literal[
234        "ACTIVE",
235        "CREATE_IN_PROGRESS",
236        "DEGRADED",
237        "DELETED",
238        "DELETE_IN_PROGRESS",
239        "INITIALIZED",
240        "INITIALIZE_IN_PROGRESS",
241        "UNINITIALIZED",
242        "UPDATE_IN_PROGRESS",
243    ] = Field(alias="State")
244    state_message: str = Field(alias="StateMessage")
245    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
246
247
248class ListTagsResponseModel(BaseModel):
249    tag_list: List[TagModel] = Field(alias="TagList")
250    next_token: str = Field(alias="NextToken")
251    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
252
253
254class DescribeBackupsRequestDescribeBackupsPaginateModel(BaseModel):
255    filters: Optional[Mapping[str, Sequence[str]]] = Field(
256        default=None, alias="Filters"
257    )
258    sort_ascending: Optional[bool] = Field(default=None, alias="SortAscending")
259    pagination_config: Optional[PaginatorConfigModel] = Field(
260        default=None, alias="PaginationConfig"
261    )
262
263
264class DescribeClustersRequestDescribeClustersPaginateModel(BaseModel):
265    filters: Optional[Mapping[str, Sequence[str]]] = Field(
266        default=None, alias="Filters"
267    )
268    pagination_config: Optional[PaginatorConfigModel] = Field(
269        default=None, alias="PaginationConfig"
270    )
271
272
273class ListTagsRequestListTagsPaginateModel(BaseModel):
274    resource_id: str = Field(alias="ResourceId")
275    pagination_config: Optional[PaginatorConfigModel] = Field(
276        default=None, alias="PaginationConfig"
277    )
278
279
280class DeleteBackupResponseModel(BaseModel):
281    backup: BackupModel = Field(alias="Backup")
282    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
283
284
285class DescribeBackupsResponseModel(BaseModel):
286    backups: List[BackupModel] = Field(alias="Backups")
287    next_token: str = Field(alias="NextToken")
288    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
289
290
291class ModifyBackupAttributesResponseModel(BaseModel):
292    backup: BackupModel = Field(alias="Backup")
293    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
294
295
296class RestoreBackupResponseModel(BaseModel):
297    backup: BackupModel = Field(alias="Backup")
298    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
299
300
301class CreateClusterResponseModel(BaseModel):
302    cluster: ClusterModel = Field(alias="Cluster")
303    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
304
305
306class DeleteClusterResponseModel(BaseModel):
307    cluster: ClusterModel = Field(alias="Cluster")
308    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
309
310
311class DescribeClustersResponseModel(BaseModel):
312    clusters: List[ClusterModel] = Field(alias="Clusters")
313    next_token: str = Field(alias="NextToken")
314    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
315
316
317class ModifyClusterResponseModel(BaseModel):
318    cluster: ClusterModel = Field(alias="Cluster")
319    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")