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 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// The configured access rules for the domain's document and search endpoints, and
// the current status of those rules.
type AccessPoliciesStatus struct {
// The access policy configured for the Elasticsearch domain. Access policies may
// be resource-based, IP-based, or IAM-based. See Configuring Access Policies (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies)
// for more information.
//
// This member is required.
Options *string
// The status of the access policy for the Elasticsearch domain. See OptionStatus
// for the status information that's included.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// List of limits that are specific to a given InstanceType and for each of it's
// InstanceRole .
type AdditionalLimit struct {
// Name of Additional Limit is specific to a given InstanceType and for each of
// it's InstanceRole etc.
//
// Attributes and their details:
//
// - MaximumNumberOfDataNodesSupported This attribute will be present in Master
// node only to specify how much data nodes upto which given
// ESPartitionInstanceType can support as master node.
// - MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in
// Data node only to specify how much data nodes of given ESPartitionInstanceType
// upto which you don't need any master nodes to govern them.
LimitName *string
// Value for given AdditionalLimit$LimitName .
LimitValues []string
noSmithyDocumentSerde
}
// Status of the advanced options for the specified Elasticsearch domain.
// Currently, the following advanced options are available:
// - Option to allow references to indices in an HTTP request body. Must be false
// when configuring access to individual sub-resources. By default, the value is
// true . See Configuration Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
// for more information.
// - Option to specify the percentage of heap space that is allocated to field
// data. By default, this setting is unbounded.
//
// For more information, see Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
// .
type AdvancedOptionsStatus struct {
// Specifies the status of advanced options for the specified Elasticsearch domain.
//
// This member is required.
Options map[string]string
// Specifies the status of OptionStatus for advanced options for the specified
// Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Specifies the advanced security configuration: whether advanced security is
// enabled, whether the internal database option is enabled.
type AdvancedSecurityOptions struct {
// Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthDisableDate *time.Time
// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
// AdvancedSecurity is enabled on existing domains.
AnonymousAuthEnabled *bool
// True if advanced security is enabled.
Enabled *bool
// True if the internal user database is enabled.
InternalUserDatabaseEnabled *bool
// Describes the SAML application configured for a domain.
SAMLOptions *SAMLOptionsOutput
noSmithyDocumentSerde
}
// Specifies the advanced security configuration: whether advanced security is
// enabled, whether the internal database option is enabled, master username and
// password (if internal database is enabled), and master user ARN (if IAM is
// enabled).
type AdvancedSecurityOptionsInput struct {
// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
// AdvancedSecurity is enabled on existing domains.
AnonymousAuthEnabled *bool
// True if advanced security is enabled.
Enabled *bool
// True if the internal user database is enabled.
InternalUserDatabaseEnabled *bool
// Credentials for the master user: username and password, ARN, or both.
MasterUserOptions *MasterUserOptions
// Specifies the SAML application configuration for the domain.
SAMLOptions *SAMLOptionsInput
noSmithyDocumentSerde
}
// Specifies the status of advanced security options for the specified
// Elasticsearch domain.
type AdvancedSecurityOptionsStatus struct {
// Specifies advanced security options for the specified Elasticsearch domain.
//
// This member is required.
Options *AdvancedSecurityOptions
// Status of the advanced security options for the specified Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Information about an account or service that has access to an Amazon OpenSearch
// Service domain through the use of an interface VPC endpoint.
type AuthorizedPrincipal struct {
// The IAM principal that is allowed access to the domain.
Principal *string
// The type of principal.
PrincipalType PrincipalType
noSmithyDocumentSerde
}
// Specifies Auto-Tune type and Auto-Tune action details.
type AutoTune struct {
// Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
AutoTuneDetails *AutoTuneDetails
// Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
AutoTuneType AutoTuneType
noSmithyDocumentSerde
}
// Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
type AutoTuneDetails struct {
// Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
ScheduledAutoTuneDetails *ScheduledAutoTuneDetails
noSmithyDocumentSerde
}
// Specifies Auto-Tune maitenance schedule. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
type AutoTuneMaintenanceSchedule struct {
// Specifies cron expression for a recurring maintenance schedule. See the
// Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
CronExpressionForRecurrence *string
// Specifies maintenance schedule duration: duration value and duration unit. See
// the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
Duration *Duration
// Specifies timestamp at which Auto-Tune maintenance schedule start.
StartAt *time.Time
noSmithyDocumentSerde
}
// Specifies the Auto-Tune options: the Auto-Tune desired state for the domain,
// rollback state when disabling Auto-Tune options and list of maintenance
// schedules.
type AutoTuneOptions struct {
// Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
DesiredState AutoTuneDesiredState
// Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
MaintenanceSchedules []AutoTuneMaintenanceSchedule
// Specifies the rollback state while disabling Auto-Tune for the domain. Valid
// values are NO_ROLLBACK, DEFAULT_ROLLBACK.
RollbackOnDisable RollbackOnDisable
noSmithyDocumentSerde
}
// Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and
// list of maintenance schedules.
type AutoTuneOptionsInput struct {
// Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
DesiredState AutoTuneDesiredState
// Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
MaintenanceSchedules []AutoTuneMaintenanceSchedule
noSmithyDocumentSerde
}
// Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and
// list of maintenance schedules.
type AutoTuneOptionsOutput struct {
// Specifies the error message while enabling or disabling the Auto-Tune.
ErrorMessage *string
// Specifies the AutoTuneState for the Elasticsearch domain.
State AutoTuneState
noSmithyDocumentSerde
}
// Specifies the status of Auto-Tune options for the specified Elasticsearch
// domain.
type AutoTuneOptionsStatus struct {
// Specifies Auto-Tune options for the specified Elasticsearch domain.
Options *AutoTuneOptions
// Specifies Status of the Auto-Tune options for the specified Elasticsearch
// domain.
Status *AutoTuneStatus
noSmithyDocumentSerde
}
// Provides the current status of the Auto-Tune options.
type AutoTuneStatus struct {
// Timestamp which tells Auto-Tune options creation date .
//
// This member is required.
CreationDate *time.Time
// Specifies the AutoTuneState for the Elasticsearch domain.
//
// This member is required.
State AutoTuneState
// Timestamp which tells Auto-Tune options last updated time.
//
// This member is required.
UpdateDate *time.Time
// Specifies the error message while enabling or disabling the Auto-Tune options.
ErrorMessage *string
// Indicates whether the Elasticsearch domain is being deleted.
PendingDeletion *bool
// Specifies the Auto-Tune options latest version.
UpdateVersion int32
noSmithyDocumentSerde
}
// Specifies change details of the domain configuration change.
type ChangeProgressDetails struct {
// The unique change identifier associated with a specific domain configuration
// change.
ChangeId *string
// Contains an optional message associated with the domain configuration change.
Message *string
noSmithyDocumentSerde
}
// A progress stage details of a specific domain configuration change.
type ChangeProgressStage struct {
// The description of the progress stage.
Description *string
// The last updated timestamp of the progress stage.
LastUpdated *time.Time
// The name of the specific progress stage.
Name *string
// The overall status of a specific progress stage.
Status *string
noSmithyDocumentSerde
}
// The progress details of a specific domain configuration change.
type ChangeProgressStatusDetails struct {
// The unique change identifier associated with a specific domain configuration
// change.
ChangeId *string
// The specific stages that the domain is going through to perform the
// configuration change.
ChangeProgressStages []ChangeProgressStage
// The list of properties involved in the domain configuration change that are
// completed.
CompletedProperties []string
// The list of properties involved in the domain configuration change that are
// still in pending.
PendingProperties []string
// The time at which the configuration change is made on the domain.
StartTime *time.Time
// The overall status of the domain configuration change. This field can take the
// following values: PENDING , PROCESSING , COMPLETED and FAILED
Status OverallChangeStatus
// The total number of stages required for the configuration change.
TotalNumberOfStages int32
noSmithyDocumentSerde
}
// Options to specify the Cognito user and identity pools for Kibana
// authentication. For more information, see Amazon Cognito Authentication for
// Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html)
// .
type CognitoOptions struct {
// Specifies the option to enable Cognito for Kibana authentication.
Enabled *bool
// Specifies the Cognito identity pool ID for Kibana authentication.
IdentityPoolId *string
// Specifies the role ARN that provides Elasticsearch permissions for accessing
// Cognito resources.
RoleArn *string
// Specifies the Cognito user pool ID for Kibana authentication.
UserPoolId *string
noSmithyDocumentSerde
}
// Status of the Cognito options for the specified Elasticsearch domain.
type CognitoOptionsStatus struct {
// Specifies the Cognito options for the specified Elasticsearch domain.
//
// This member is required.
Options *CognitoOptions
// Specifies the status of the Cognito options for the specified Elasticsearch
// domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Specifies the configuration for cold storage options such as enabled
type ColdStorageOptions struct {
// Enable cold storage option. Accepted values true or false
//
// This member is required.
Enabled *bool
noSmithyDocumentSerde
}
// A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion
// s to which the domain can be upgraded.
type CompatibleVersionsMap struct {
// The current version of Elasticsearch on which a domain is.
SourceVersion *string
// List of supported elastic search versions.
TargetVersions []string
noSmithyDocumentSerde
}
// Filter to apply in DescribePackage response.
type DescribePackagesFilter struct {
// Any field from PackageDetails .
Name DescribePackagesFilterName
// A non-empty list of values for the specified field.
Value []string
noSmithyDocumentSerde
}
// Options to configure endpoint for the Elasticsearch domain.
type DomainEndpointOptions struct {
// Specify the fully qualified domain for your custom endpoint.
CustomEndpoint *string
// Specify ACM certificate ARN for your custom endpoint.
CustomEndpointCertificateArn *string
// Specify if custom endpoint should be enabled for the Elasticsearch domain.
CustomEndpointEnabled *bool
// Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
EnforceHTTPS *bool
// Specify the TLS security policy that needs to be applied to the HTTPS endpoint
// of Elasticsearch domain.
//
// It can be one of the following values:
// - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version
// 1.0 to TLS version 1.2
// - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS
// version 1.2
// - Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS
// version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
TLSSecurityPolicy TLSSecurityPolicy
noSmithyDocumentSerde
}
// The configured endpoint options for the domain and their current status.
type DomainEndpointOptionsStatus struct {
// Options to configure endpoint for the Elasticsearch domain.
//
// This member is required.
Options *DomainEndpointOptions
// The status of the endpoint options for the Elasticsearch domain. See
// OptionStatus for the status information that's included.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
type DomainInfo struct {
// Specifies the DomainName .
DomainName *string
// Specifies the EngineType of the domain.
EngineType EngineType
noSmithyDocumentSerde
}
type DomainInformation struct {
// The name of an Elasticsearch domain. Domain names are unique across the domains
// owned by an account within an AWS region. Domain names start with a letter or
// number and can contain the following characters: a-z (lowercase), 0-9, and -
// (hyphen).
//
// This member is required.
DomainName *string
OwnerId *string
Region *string
noSmithyDocumentSerde
}
// Information on a package that is associated with a domain.
type DomainPackageDetails struct {
// Name of the domain you've associated a package with.
DomainName *string
// State of the association. Values are
// ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
DomainPackageStatus DomainPackageStatus
// Additional information if the package is in an error state. Null otherwise.
ErrorDetails *ErrorDetails
// Timestamp of the most-recent update to the association status.
LastUpdated *time.Time
// Internal ID of the package.
PackageID *string
// User specified name of the package.
PackageName *string
// Currently supports only TXT-DICTIONARY.
PackageType PackageType
PackageVersion *string
// The relative path on Amazon ES nodes, which can be used as synonym_path when
// the package is synonym file.
ReferencePath *string
noSmithyDocumentSerde
}
type DryRunResults struct {
// Specifies the deployment mechanism through which the update shall be applied on
// the domain. Possible responses are Blue/Green (The update will require a
// blue/green deployment.) DynamicUpdate (The update can be applied in-place
// without a Blue/Green deployment required.) Undetermined (The domain is
// undergoing an update which needs to complete before the deployment type can be
// predicted.) None (The configuration change matches the current configuration
// and will not result in any update.)
DeploymentType *string
// Contains an optional message associated with the DryRunResults.
Message *string
noSmithyDocumentSerde
}
// Specifies maintenance schedule duration: duration value and duration unit. See
// the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
type Duration struct {
// Specifies the unit of a maintenance schedule duration. Valid value is HOURS.
// See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
Unit TimeUnit
// Integer to specify the value of a maintenance schedule duration. See the
// Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
Value *int64
noSmithyDocumentSerde
}
// Options to enable, disable, and specify the properties of EBS storage volumes.
// For more information, see Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)
// .
type EBSOptions struct {
// Specifies whether EBS-based storage is enabled.
EBSEnabled *bool
// Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Iops *int32
// Specifies the Throughput for GP3 EBS volume (SSD).
Throughput *int32
// Integer to specify the size of an EBS volume.
VolumeSize *int32
// Specifies the volume type for EBS-based storage.
VolumeType VolumeType
noSmithyDocumentSerde
}
// Status of the EBS options for the specified Elasticsearch domain.
type EBSOptionsStatus struct {
// Specifies the EBS options for the specified Elasticsearch domain.
//
// This member is required.
Options *EBSOptions
// Specifies the status of the EBS options for the specified Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Specifies the configuration for the domain cluster, such as the type and number
// of instances.
type ElasticsearchClusterConfig struct {
// Specifies the ColdStorageOptions config for Elasticsearch Domain
ColdStorageOptions *ColdStorageOptions
// Total number of dedicated master nodes, active and on standby, for the cluster.
DedicatedMasterCount *int32
// A boolean value to indicate whether a dedicated master node is enabled. See
// About Dedicated Master Nodes (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes)
// for more information.
DedicatedMasterEnabled *bool
// The instance type for a dedicated master node.
DedicatedMasterType ESPartitionInstanceType
// The number of instances in the specified domain cluster.
InstanceCount *int32
// The instance type for an Elasticsearch cluster. UltraWarm instance types are
// not supported for data instances.
InstanceType ESPartitionInstanceType
// The number of warm nodes in the cluster.
WarmCount *int32
// True to enable warm storage.
WarmEnabled *bool
// The instance type for the Elasticsearch cluster's warm nodes.
WarmType ESWarmPartitionInstanceType
// Specifies the zone awareness configuration for a domain when zone awareness is
// enabled.
ZoneAwarenessConfig *ZoneAwarenessConfig
// A boolean value to indicate whether zone awareness is enabled. See About Zone
// Awareness (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness)
// for more information.
ZoneAwarenessEnabled *bool
noSmithyDocumentSerde
}
// Specifies the configuration status for the specified Elasticsearch domain.
type ElasticsearchClusterConfigStatus struct {
// Specifies the cluster configuration for the specified Elasticsearch domain.
//
// This member is required.
Options *ElasticsearchClusterConfig
// Specifies the status of the configuration for the specified Elasticsearch
// domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// The configuration of an Elasticsearch domain.
type ElasticsearchDomainConfig struct {
// IAM access policy as a JSON-formatted string.
AccessPolicies *AccessPoliciesStatus
// Specifies the AdvancedOptions for the domain. See Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options)
// for more information.
AdvancedOptions *AdvancedOptionsStatus
// Specifies AdvancedSecurityOptions for the domain.
AdvancedSecurityOptions *AdvancedSecurityOptionsStatus
// Specifies AutoTuneOptions for the domain.
AutoTuneOptions *AutoTuneOptionsStatus
// Specifies change details of the domain configuration change.
ChangeProgressDetails *ChangeProgressDetails
// The CognitoOptions for the specified domain. For more information, see Amazon
// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html)
// .
CognitoOptions *CognitoOptionsStatus
// Specifies the DomainEndpointOptions for the Elasticsearch domain.
DomainEndpointOptions *DomainEndpointOptionsStatus
// Specifies the EBSOptions for the Elasticsearch domain.
EBSOptions *EBSOptionsStatus
// Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
ElasticsearchClusterConfig *ElasticsearchClusterConfigStatus
// String of format X.Y to specify version for the Elasticsearch domain.
ElasticsearchVersion *ElasticsearchVersionStatus
// Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
EncryptionAtRestOptions *EncryptionAtRestOptionsStatus
// Log publishing options for the given domain.
LogPublishingOptions *LogPublishingOptionsStatus
// Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus
// Specifies the SnapshotOptions for the Elasticsearch domain.
SnapshotOptions *SnapshotOptionsStatus
// The VPCOptions for the specified domain. For more information, see VPC
// Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
// .
VPCOptions *VPCDerivedInfoStatus
noSmithyDocumentSerde
}
// The current status of an Elasticsearch domain.
type ElasticsearchDomainStatus struct {
// The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for
// IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
// in Using AWS Identity and Access Management for more information.
//
// This member is required.
ARN *string
// The unique identifier for the specified Elasticsearch domain.
//
// This member is required.
DomainId *string
// The name of an Elasticsearch domain. Domain names are unique across the domains
// owned by an account within an AWS region. Domain names start with a letter or
// number and can contain the following characters: a-z (lowercase), 0-9, and -
// (hyphen).
//
// This member is required.
DomainName *string
// The type and number of instances in the domain cluster.
//
// This member is required.
ElasticsearchClusterConfig *ElasticsearchClusterConfig
// IAM access policy as a JSON-formatted string.
AccessPolicies *string
// Specifies the status of the AdvancedOptions
AdvancedOptions map[string]string
// The current status of the Elasticsearch domain's advanced security options.
AdvancedSecurityOptions *AdvancedSecurityOptions
// The current status of the Elasticsearch domain's Auto-Tune options.
AutoTuneOptions *AutoTuneOptionsOutput
// Specifies change details of the domain configuration change.
ChangeProgressDetails *ChangeProgressDetails
// The CognitoOptions for the specified domain. For more information, see Amazon
// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html)
// .
CognitoOptions *CognitoOptions
// The domain creation status. True if the creation of an Elasticsearch domain is
// complete. False if domain creation is still in progress.
Created *bool
// The domain deletion status. True if a delete request has been received for the
// domain but resource cleanup is still in progress. False if the domain has not
// been deleted. Once domain deletion is complete, the status of the domain is no
// longer returned.
Deleted *bool
// The current status of the Elasticsearch domain's endpoint options.
DomainEndpointOptions *DomainEndpointOptions
// The EBSOptions for the specified domain. See Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)
// for more information.
EBSOptions *EBSOptions
ElasticsearchVersion *string
// Specifies the status of the EncryptionAtRestOptions .
EncryptionAtRestOptions *EncryptionAtRestOptions
// The Elasticsearch domain endpoint that you use to submit index and search
// requests.
Endpoint *string
// Map containing the Elasticsearch domain endpoints used to submit index and
// search requests. Example key, value :
// 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
Endpoints map[string]string
// Log publishing options for the given domain.
LogPublishingOptions map[string]LogPublishingOption
// Specifies the status of the NodeToNodeEncryptionOptions .
NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions
// The status of the Elasticsearch domain configuration. True if Amazon
// Elasticsearch Service is processing configuration changes. False if the
// configuration is active.
Processing *bool
// The current status of the Elasticsearch domain's service software.
ServiceSoftwareOptions *ServiceSoftwareOptions
// Specifies the status of the SnapshotOptions
SnapshotOptions *SnapshotOptions
// The status of an Elasticsearch domain version upgrade. True if Amazon
// Elasticsearch Service is undergoing a version upgrade. False if the
// configuration is active.
UpgradeProcessing *bool
// The VPCOptions for the specified domain. For more information, see VPC
// Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
// .
VPCOptions *VPCDerivedInfo
noSmithyDocumentSerde
}
// Status of the Elasticsearch version options for the specified Elasticsearch
// domain.
type ElasticsearchVersionStatus struct {
// Specifies the Elasticsearch version for the specified Elasticsearch domain.
//
// This member is required.
Options *string
// Specifies the status of the Elasticsearch version options for the specified
// Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Specifies the Encryption At Rest Options.
type EncryptionAtRestOptions struct {
// Specifies the option to enable Encryption At Rest.
Enabled *bool
// Specifies the KMS Key ID for Encryption At Rest options.
KmsKeyId *string
noSmithyDocumentSerde
}
// Status of the Encryption At Rest options for the specified Elasticsearch domain.
type EncryptionAtRestOptionsStatus struct {
// Specifies the Encryption At Rest options for the specified Elasticsearch domain.
//
// This member is required.
Options *EncryptionAtRestOptions
// Specifies the status of the Encryption At Rest options for the specified
// Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
type ErrorDetails struct {
ErrorMessage *string
ErrorType *string
noSmithyDocumentSerde
}
// A filter used to limit results when describing inbound or outbound
// cross-cluster search connections. Multiple values can be specified per filter. A
// cross-cluster search connection must match at least one of the specified values
// for it to be returned from an operation.
type Filter struct {
// Specifies the name of the filter.
Name *string
// Contains one or more values for the filter.
Values []string
noSmithyDocumentSerde
}
// Specifies details of an inbound connection.
type InboundCrossClusterSearchConnection struct {
// Specifies the InboundCrossClusterSearchConnectionStatus for the outbound
// connection.
ConnectionStatus *InboundCrossClusterSearchConnectionStatus
// Specifies the connection id for the inbound cross-cluster search connection.
CrossClusterSearchConnectionId *string
// Specifies the DomainInformation for the destination Elasticsearch domain.
DestinationDomainInfo *DomainInformation
// Specifies the DomainInformation for the source Elasticsearch domain.
SourceDomainInfo *DomainInformation
noSmithyDocumentSerde
}
// Specifies the coonection status of an inbound cross-cluster search connection.
type InboundCrossClusterSearchConnectionStatus struct {
// Specifies verbose information for the inbound connection status.
Message *string
// The state code for inbound connection. This can be one of the following:
// - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination
// domain owner.
// - APPROVED: Inbound connection is pending acceptance by destination domain
// owner.
// - REJECTING: Inbound connection rejection is in process.
// - REJECTED: Inbound connection is rejected.
// - DELETING: Inbound connection deletion is in progress.
// - DELETED: Inbound connection is deleted and cannot be used further.
StatusCode InboundCrossClusterSearchConnectionStatusCode
noSmithyDocumentSerde
}
// InstanceCountLimits represents the limits on number of instances that be
// created in Amazon Elasticsearch for given InstanceType.
type InstanceCountLimits struct {
// Maximum number of Instances that can be instantiated for given InstanceType.
MaximumInstanceCount int32
// Minimum number of Instances that can be instantiated for given InstanceType.
MinimumInstanceCount int32
noSmithyDocumentSerde
}
// InstanceLimits represents the list of instance related attributes that are
// available for given InstanceType.
type InstanceLimits struct {
// InstanceCountLimits represents the limits on number of instances that be
// created in Amazon Elasticsearch for given InstanceType.
InstanceCountLimits *InstanceCountLimits
noSmithyDocumentSerde
}
// Limits for given InstanceType and for each of it's role.
//
// Limits contains following StorageTypes, InstanceLimits and AdditionalLimits
type Limits struct {
// List of additional limits that are specific to a given InstanceType and for
// each of it's InstanceRole .
AdditionalLimits []AdditionalLimit
// InstanceLimits represents the list of instance related attributes that are
// available for given InstanceType.
InstanceLimits *InstanceLimits
// StorageType represents the list of storage related types and attributes that
// are available for given InstanceType.
StorageTypes []StorageType
noSmithyDocumentSerde
}
// Log Publishing option that is set for given domain.
//
// Attributes and their details:
// - CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log
// needs to be published.
// - Enabled: Whether the log publishing for given log type is enabled or not
type LogPublishingOption struct {
// ARN of the Cloudwatch log group to which log needs to be published.
CloudWatchLogsLogGroupArn *string
// Specifies whether given log publishing option is enabled or not.
Enabled *bool
noSmithyDocumentSerde
}
// The configured log publishing options for the domain and their current status.
type LogPublishingOptionsStatus struct {
// The log publishing options configured for the Elasticsearch domain.
Options map[string]LogPublishingOption
// The status of the log publishing options for the Elasticsearch domain. See
// OptionStatus for the status information that's included.
Status *OptionStatus
noSmithyDocumentSerde
}
// Credentials for the master user: username and password, ARN, or both.
type MasterUserOptions struct {
// ARN for the master user (if IAM is enabled).
MasterUserARN *string
// The master user's username, which is stored in the Amazon Elasticsearch Service
// domain's internal database.
MasterUserName *string
// The master user's password, which is stored in the Amazon Elasticsearch Service
// domain's internal database.
MasterUserPassword *string
noSmithyDocumentSerde
}
// Specifies the node-to-node encryption options.
type NodeToNodeEncryptionOptions struct {
// Specify true to enable node-to-node encryption.
Enabled *bool
noSmithyDocumentSerde
}
// Status of the node-to-node encryption options for the specified Elasticsearch
// domain.
type NodeToNodeEncryptionOptionsStatus struct {
// Specifies the node-to-node encryption options for the specified Elasticsearch
// domain.
//
// This member is required.
Options *NodeToNodeEncryptionOptions
// Specifies the status of the node-to-node encryption options for the specified
// Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// Provides the current status of the entity.
type OptionStatus struct {
// Timestamp which tells the creation date for the entity.
//
// This member is required.
CreationDate *time.Time
// Provides the OptionState for the Elasticsearch domain.
//
// This member is required.
State OptionState
// Timestamp which tells the last updated time for the entity.
//
// This member is required.
UpdateDate *time.Time
// Indicates whether the Elasticsearch domain is being deleted.
PendingDeletion *bool
// Specifies the latest version for the entity.
UpdateVersion int32
noSmithyDocumentSerde
}
// Specifies details of an outbound connection.
type OutboundCrossClusterSearchConnection struct {
// Specifies the connection alias for the outbound cross-cluster search connection.
ConnectionAlias *string
// Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound
// connection.
ConnectionStatus *OutboundCrossClusterSearchConnectionStatus
// Specifies the connection id for the outbound cross-cluster search connection.
CrossClusterSearchConnectionId *string
// Specifies the DomainInformation for the destination Elasticsearch domain.
DestinationDomainInfo *DomainInformation
// Specifies the DomainInformation for the source Elasticsearch domain.
SourceDomainInfo *DomainInformation
noSmithyDocumentSerde
}
// Specifies the connection status of an outbound cross-cluster search connection.
type OutboundCrossClusterSearchConnectionStatus struct {
// Specifies verbose information for the outbound connection status.
Message *string
// The state code for outbound connection. This can be one of the following:
// - VALIDATING: The outbound connection request is being validated.
// - VALIDATION_FAILED: Validation failed for the connection request.
// - PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet
// accepted by destination domain owner.
// - PROVISIONING: Outbound connection request is in process.
// - ACTIVE: Outbound connection is active and ready to use.
// - REJECTED: Outbound connection request is rejected by destination domain
// owner.
// - DELETING: Outbound connection deletion is in progress.
// - DELETED: Outbound connection is deleted and cannot be used further.
StatusCode OutboundCrossClusterSearchConnectionStatusCode
noSmithyDocumentSerde
}
// Basic information about a package.
type PackageDetails struct {
AvailablePackageVersion *string
// Timestamp which tells creation date of the package.
CreatedAt *time.Time
// Additional information if the package is in an error state. Null otherwise.
ErrorDetails *ErrorDetails
LastUpdatedAt *time.Time
// User-specified description of the package.
PackageDescription *string
// Internal ID of the package.
PackageID *string
// User specified name of the package.
PackageName *string
// Current state of the package. Values are
// COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
PackageStatus PackageStatus
// Currently supports only TXT-DICTIONARY.
PackageType PackageType
noSmithyDocumentSerde
}
// The S3 location for importing the package specified as S3BucketName and S3Key
type PackageSource struct {
// Name of the bucket containing the package.
S3BucketName *string
// Key (file name) of the package.
S3Key *string
noSmithyDocumentSerde
}
// Details of a package version.
type PackageVersionHistory struct {
// A message associated with the version.
CommitMessage *string
// Timestamp which tells creation time of the package version.
CreatedAt *time.Time
// Version of the package.
PackageVersion *string
noSmithyDocumentSerde
}
// Contains the specific price and frequency of a recurring charges for a reserved
// Elasticsearch instance, or for a reserved Elasticsearch instance offering.
type RecurringCharge struct {
// The monetary amount of the recurring charge.
RecurringChargeAmount *float64
// The frequency of the recurring charge.
RecurringChargeFrequency *string
noSmithyDocumentSerde
}
// Details of a reserved Elasticsearch instance.
type ReservedElasticsearchInstance struct {
// The currency code for the reserved Elasticsearch instance offering.
CurrencyCode *string
// The duration, in seconds, for which the Elasticsearch instance is reserved.
Duration int32
// The number of Elasticsearch instances that have been reserved.
ElasticsearchInstanceCount int32
// The Elasticsearch instance type offered by the reserved instance offering.
ElasticsearchInstanceType ESPartitionInstanceType
// The upfront fixed charge you will paid to purchase the specific reserved
// Elasticsearch instance offering.
FixedPrice *float64
// The payment option as defined in the reserved Elasticsearch instance offering.
PaymentOption ReservedElasticsearchInstancePaymentOption
// The charge to your account regardless of whether you are creating any domains
// using the instance offering.
RecurringCharges []RecurringCharge
// The customer-specified identifier to track this reservation.
ReservationName *string
// The unique identifier for the reservation.
ReservedElasticsearchInstanceId *string
// The offering identifier.
ReservedElasticsearchInstanceOfferingId *string
// The time the reservation started.
StartTime *time.Time
// The state of the reserved Elasticsearch instance.
State *string
// The rate you are charged for each hour for the domain that is using this
// reserved instance.
UsagePrice *float64
noSmithyDocumentSerde
}
// Details of a reserved Elasticsearch instance offering.
type ReservedElasticsearchInstanceOffering struct {
// The currency code for the reserved Elasticsearch instance offering.
CurrencyCode *string
// The duration, in seconds, for which the offering will reserve the Elasticsearch
// instance.
Duration int32
// The Elasticsearch instance type offered by the reserved instance offering.
ElasticsearchInstanceType ESPartitionInstanceType
// The upfront fixed charge you will pay to purchase the specific reserved
// Elasticsearch instance offering.
FixedPrice *float64
// Payment option for the reserved Elasticsearch instance offering
PaymentOption ReservedElasticsearchInstancePaymentOption
// The charge to your account regardless of whether you are creating any domains
// using the instance offering.
RecurringCharges []RecurringCharge
// The Elasticsearch reserved instance offering identifier.
ReservedElasticsearchInstanceOfferingId *string
// The rate you are charged for each hour the domain that is using the offering is
// running.
UsagePrice *float64
noSmithyDocumentSerde
}
// Specifies the SAML Identity Provider's information.
type SAMLIdp struct {
// The unique Entity ID of the application in SAML Identity Provider.
//
// This member is required.
EntityId *string
// The Metadata of the SAML application in xml format.
//
// This member is required.
MetadataContent *string
noSmithyDocumentSerde
}
// Specifies the SAML application configuration for the domain.
type SAMLOptionsInput struct {
// True if SAML is enabled.
Enabled *bool
// Specifies the SAML Identity Provider's information.
Idp *SAMLIdp
// The backend role to which the SAML master user is mapped to.
MasterBackendRole *string
// The SAML master username, which is stored in the Amazon Elasticsearch Service
// domain's internal database.
MasterUserName *string
// The key to use for matching the SAML Roles attribute.
RolesKey *string
// The duration, in minutes, after which a user session becomes inactive.
// Acceptable values are between 1 and 1440, and the default value is 60.
SessionTimeoutMinutes *int32
// The key to use for matching the SAML Subject attribute.
SubjectKey *string
noSmithyDocumentSerde
}
// Describes the SAML application configured for the domain.
type SAMLOptionsOutput struct {
// True if SAML is enabled.
Enabled *bool
// Describes the SAML Identity Provider's information.
Idp *SAMLIdp
// The key used for matching the SAML Roles attribute.
RolesKey *string
// The duration, in minutes, after which a user session becomes inactive.
SessionTimeoutMinutes *int32
// The key used for matching the SAML Subject attribute.
SubjectKey *string
noSmithyDocumentSerde
}
// Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html)
// for more information.
type ScheduledAutoTuneDetails struct {
// Specifies Auto-Tune action description.
Action *string
// Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and
// JVM_YOUNG_GEN_TUNING.
ActionType ScheduledAutoTuneActionType
// Specifies timestamp for the Auto-Tune action scheduled for the domain.
Date *time.Time
// Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
Severity ScheduledAutoTuneSeverityType
noSmithyDocumentSerde
}
// The current options of an Elasticsearch domain service software options.
type ServiceSoftwareOptions struct {
// Timestamp, in Epoch time, until which you can manually request a service
// software update. After this date, we automatically update your service software.
AutomatedUpdateDate *time.Time
// True if you are able to cancel your service software version update. False if
// you are not able to cancel your service software version.
Cancellable *bool
// The current service software version that is present on the domain.
CurrentVersion *string
// The description of the UpdateStatus .
Description *string
// The new service software version if one is available.
NewVersion *string
// True if a service software is never automatically updated. False if a service
// software is automatically updated after AutomatedUpdateDate .
OptionalDeployment *bool
// True if you are able to update you service software version. False if you are
// not able to update your service software version.
UpdateAvailable *bool
// The status of your service software update. This field can take the following
// values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
UpdateStatus DeploymentStatus
noSmithyDocumentSerde
}
// Specifies the time, in UTC format, when the service takes a daily automated
// snapshot of the specified Elasticsearch domain. Default value is 0 hours.
type SnapshotOptions struct {
// Specifies the time, in UTC format, when the service takes a daily automated
// snapshot of the specified Elasticsearch domain. Default value is 0 hours.
AutomatedSnapshotStartHour *int32
noSmithyDocumentSerde
}
// Status of a daily automated snapshot.
type SnapshotOptionsStatus struct {
// Specifies the daily snapshot options specified for the Elasticsearch domain.
//
// This member is required.
Options *SnapshotOptions
// Specifies the status of a daily automated snapshot.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// StorageTypes represents the list of storage related types and their attributes
// that are available for given InstanceType.
type StorageType struct {
// SubType of the given storage type. List of available sub-storage options: For
// "instance" storageType we wont have any storageSubType, in case of "ebs"
// storageType we will have following valid storageSubTypes
// - standard
// - gp2
// - gp3
// - io1
// Refer VolumeType for more information regarding above EBS storage options.
StorageSubTypeName *string
// List of limits that are applicable for given storage type.
StorageTypeLimits []StorageTypeLimit
// Type of the storage. List of available storage options:
// - instance Inbuilt storage available for the given Instance
// - ebs Elastic block storage that would be attached to the given Instance
StorageTypeName *string
noSmithyDocumentSerde
}
// Limits that are applicable for given storage type.
type StorageTypeLimit struct {
// Name of storage limits that are applicable for given storage type. If
// StorageType is ebs, following storage options are applicable
// - MinimumVolumeSize Minimum amount of volume size that is applicable for given
// storage type.It can be empty if it is not applicable.
// - MaximumVolumeSize Maximum amount of volume size that is applicable for given
// storage type.It can be empty if it is not applicable.
// - MaximumIops Maximum amount of Iops that is applicable for given storage
// type.It can be empty if it is not applicable.
// - MinimumIops Minimum amount of Iops that is applicable for given storage
// type.It can be empty if it is not applicable.
// - MaximumThroughput Maximum amount of Throughput that is applicable for given
// storage type.It can be empty if it is not applicable.
// - MinimumThroughput Minimum amount of Throughput that is applicable for given
// storage type.It can be empty if it is not applicable.
LimitName *string
// Values for the StorageTypeLimit$LimitName .
LimitValues []string
noSmithyDocumentSerde
}
// Specifies a key value pair for a resource tag.
type Tag struct {
// Specifies the TagKey , the name of the tag. Tag keys must be unique for the
// Elasticsearch domain to which they are attached.
//
// This member is required.
Key *string
// Specifies the TagValue , the value assigned to the corresponding tag key. Tag
// values can be null and do not have to be unique in a tag set. For example, you
// can have a key value pair in a tag set of project : Trinity and cost-center :
// Trinity
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// History of the last 10 Upgrades and Upgrade Eligibility Checks.
type UpgradeHistory struct {
// UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ"
// format.
StartTimestamp *time.Time
// A list of UpgradeStepItem s representing information about each step performed
// as pard of a specific Upgrade or Upgrade Eligibility Check.
StepsList []UpgradeStepItem
// A string that describes the update briefly
UpgradeName *string
// The overall status of the update. The status can take one of the following
// values:
// - In Progress
// - Succeeded
// - Succeeded with Issues
// - Failed
UpgradeStatus UpgradeStatus
noSmithyDocumentSerde
}
// Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
type UpgradeStepItem struct {
// A list of strings containing detailed information about the errors encountered
// in a particular step.
Issues []string
// The Floating point value representing progress percentage of a particular step.
ProgressPercent *float64
// Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
// through:
// - PreUpgradeCheck
// - Snapshot
// - Upgrade
UpgradeStep UpgradeStep
// The status of a particular step during an upgrade. The status can take one of
// the following values:
// - In Progress
// - Succeeded
// - Succeeded with Issues
// - Failed
UpgradeStepStatus UpgradeStatus
noSmithyDocumentSerde
}
// Options to specify the subnets and security groups for VPC endpoint. For more
// information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
// .
type VPCDerivedInfo struct {
// The availability zones for the Elasticsearch domain. Exists only if the domain
// was created with VPCOptions.
AvailabilityZones []string
// Specifies the security groups for VPC endpoint.
SecurityGroupIds []string
// Specifies the subnets for VPC endpoint.
SubnetIds []string
// The VPC Id for the Elasticsearch domain. Exists only if the domain was created
// with VPCOptions.
VPCId *string
noSmithyDocumentSerde
}
// Status of the VPC options for the specified Elasticsearch domain.
type VPCDerivedInfoStatus struct {
// Specifies the VPC options for the specified Elasticsearch domain.
//
// This member is required.
Options *VPCDerivedInfo
// Specifies the status of the VPC options for the specified Elasticsearch domain.
//
// This member is required.
Status *OptionStatus
noSmithyDocumentSerde
}
// The connection endpoint for connecting to an Amazon OpenSearch Service domain
// through a proxy.
type VpcEndpoint struct {
// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
DomainArn *string
// The connection endpoint ID for connecting to the domain.
Endpoint *string
// The current status of the endpoint.
Status VpcEndpointStatus
// The unique identifier of the endpoint.
VpcEndpointId *string
// The creator of the endpoint.
VpcEndpointOwner *string
// Options to specify the subnets and security groups for an Amazon OpenSearch
// Service VPC endpoint.
VpcOptions *VPCDerivedInfo
noSmithyDocumentSerde
}
// Error information when attempting to describe an Amazon OpenSearch
// Service-managed VPC endpoint.
type VpcEndpointError struct {
// The code associated with the error.
ErrorCode VpcEndpointErrorCode
// A message describing the error.
ErrorMessage *string
// The unique identifier of the endpoint.
VpcEndpointId *string
noSmithyDocumentSerde
}
// Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
type VpcEndpointSummary struct {
// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
DomainArn *string
// The current status of the endpoint.
Status VpcEndpointStatus
// The unique identifier of the endpoint.
VpcEndpointId *string
// The creator of the endpoint.
VpcEndpointOwner *string
noSmithyDocumentSerde
}
// Options to specify the subnets and security groups for VPC endpoint. For more
// information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html)
// .
type VPCOptions struct {
// Specifies the security groups for VPC endpoint.
SecurityGroupIds []string
// Specifies the subnets for VPC endpoint.
SubnetIds []string
noSmithyDocumentSerde
}
// Specifies the zone awareness configuration for the domain cluster, such as the
// number of availability zones.
type ZoneAwarenessConfig struct {
// An integer value to indicate the number of availability zones for a domain when
// zone awareness is enabled. This should be equal to number of subnets if VPC
// endpoints is enabled
AvailabilityZoneCount *int32
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|