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 234 235 236 237 238 239 240 241 242 243 244 245 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 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 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 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 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Defines a recommendation for a CloudWatch alarm.
type AlarmRecommendation struct {
// Name of the alarm recommendation.
//
// This member is required.
Name *string
// Identifier of the alarm recommendation.
//
// This member is required.
RecommendationId *string
// Reference identifier of the alarm recommendation.
//
// This member is required.
ReferenceId *string
// Type of alarm recommendation.
//
// This member is required.
Type AlarmType
// Application Component name for the CloudWatch alarm recommendation. This name
// is saved as the first item in the appComponentNames list.
//
// Deprecated: An alarm recommendation can be attached to multiple Application
// Components, hence this property will be replaced by the new property
// 'appComponentNames'.
AppComponentName *string
// List of Application Component names for the CloudWatch alarm recommendation.
AppComponentNames []string
// Description of the alarm recommendation.
Description *string
// List of CloudWatch alarm recommendations.
Items []RecommendationItem
// The prerequisite for the alarm recommendation.
Prerequisite *string
// Status of the recommended Amazon CloudWatch alarm.
RecommendationStatus RecommendationStatus
noSmithyDocumentSerde
}
// Defines an Resilience Hub application.
type App struct {
// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
// guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
AppArn *string
// Date and time when the app was created.
//
// This member is required.
CreationTime *time.Time
// Name for the application.
//
// This member is required.
Name *string
// Assessment execution schedule with 'Daily' or 'Disabled' values.
AssessmentSchedule AppAssessmentScheduleType
// Current status of compliance for the resiliency policy.
ComplianceStatus AppComplianceStatusType
// Optional description for an application.
Description *string
// Indicates if compliance drifts (deviations) were detected while running an
// assessment for your application.
DriftStatus AppDriftStatusType
// The list of events you would like to subscribe and get notification for.
// Currently, Resilience Hub supports notifications only for Drift detected and
// Scheduled assessment failure events.
EventSubscriptions []EventSubscription
// Date and time the most recent compliance evaluation.
LastAppComplianceEvaluationTime *time.Time
// Indicates the last time that a drift was evaluated.
LastDriftEvaluationTime *time.Time
// Date and time the most recent resiliency score evaluation.
LastResiliencyScoreEvaluationTime *time.Time
// Defines the roles and credentials that Resilience Hub would use while creating
// the application, importing its resources, and running an assessment.
PermissionModel *PermissionModel
// Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN
// is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id
// . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General
// Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
PolicyArn *string
// Current resiliency score for the application.
ResiliencyScore float64
// Recovery Point Objective (RPO) in seconds.
RpoInSecs *int32
// Recovery Time Objective (RTO) in seconds.
RtoInSecs *int32
// Status of the application.
Status AppStatusType
// Tags assigned to the resource. A tag is a label that you assign to an Amazon
// Web Services resource. Each tag consists of a key/value pair.
Tags map[string]string
noSmithyDocumentSerde
}
// Defines an application assessment.
type AppAssessment struct {
// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
// partition :resiliencehub: region : account :app-assessment/ app-id . For more
// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
AssessmentArn *string
// Current status of the assessment for the resiliency policy.
//
// This member is required.
AssessmentStatus AssessmentStatus
// The entity that invoked the assessment.
//
// This member is required.
Invoker AssessmentInvoker
// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
// guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
AppArn *string
// Version of an application.
AppVersion *string
// Name of the assessment.
AssessmentName *string
// Application compliance against the resiliency policy.
Compliance map[string]DisruptionCompliance
// Current status of the compliance for the resiliency policy.
ComplianceStatus ComplianceStatus
// Cost for the application.
Cost *Cost
// Indicates if compliance drifts (deviations) were detected while running an
// assessment for your application.
DriftStatus DriftStatus
// End time for the action.
EndTime *time.Time
// Error or warning message from the assessment execution
Message *string
// Resiliency policy of an application.
Policy *ResiliencyPolicy
// Current resiliency score for an application.
ResiliencyScore *ResiliencyScore
// A resource error object containing a list of errors retrieving an
// application's resources.
ResourceErrorsDetails *ResourceErrorsDetails
// Starting time for the action.
StartTime *time.Time
// Tags assigned to the resource. A tag is a label that you assign to an Amazon
// Web Services resource. Each tag consists of a key/value pair.
Tags map[string]string
// Version name of the published application.
VersionName *string
noSmithyDocumentSerde
}
// Defines an application assessment summary.
type AppAssessmentSummary struct {
// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
// partition :resiliencehub: region : account :app-assessment/ app-id . For more
// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
AssessmentArn *string
// Current status of the assessment for the resiliency policy.
//
// This member is required.
AssessmentStatus AssessmentStatus
// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
// guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
AppArn *string
// Version of an application.
AppVersion *string
// Name of the assessment.
AssessmentName *string
// TCurrent status of compliance for the resiliency policy.
ComplianceStatus ComplianceStatus
// Cost for an application.
Cost *Cost
// Indicates if compliance drifts (deviations) were detected while running an
// assessment for your application.
DriftStatus DriftStatus
// End time for the action.
EndTime *time.Time
// Entity that invoked the assessment.
Invoker AssessmentInvoker
// Message from the assessment run.
Message *string
// Current resiliency score for the application.
ResiliencyScore float64
// Starting time for the action.
StartTime *time.Time
// Name of an application version.
VersionName *string
noSmithyDocumentSerde
}
// Defines an Application Component.
type AppComponent struct {
// Name of the Application Component.
//
// This member is required.
Name *string
// The type of Application Component.
//
// This member is required.
Type *string
// Additional configuration parameters for an Resilience Hub application. If you
// want to implement additionalInfo through the Resilience Hub console rather than
// using an API call, see [Configure the application configuration parameters].
//
// Currently, this parameter accepts a key-value mapping (in a string format) of
// only one failover region and one associated account.
//
// Key: "failover-regions"
//
// Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
//
// [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html
AdditionalInfo map[string][]string
// Identifier of the Application Component.
Id *string
noSmithyDocumentSerde
}
// Defines the compliance of an Application Component against the resiliency
// policy.
type AppComponentCompliance struct {
// Name of the Application Component.
AppComponentName *string
// The compliance of the Application Component against the resiliency policy.
Compliance map[string]DisruptionCompliance
// The cost for the application.
Cost *Cost
// The compliance message.
Message *string
// The current resiliency score for the application.
ResiliencyScore *ResiliencyScore
// Status of the action.
Status ComplianceStatus
noSmithyDocumentSerde
}
// The list of Resilience Hub application input sources.
type AppInputSource struct {
// The resource type of the input source.
//
// This member is required.
ImportType ResourceMappingType
// The namespace on your Amazon Elastic Kubernetes Service cluster.
EksSourceClusterNamespace *EksSourceClusterNamespace
// The number of resources.
ResourceCount int32
// The Amazon Resource Name (ARN) of the input source. For more information about
// ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
SourceArn *string
// The name of the input source.
SourceName *string
// The name of the Terraform s3 state file.
TerraformSource *TerraformSource
noSmithyDocumentSerde
}
// Defines an application summary.
type AppSummary struct {
// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
// guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
AppArn *string
// Date and time when the app was created.
//
// This member is required.
CreationTime *time.Time
// The name of the application.
//
// This member is required.
Name *string
// Assessment execution schedule with 'Daily' or 'Disabled' values.
AssessmentSchedule AppAssessmentScheduleType
// The current status of compliance for the resiliency policy.
ComplianceStatus AppComplianceStatusType
// The optional description for an app.
Description *string
// Indicates if compliance drifts (deviations) were detected while running an
// assessment for your application.
DriftStatus AppDriftStatusType
// Date and time of the most recent compliance evaluation.
LastAppComplianceEvaluationTime *time.Time
// The current resiliency score for the application.
ResiliencyScore float64
// Recovery Point Objective (RPO) in seconds.
RpoInSecs *int32
// Recovery Time Objective (RTO) in seconds.
RtoInSecs *int32
// Status of the application.
Status AppStatusType
noSmithyDocumentSerde
}
// Version of an application.
type AppVersionSummary struct {
// Version of an application.
//
// This member is required.
AppVersion *string
// Creation time of the application version.
CreationTime *time.Time
// Identifier of the application version.
Identifier *int64
// Name of the application version.
VersionName *string
noSmithyDocumentSerde
}
// List of operational recommendations that did not get included or excluded.
type BatchUpdateRecommendationStatusFailedEntry struct {
// An identifier of an entry in this batch that is used to communicate the result.
//
// The entryId s of a batch request need to be unique within a request.
//
// This member is required.
EntryId *string
// Indicates the error that occurred while excluding an operational recommendation.
//
// This member is required.
ErrorMessage *string
noSmithyDocumentSerde
}
// List of operational recommendations that were successfully included or excluded.
type BatchUpdateRecommendationStatusSuccessfulEntry struct {
// An identifier for an entry in this batch that is used to communicate the result.
//
// The entryId s of a batch request need to be unique within a request.
//
// This member is required.
EntryId *string
// Indicates if the operational recommendation was successfully excluded.
//
// This member is required.
Excluded *bool
// The operational recommendation item.
//
// This member is required.
Item *UpdateRecommendationStatusItem
// Reference identifier of the operational recommendation.
//
// This member is required.
ReferenceId *string
// Indicates the reason for excluding an operational recommendation.
ExcludeReason ExcludeRecommendationReason
noSmithyDocumentSerde
}
// Indicates the compliance drifts (recovery time objective (RTO) and recovery
// point objective (RPO)) that were detected for an assessed entity.
type ComplianceDrift struct {
// Assessment identifier that is associated with this drift item.
ActualReferenceId *string
// Actual compliance value of the entity.
ActualValue map[string]DisruptionCompliance
// Identifier of your application.
AppId *string
// Published version of your application on which drift was detected.
AppVersion *string
// Difference type between actual and expected recovery point objective (RPO) and
// recovery time objective (RTO) values. Currently, Resilience Hub supports only
// NotEqual difference type.
DiffType DifferenceType
// The type of drift detected. Currently, Resilience Hub supports only
// ApplicationCompliance drift type.
DriftType DriftType
// Identifier of an entity in which drift was detected. For compliance drift, the
// entity ID can be either application ID or the AppComponent ID.
EntityId *string
// The type of entity in which drift was detected. For compliance drifts,
// Resilience Hub supports AWS::ResilienceHub::AppComponent and
// AWS::ResilienceHub::Application .
EntityType *string
// Assessment identifier of a previous assessment of the same application version.
// Resilience Hub uses the previous assessment (associated with the reference
// identifier) to compare the compliance with the current assessment to identify
// drifts.
ExpectedReferenceId *string
// The expected compliance value of an entity.
ExpectedValue map[string]DisruptionCompliance
noSmithyDocumentSerde
}
// Defines recommendations for an Resilience Hub Application Component, returned
// as an object. This object contains component names, configuration
// recommendations, and recommendation statuses.
type ComponentRecommendation struct {
// Name of the Application Component.
//
// This member is required.
AppComponentName *string
// List of recommendations.
//
// This member is required.
ConfigRecommendations []ConfigRecommendation
// Status of the recommendation.
//
// This member is required.
RecommendationStatus RecommendationComplianceStatus
noSmithyDocumentSerde
}
// Defines a recommendation configuration.
type ConfigRecommendation struct {
// The name of the recommendation configuration.
//
// This member is required.
Name *string
// The type of optimization.
//
// This member is required.
OptimizationType ConfigRecommendationOptimizationType
// Reference identifier for the recommendation configuration.
//
// This member is required.
ReferenceId *string
// Name of the Application Component.
AppComponentName *string
// The current compliance against the resiliency policy before applying the
// configuration change.
Compliance map[string]DisruptionCompliance
// The cost for the application.
Cost *Cost
// The optional description for an app.
Description *string
// The architecture type.
HaArchitecture HaArchitecture
// The expected compliance against the resiliency policy after applying the
// configuration change.
RecommendationCompliance map[string]RecommendationDisruptionCompliance
// List of the suggested configuration changes.
SuggestedChanges []string
noSmithyDocumentSerde
}
// Defines a cost object.
type Cost struct {
// The cost amount.
//
// This member is required.
Amount float64
// The cost currency, for example USD .
//
// This member is required.
Currency *string
// The cost frequency.
//
// This member is required.
Frequency CostFrequency
noSmithyDocumentSerde
}
// Defines the compliance against the resiliency policy for a disruption.
type DisruptionCompliance struct {
// The current status of compliance for the resiliency policy.
//
// This member is required.
ComplianceStatus ComplianceStatus
// The Recovery Point Objective (RPO) that is achievable, in seconds.
AchievableRpoInSecs int32
// The Recovery Time Objective (RTO) that is achievable, in seconds
AchievableRtoInSecs int32
// The current RPO, in seconds.
CurrentRpoInSecs int32
// The current RTO, in seconds.
CurrentRtoInSecs int32
// The disruption compliance message.
Message *string
// The RPO description.
RpoDescription *string
// Reference identifier of the RPO .
RpoReferenceId *string
// The RTO description.
RtoDescription *string
// Reference identifier of the RTO.
RtoReferenceId *string
noSmithyDocumentSerde
}
// The input source of the Amazon Elastic Kubernetes Service cluster.
type EksSource struct {
// Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster.
// The format for this ARN is: arn: aws :eks: region : account-id :cluster/
// cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services
// General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
EksClusterArn *string
// The list of namespaces located on your Amazon Elastic Kubernetes Service
// cluster.
//
// This member is required.
Namespaces []string
noSmithyDocumentSerde
}
// The input source of the namespace that is located on your Amazon Elastic
// Kubernetes Service cluster.
type EksSourceClusterNamespace struct {
// Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster.
// The format for this ARN is: arn: aws :eks: region : account-id :cluster/
// cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services
// General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
EksClusterArn *string
// Name of the namespace that is located on your Amazon Elastic Kubernetes Service
// cluster.
//
// This member is required.
Namespace *string
noSmithyDocumentSerde
}
// Indicates an event you would like to subscribe and get notification for.
// Currently, Resilience Hub supports notifications only for Drift detected and
// Scheduled assessment failure events.
type EventSubscription struct {
// The type of event you would like to subscribe and get notification for.
// Currently, Resilience Hub supports notifications only for Drift detected (
// DriftDetected ) and Scheduled assessment failure ( ScheduledAssessmentFailure )
// events.
//
// This member is required.
EventType EventType
// Unique name to identify an event subscription.
//
// This member is required.
Name *string
// Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The
// format for this ARN is: arn:partition:sns:region:account:topic-name . For more
// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
SnsTopicArn *string
noSmithyDocumentSerde
}
// Defines a failure policy.
type FailurePolicy struct {
// Recovery Point Objective (RPO) in seconds.
//
// This member is required.
RpoInSecs int32
// Recovery Time Objective (RTO) in seconds.
//
// This member is required.
RtoInSecs int32
noSmithyDocumentSerde
}
// Defines a logical resource identifier.
type LogicalResourceId struct {
// Identifier of the resource.
//
// This member is required.
Identifier *string
// Name of the Amazon Elastic Kubernetes Service cluster and namespace this
// resource belongs to.
//
// This parameter accepts values in "eks-cluster/namespace" format.
EksSourceName *string
// The name of the CloudFormation stack this resource belongs to.
LogicalStackName *string
// The name of the resource group that this resource belongs to.
ResourceGroupName *string
// The name of the Terraform S3 state file this resource belongs to.
TerraformSourceName *string
noSmithyDocumentSerde
}
// Defines the roles and credentials that Resilience Hub would use while creating
// the application, importing its resources, and running an assessment.
type PermissionModel struct {
// Defines how Resilience Hub scans your resources. It can scan for the resources
// by using a pre-existing role in your Amazon Web Services account, or by using
// the credentials of the current IAM user.
//
// This member is required.
Type PermissionModelType
// Defines a list of role Amazon Resource Names (ARNs) to be used in other
// accounts. These ARNs are used for querying purposes while importing resources
// and assessing your application.
//
// - These ARNs are required only when your resources are in other accounts and
// you have different role name in these accounts. Else, the invoker role name will
// be used in the other accounts.
//
// - These roles must have a trust policy with iam:AssumeRole permission to the
// invoker role in the primary account.
CrossAccountRoleArns []string
// Existing Amazon Web Services IAM role name in the primary Amazon Web Services
// account that will be assumed by Resilience Hub Service Principle to obtain a
// read-only access to your application resources while running an assessment.
//
// - You must have iam:passRole permission for this role while creating or
// updating the application.
//
// - Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
InvokerRoleName *string
noSmithyDocumentSerde
}
// Defines a physical resource. A physical resource is a resource that exists in
// your account. It can be identified using an Amazon Resource Name (ARN) or an
// Resilience Hub-native identifier.
type PhysicalResource struct {
// Logical identifier of the resource.
//
// This member is required.
LogicalResourceId *LogicalResourceId
// Identifier of the physical resource.
//
// This member is required.
PhysicalResourceId *PhysicalResourceId
// Type of resource.
//
// This member is required.
ResourceType *string
// Additional configuration parameters for an Resilience Hub application. If you
// want to implement additionalInfo through the Resilience Hub console rather than
// using an API call, see [Configure the application configuration parameters].
//
// Currently, this parameter accepts a key-value mapping (in a string format) of
// only one failover region and one associated account.
//
// Key: "failover-regions"
//
// Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
//
// [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html
AdditionalInfo map[string][]string
// The application components that belong to this resource.
AppComponents []AppComponent
// Indicates if a resource is included or excluded from the assessment.
Excluded *bool
// Name of the parent resource.
ParentResourceName *string
// The name of the resource.
ResourceName *string
// Type of input source.
SourceType ResourceSourceType
noSmithyDocumentSerde
}
// Defines a physical resource identifier.
type PhysicalResourceId struct {
// Identifier of the physical resource.
//
// This member is required.
Identifier *string
// Specifies the type of physical resource identifier.
//
// Arn The resource identifier is an Amazon Resource Name (ARN) and it can
// identify the following list of resources:
//
// - AWS::ECS::Service
//
// - AWS::EFS::FileSystem
//
// - AWS::ElasticLoadBalancingV2::LoadBalancer
//
// - AWS::Lambda::Function
//
// - AWS::SNS::Topic
//
// Native The resource identifier is an Resilience Hub-native identifier and it
// can identify the following list of resources:
//
// - AWS::ApiGateway::RestApi
//
// - AWS::ApiGatewayV2::Api
//
// - AWS::AutoScaling::AutoScalingGroup
//
// - AWS::DocDB::DBCluster
//
// - AWS::DocDB::DBGlobalCluster
//
// - AWS::DocDB::DBInstance
//
// - AWS::DynamoDB::GlobalTable
//
// - AWS::DynamoDB::Table
//
// - AWS::EC2::EC2Fleet
//
// - AWS::EC2::Instance
//
// - AWS::EC2::NatGateway
//
// - AWS::EC2::Volume
//
// - AWS::ElasticLoadBalancing::LoadBalancer
//
// - AWS::RDS::DBCluster
//
// - AWS::RDS::DBInstance
//
// - AWS::RDS::GlobalCluster
//
// - AWS::Route53::RecordSet
//
// - AWS::S3::Bucket
//
// - AWS::SQS::Queue
//
// This member is required.
Type PhysicalIdentifierType
// The Amazon Web Services account that owns the physical resource.
AwsAccountId *string
// The Amazon Web Services Region that the physical resource is located in.
AwsRegion *string
noSmithyDocumentSerde
}
// Defines a disruption compliance recommendation.
type RecommendationDisruptionCompliance struct {
// The expected compliance status after applying the recommended configuration
// change.
//
// This member is required.
ExpectedComplianceStatus ComplianceStatus
// The expected Recovery Point Objective (RPO) description after applying the
// recommended configuration change.
ExpectedRpoDescription *string
// The expected RPO after applying the recommended configuration change.
ExpectedRpoInSecs int32
// The expected Recovery Time Objective (RTO) description after applying the
// recommended configuration change.
ExpectedRtoDescription *string
// The expected RTO after applying the recommended configuration change.
ExpectedRtoInSecs int32
noSmithyDocumentSerde
}
// Defines a recommendation.
type RecommendationItem struct {
// Specifies if the recommendation has already been implemented.
AlreadyImplemented *bool
// Indicates the reason for excluding an operational recommendation.
ExcludeReason ExcludeRecommendationReason
// Indicates if an operational recommendation item is excluded.
Excluded *bool
// Identifier of the resource.
ResourceId *string
// Identifier of the target account.
TargetAccountId *string
// The target region.
TargetRegion *string
noSmithyDocumentSerde
}
// Defines a recommendation template created with the CreateRecommendationTemplate action.
type RecommendationTemplate struct {
// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
// partition :resiliencehub: region : account :app-assessment/ app-id . For more
// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
AssessmentArn *string
// Format of the recommendation template.
//
// CfnJson The template is CloudFormation JSON.
//
// CfnYaml The template is CloudFormation YAML.
//
// This member is required.
Format TemplateFormat
// Name for the recommendation template.
//
// This member is required.
Name *string
// Amazon Resource Name (ARN) for the recommendation template.
//
// This member is required.
RecommendationTemplateArn *string
// An array of strings that specify the recommendation template type or types.
//
// Alarm The template is an AlarmRecommendation template.
//
// Sop The template is a SopRecommendation template.
//
// Test The template is a TestRecommendation template.
//
// This member is required.
RecommendationTypes []RenderRecommendationType
// Status of the action.
//
// This member is required.
Status RecommendationTemplateStatus
// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
// guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
AppArn *string
// The end time for the action.
EndTime *time.Time
// Message for the recommendation template.
Message *string
// Indicates if replacements are needed.
NeedsReplacements *bool
// Identifiers for the recommendations used in the recommendation template.
RecommendationIds []string
// The start time for the action.
StartTime *time.Time
// Tags assigned to the resource. A tag is a label that you assign to an Amazon
// Web Services resource. Each tag consists of a key/value pair.
Tags map[string]string
// The file location of the template.
TemplatesLocation *S3Location
noSmithyDocumentSerde
}
// Defines a resiliency policy.
//
// Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs
// of your resiliency policy. But, while assessing your application, the lowest
// possible assessment result is near zero. Hence, if you provide value zero for
// rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO
// result will be near zero and the Compliance status for your application will be
// set to Policy breached.
type ResiliencyPolicy struct {
// Date and time when the resiliency policy was created.
CreationTime *time.Time
// Specifies a high-level geographical location constraint for where your
// resilience policy data can be stored.
DataLocationConstraint DataLocationConstraint
// Specifies the estimated cost tier of the resiliency policy.
EstimatedCostTier EstimatedCostTier
// The resiliency policy.
Policy map[string]FailurePolicy
// Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN
// is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id
// . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General
// Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
PolicyArn *string
// The description for the policy.
PolicyDescription *string
// The name of the policy
PolicyName *string
// Tags assigned to the resource. A tag is a label that you assign to an Amazon
// Web Services resource. Each tag consists of a key/value pair.
Tags map[string]string
// The tier for this resiliency policy, ranging from the highest severity (
// MissionCritical ) to lowest ( NonCritical ).
Tier ResiliencyPolicyTier
noSmithyDocumentSerde
}
// The overall resiliency score, returned as an object that includes the
// disruption score and outage score.
type ResiliencyScore struct {
// The disruption score for a valid key.
//
// This member is required.
DisruptionScore map[string]float64
// The outage score for a valid key.
//
// This member is required.
Score float64
// The score generated by Resilience Hub for the scoring component after running
// an assessment.
//
// For example, if the score is 25 points, it indicates the overall score of your
// application generated by Resilience Hub after running an assessment.
ComponentScore map[string]ScoringComponentResiliencyScore
noSmithyDocumentSerde
}
// Indicates the resources that have drifted in the current application version.
type ResourceDrift struct {
// Amazon Resource Name (ARN) of the application whose resources have drifted. The
// format for this ARN is: arn: partition :resiliencehub: region : account
// :app-assessment/ app-id . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon
// Web Services General Reference guide.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
AppArn *string
// Version of the application whose resources have drifted.
AppVersion *string
// Indicates if the resource was added or removed.
DiffType DifferenceType
// Reference identifier of the resource drift.
ReferenceId *string
// Identifier of the drifted resource.
ResourceIdentifier *ResourceIdentifier
noSmithyDocumentSerde
}
// Defines application resource errors.
type ResourceError struct {
// Identifier of the logical resource.
LogicalResourceId *string
// Identifier of the physical resource.
PhysicalResourceId *string
// This is the error message.
Reason *string
noSmithyDocumentSerde
}
// A list of errors retrieving an application's resources.
type ResourceErrorsDetails struct {
// This indicates if there are more errors not listed in the resourceErrors list.
HasMoreErrors *bool
// A list of errors retrieving an application's resources.
ResourceErrors []ResourceError
noSmithyDocumentSerde
}
// Defines a resource identifier for the drifted resource.
type ResourceIdentifier struct {
// Logical identifier of the drifted resource.
LogicalResourceId *LogicalResourceId
// Type of the drifted resource.
ResourceType *string
noSmithyDocumentSerde
}
// Defines a resource mapping.
type ResourceMapping struct {
// Specifies the type of resource mapping.
//
// This member is required.
MappingType ResourceMappingType
// Identifier of the physical resource.
//
// This member is required.
PhysicalResourceId *PhysicalResourceId
// Name of the application this resource is mapped to when the mappingType is
// AppRegistryApp .
AppRegistryAppName *string
// Name of the Amazon Elastic Kubernetes Service cluster and namespace that this
// resource is mapped to when the mappingType is EKS .
//
// This parameter accepts values in "eks-cluster/namespace" format.
EksSourceName *string
// Name of the CloudFormation stack this resource is mapped to when the mappingType
// is CfnStack .
LogicalStackName *string
// Name of the Resource Groups that this resource is mapped to when the mappingType
// is ResourceGroup .
ResourceGroupName *string
// Name of the resource that this resource is mapped to when the mappingType is
// Resource .
ResourceName *string
// Name of the Terraform source that this resource is mapped to when the
// mappingType is Terraform .
TerraformSourceName *string
noSmithyDocumentSerde
}
// The location of the Amazon S3 bucket.
type S3Location struct {
// The name of the Amazon S3 bucket.
Bucket *string
// The prefix for the Amazon S3 bucket.
Prefix *string
noSmithyDocumentSerde
}
// Resiliency score of each scoring component. For more information about scoring
// component, see [Calculating resiliency score].
//
// [Calculating resiliency score]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/calculate-score.html
type ScoringComponentResiliencyScore struct {
// Number of recommendations that were excluded from the assessment.
//
// For example, if the excludedCount for Alarms coverage scoring component is 7,
// it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.
ExcludedCount int64
// Number of recommendations that must be implemented to obtain the maximum
// possible score for the scoring component. For SOPs, alarms, and tests, these are
// the number of recommendations that must be implemented. For compliance, these
// are the number of Application Components that have breached the resiliency
// policy.
//
// For example, if the outstandingCount for Alarms coverage scoring component is
// 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to
// achieve the maximum possible score.
OutstandingCount int64
// Maximum possible score that can be obtained for the scoring component.
//
// For example, if the possibleScore is 20 points, it indicates the maximum
// possible score you can achieve for the scoring component when you run a new
// assessment after implementing all the Resilience Hub recommendations.
PossibleScore float64
// Resiliency score points given for the scoring component. The score is always
// less than or equal to the possibleScore .
Score float64
noSmithyDocumentSerde
}
// Defines a standard operating procedure (SOP) recommendation.
type SopRecommendation struct {
// Identifier for the SOP recommendation.
//
// This member is required.
RecommendationId *string
// Reference identifier for the SOP recommendation.
//
// This member is required.
ReferenceId *string
// The service type.
//
// This member is required.
ServiceType SopServiceType
// Name of the Application Component.
AppComponentName *string
// Description of the SOP recommendation.
Description *string
// The recommendation items.
Items []RecommendationItem
// Name of the SOP recommendation.
Name *string
// Prerequisite for the SOP recommendation.
Prerequisite *string
// Status of the recommended standard operating procedure.
RecommendationStatus RecommendationStatus
noSmithyDocumentSerde
}
// The Terraform s3 state file you need to import.
type TerraformSource struct {
// The URL of the Terraform s3 state file you need to import.
//
// This member is required.
S3StateFileUrl *string
noSmithyDocumentSerde
}
// Defines a test recommendation.
type TestRecommendation struct {
// Reference identifier for the test recommendation.
//
// This member is required.
ReferenceId *string
// Name of the Application Component.
AppComponentName *string
// A list of recommended alarms that are used in the test and must be exported
// before or with the test.
DependsOnAlarms []string
// Description for the test recommendation.
Description *string
// Intent of the test recommendation.
Intent *string
// The test recommendation items.
Items []RecommendationItem
// Name of the test recommendation.
Name *string
// Prerequisite of the test recommendation.
Prerequisite *string
// Identifier for the test recommendation.
RecommendationId *string
// Status of the recommended test.
RecommendationStatus RecommendationStatus
// Level of risk for this test recommendation.
Risk TestRisk
// Type of test recommendation.
Type TestType
noSmithyDocumentSerde
}
// Defines a resource that is not supported by Resilience Hub.
type UnsupportedResource struct {
// Logical resource identifier for the unsupported resource.
//
// This member is required.
LogicalResourceId *LogicalResourceId
// Physical resource identifier for the unsupported resource.
//
// This member is required.
PhysicalResourceId *PhysicalResourceId
// The type of resource.
//
// This member is required.
ResourceType *string
// The status of the unsupported resource.
UnsupportedResourceStatus *string
noSmithyDocumentSerde
}
// Defines the operational recommendation item that needs a status update.
type UpdateRecommendationStatusItem struct {
// Resource identifier of the operational recommendation item.
ResourceId *string
// Identifier of the target Amazon Web Services account.
TargetAccountId *string
// Identifier of the target Amazon Web Services Region.
TargetRegion *string
noSmithyDocumentSerde
}
// Defines the operational recommendation item that is to be included or excluded.
type UpdateRecommendationStatusRequestEntry struct {
// An identifier for an entry in this batch that is used to communicate the result.
//
// The entryId s of a batch request need to be unique within a request.
//
// This member is required.
EntryId *string
// Indicates if the operational recommendation needs to be excluded. If set to
// True, the operational recommendation will be excluded.
//
// This member is required.
Excluded *bool
// The operational recommendation item.
//
// This member is required.
Item *UpdateRecommendationStatusItem
// Reference identifier of the operational recommendation item.
//
// This member is required.
ReferenceId *string
// Indicates the reason for excluding an operational recommendation.
ExcludeReason ExcludeRecommendationReason
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|