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 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// A list of backup options for each resource type.
type AdvancedBackupSetting struct {
// Specifies the backup option for a selected resource. This option is only
// available for Windows VSS backup jobs. Valid values: Set to
// "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a
// Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup.
// The WindowsVSS option is not enabled by default. If you specify an invalid
// option, you get an InvalidParameterValueException exception. For more
// information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html)
// .
BackupOptions map[string]string
// Specifies an object containing resource type and backup options. The only
// supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy
// Service (VSS). For a CloudFormation example, see the sample CloudFormation
// template to enable Windows VSS (https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html)
// in the Backup User Guide. Valid values: EC2 .
ResourceType *string
noSmithyDocumentSerde
}
// Contains detailed information about a backup job.
type BackupJob struct {
// The account ID that owns the backup job.
AccountId *string
// Uniquely identifies a request to Backup to back up a resource.
BackupJobId *string
// Specifies the backup option for a selected resource. This option is only
// available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid
// values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option
// and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a
// regular backup. If you specify an invalid option, you get an
// InvalidParameterValueException exception.
BackupOptions map[string]string
// The size, in bytes, of a backup.
BackupSizeInBytes *int64
// Represents the type of backup for a backup job.
BackupType *string
// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
BackupVaultArn *string
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
BackupVaultName *string
// The size in bytes transferred to a backup vault at the time that the job status
// was queried.
BytesTransferred *int64
// The date and time a job to create a backup job is completed, in Unix format and
// Coordinated Universal Time (UTC). The value of CompletionDate is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
CompletionDate *time.Time
// Contains identifying information about the creation of a backup job, including
// the BackupPlanArn , BackupPlanId , BackupPlanVersion , and BackupRuleId of the
// backup plan used to create it.
CreatedBy *RecoveryPointCreator
// The date and time a backup job is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// The date and time a job to back up resources is expected to be completed, in
// Unix format and Coordinated Universal Time (UTC). The value of
// ExpectedCompletionDate is accurate to milliseconds. For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ExpectedCompletionDate *time.Time
// Specifies the IAM role ARN used to create the target recovery point. IAM roles
// other than the default role must include either AWSBackup or AwsBackup in the
// role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess . Role
// names without those strings lack permissions to perform backup jobs.
IamRoleArn *string
// This is the date on which the backup job was initiated.
InitiationDate *time.Time
// This is a boolean value indicating this is a parent (composite) backup job.
IsParent bool
// This parameter is the job count for the specified message category. Example
// strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and
// INVALIDPARAMETERS . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)
// for a list of MessageCategory strings. The the value ANY returns count of all
// message categories. AGGREGATE_ALL aggregates job counts for all message
// categories and returns the sum.
MessageCategory *string
// This uniquely identifies a request to Backup to back up a resource. The return
// will be the parent (composite) job ID.
ParentJobId *string
// Contains an estimated percentage complete of a job at the time the job status
// was queried.
PercentDone *string
// An ARN that uniquely identifies a recovery point; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
RecoveryPointArn *string
// An ARN that uniquely identifies a resource. The format of the ARN depends on
// the resource type.
ResourceArn *string
// This is the non-unique name of the resource that belongs to the specified
// backup.
ResourceName *string
// The type of Amazon Web Services resource to be backed up; for example, an
// Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database
// Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS)
// backups, the only supported resource type is Amazon EC2.
ResourceType *string
// Specifies the time in Unix format and Coordinated Universal Time (UTC) when a
// backup job must be started before it is canceled. The value is calculated by
// adding the start window to the scheduled time. So if the scheduled time were
// 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on
// the date specified. The value of StartBy is accurate to milliseconds. For
// example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
StartBy *time.Time
// The current state of a backup job.
State BackupJobState
// A detailed message explaining the status of the job to back up a resource.
StatusMessage *string
noSmithyDocumentSerde
}
// This is a summary of jobs created or running within the most recent 30 days.
// The returned summary may contain the following: Region, Account, State,
// RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
type BackupJobSummary struct {
// The account ID that owns the jobs within the summary.
AccountId *string
// The value as a number of jobs in a job summary.
Count int32
// The value of time in number format of a job end time. This value is the time in
// Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
// example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
EndTime *time.Time
// This parameter is the job count for the specified message category. Example
// strings include AccessDenied , Success , and InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)
// for a list of MessageCategory strings. The the value ANY returns count of all
// message categories. AGGREGATE_ALL aggregates job counts for all message
// categories and returns the sum.
MessageCategory *string
// The Amazon Web Services Regions within the job summary.
Region *string
// This value is the job count for the specified resource type. The request
// GetSupportedResourceTypes returns strings for supported resource types.
ResourceType *string
// The value of time in number format of a job start time. This value is the time
// in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
StartTime *time.Time
// This value is job count for jobs with the specified state.
State BackupJobStatus
noSmithyDocumentSerde
}
// Contains an optional backup plan display name and an array of BackupRule
// objects, each of which specifies a backup rule. Each rule in a backup plan is a
// separate scheduled task and can back up a different selection of Amazon Web
// Services resources.
type BackupPlan struct {
// The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
// characters.
//
// This member is required.
BackupPlanName *string
// An array of BackupRule objects, each of which specifies a scheduled task that
// is used to back up a selection of resources.
//
// This member is required.
Rules []BackupRule
// Contains a list of BackupOptions for each resource type.
AdvancedBackupSettings []AdvancedBackupSetting
noSmithyDocumentSerde
}
// Contains an optional backup plan display name and an array of BackupRule
// objects, each of which specifies a backup rule. Each rule in a backup plan is a
// separate scheduled task.
type BackupPlanInput struct {
// The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
// characters.
//
// This member is required.
BackupPlanName *string
// An array of BackupRule objects, each of which specifies a scheduled task that
// is used to back up a selection of resources.
//
// This member is required.
Rules []BackupRuleInput
// Specifies a list of BackupOptions for each resource type. These settings are
// only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
AdvancedBackupSettings []AdvancedBackupSetting
noSmithyDocumentSerde
}
// Contains metadata about a backup plan.
type BackupPlansListMember struct {
// Contains a list of BackupOptions for a resource type.
AdvancedBackupSettings []AdvancedBackupSetting
// An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for
// example,
// arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .
BackupPlanArn *string
// Uniquely identifies a backup plan.
BackupPlanId *string
// The display name of a saved backup plan.
BackupPlanName *string
// The date and time a resource backup plan is created, in Unix format and
// Coordinated Universal Time (UTC). The value of CreationDate is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
CreationDate *time.Time
// A unique string that identifies the request and allows failed requests to be
// retried without the risk of running the operation twice. This parameter is
// optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.'
// characters.
CreatorRequestId *string
// The date and time a backup plan is deleted, in Unix format and Coordinated
// Universal Time (UTC). The value of DeletionDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
DeletionDate *time.Time
// The last time a job to back up resources was run with this rule. A date and
// time, in Unix format and Coordinated Universal Time (UTC). The value of
// LastExecutionDate is accurate to milliseconds. For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastExecutionDate *time.Time
// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
// 1,024 bytes long. Version IDs cannot be edited.
VersionId *string
noSmithyDocumentSerde
}
// An object specifying metadata associated with a backup plan template.
type BackupPlanTemplatesListMember struct {
// Uniquely identifies a stored backup plan template.
BackupPlanTemplateId *string
// The optional display name of a backup plan template.
BackupPlanTemplateName *string
noSmithyDocumentSerde
}
// Specifies a scheduled task used to back up a selection of resources.
type BackupRule struct {
// A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
// characters.
//
// This member is required.
RuleName *string
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
//
// This member is required.
TargetBackupVaultName *string
// A value in minutes after a backup job is successfully started before it must be
// completed or it will be canceled by Backup. This value is optional.
CompletionWindowMinutes *int64
// An array of CopyAction objects, which contains the details of the copy
// operation.
CopyActions []CopyAction
// Specifies whether Backup creates continuous backups. True causes Backup to
// create continuous backups capable of point-in-time restore (PITR). False (or not
// specified) causes Backup to create snapshot backups.
EnableContinuousBackup *bool
// The lifecycle defines when a protected resource is transitioned to cold storage
// and when it expires. Backup transitions and expires backups automatically
// according to the lifecycle that you define. Backups transitioned to cold storage
// must be stored in cold storage for a minimum of 90 days. Therefore, the
// “retention” setting must be 90 days greater than the “transition to cold after
// days” setting. The “transition to cold after days” setting cannot be changed
// after a backup has been transitioned to cold. Resource types that are able to be
// transitioned to cold storage are listed in the "Lifecycle to cold storage"
// section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types.
Lifecycle *Lifecycle
// An array of key-value pair strings that are assigned to resources that are
// associated with this rule when restored from backup.
RecoveryPointTags map[string]string
// Uniquely identifies a rule that is used to schedule the backup of a selection
// of resources.
RuleId *string
// A cron expression in UTC specifying when Backup initiates a backup job. For
// more information about Amazon Web Services cron expressions, see Schedule
// Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)
// in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services
// cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past
// the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a
// table of examples, click the preceding link and scroll down the page.
ScheduleExpression *string
// This is the timezone in which the schedule expression is set. By default,
// ScheduleExpressions are in UTC. You can modify this to a specified timezone.
ScheduleExpressionTimezone *string
// A value in minutes after a backup is scheduled before a job will be canceled if
// it doesn't start successfully. This value is optional. If this value is
// included, it must be at least 60 minutes to avoid errors. During the start
// window, the backup job status remains in CREATED status until it has
// successfully begun or until the start window time has run out. If within the
// start window time Backup receives an error that allows the job to be retried,
// Backup will automatically retry to begin the job at least every 10 minutes until
// the backup successfully begins (the job status changes to RUNNING ) or until the
// job status changes to EXPIRED (which is expected to occur when the start window
// time is over).
StartWindowMinutes *int64
noSmithyDocumentSerde
}
// Specifies a scheduled task used to back up a selection of resources.
type BackupRuleInput struct {
// A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
// characters.
//
// This member is required.
RuleName *string
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
//
// This member is required.
TargetBackupVaultName *string
// A value in minutes after a backup job is successfully started before it must be
// completed or it will be canceled by Backup. This value is optional.
CompletionWindowMinutes *int64
// An array of CopyAction objects, which contains the details of the copy
// operation.
CopyActions []CopyAction
// Specifies whether Backup creates continuous backups. True causes Backup to
// create continuous backups capable of point-in-time restore (PITR). False (or not
// specified) causes Backup to create snapshot backups.
EnableContinuousBackup *bool
// The lifecycle defines when a protected resource is transitioned to cold storage
// and when it expires. Backup will transition and expire backups automatically
// according to the lifecycle that you define. Backups transitioned to cold storage
// must be stored in cold storage for a minimum of 90 days. Therefore, the
// “retention” setting must be 90 days greater than the “transition to cold after
// days” setting. The “transition to cold after days” setting cannot be changed
// after a backup has been transitioned to cold. Resource types that are able to be
// transitioned to cold storage are listed in the "Lifecycle to cold storage"
// section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types. This parameter
// has a maximum value of 100 years (36,500 days).
Lifecycle *Lifecycle
// To help organize your resources, you can assign your own metadata to the
// resources that you create. Each tag is a key-value pair.
RecoveryPointTags map[string]string
// A CRON expression in UTC specifying when Backup initiates a backup job.
ScheduleExpression *string
// This is the timezone in which the schedule expression is set. By default,
// ScheduleExpressions are in UTC. You can modify this to a specified timezone.
ScheduleExpressionTimezone *string
// A value in minutes after a backup is scheduled before a job will be canceled if
// it doesn't start successfully. This value is optional. If this value is
// included, it must be at least 60 minutes to avoid errors. This parameter has a
// maximum value of 100 years (52,560,000 minutes). During the start window, the
// backup job status remains in CREATED status until it has successfully begun or
// until the start window time has run out. If within the start window time Backup
// receives an error that allows the job to be retried, Backup will automatically
// retry to begin the job at least every 10 minutes until the backup successfully
// begins (the job status changes to RUNNING ) or until the job status changes to
// EXPIRED (which is expected to occur when the start window time is over).
StartWindowMinutes *int64
noSmithyDocumentSerde
}
// Used to specify a set of resources to a backup plan. Specifying your desired
// Conditions , ListOfTags , NotResources , and/or Resources is recommended. If
// none of these are specified, Backup will attempt to select all supported and
// opted-in storage resources, which could have unintended cost implications.
type BackupSelection struct {
// The ARN of the IAM role that Backup uses to authenticate when backing up the
// target resource; for example, arn:aws:iam::123456789012:role/S3Access .
//
// This member is required.
IamRoleArn *string
// The display name of a resource selection document. Must contain 1 to 50
// alphanumeric or '-_.' characters.
//
// This member is required.
SelectionName *string
// A list of conditions that you define to assign resources to your backup plans
// using tags. For example, "StringEquals": { "Key":
// "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are
// case sensitive. Conditions differs from ListOfTags as follows:
// - When you specify more than one condition, you only assign the resources
// that match ALL conditions (using AND logic).
// - Conditions supports StringEquals , StringLike , StringNotEquals , and
// StringNotLike . ListOfTags only supports StringEquals .
Conditions *Conditions
// A list of conditions that you define to assign resources to your backup plans
// using tags. For example, "StringEquals": { "Key":
// "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are
// case sensitive. ListOfTags differs from Conditions as follows:
// - When you specify more than one condition, you assign all resources that
// match AT LEAST ONE condition (using OR logic).
// - ListOfTags only supports StringEquals . Conditions supports StringEquals ,
// StringLike , StringNotEquals , and StringNotLike .
ListOfTags []Condition
// A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The
// maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If
// you need to exclude many resources from a backup plan, consider a different
// resource selection strategy, such as assigning only one or a few resource types
// or refining your resource selection using tags.
NotResources []string
// A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum
// number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need
// to assign many resources to a backup plan, consider a different resource
// selection strategy, such as assigning all resources of a resource type or
// refining your resource selection using tags.
Resources []string
noSmithyDocumentSerde
}
// Contains metadata about a BackupSelection object.
type BackupSelectionsListMember struct {
// Uniquely identifies a backup plan.
BackupPlanId *string
// The date and time a backup plan is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// A unique string that identifies the request and allows failed requests to be
// retried without the risk of running the operation twice. This parameter is
// optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.'
// characters.
CreatorRequestId *string
// Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery
// point; for example, arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// Uniquely identifies a request to assign a set of resources to a backup plan.
SelectionId *string
// The display name of a resource selection document.
SelectionName *string
noSmithyDocumentSerde
}
// Contains metadata about a backup vault.
type BackupVaultListMember struct {
// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
BackupVaultArn *string
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
BackupVaultName *string
// The date and time a resource backup is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// A unique string that identifies the request and allows failed requests to be
// retried without the risk of running the operation twice. This parameter is
// optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.'
// characters.
CreatorRequestId *string
// A server-side encryption key you can specify to encrypt your backups from
// services that support full Backup management; for example,
// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If
// you specify a key, you must specify its ARN, not its alias. If you do not
// specify a key, Backup creates a KMS key for you by default. To learn which
// Backup services support full Backup management and how Backup handles encryption
// for backups from services that do not yet support full Backup, see Encryption
// for backups in Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
EncryptionKeyArn *string
// The date and time when Backup Vault Lock configuration becomes immutable,
// meaning it cannot be changed or deleted. If you applied Vault Lock to your vault
// without specifying a lock date, you can change your Vault Lock settings, or
// delete Vault Lock from the vault entirely, at any time. This value is in Unix
// format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
// example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
LockDate *time.Time
// A Boolean value that indicates whether Backup Vault Lock applies to the
// selected backup vault. If true , Vault Lock prevents delete and update
// operations on the recovery points in the selected vault.
Locked *bool
// The Backup Vault Lock setting that specifies the maximum retention period that
// the vault retains its recovery points. If this parameter is not specified, Vault
// Lock does not enforce a maximum retention period on the recovery points in the
// vault (allowing indefinite storage). If specified, any backup or copy job to the
// vault must have a lifecycle policy with a retention period equal to or shorter
// than the maximum retention period. If the job's retention period is longer than
// that maximum retention period, then the vault fails the backup or copy job, and
// you should either modify your lifecycle settings or use a different vault.
// Recovery points already stored in the vault prior to Vault Lock are not
// affected.
MaxRetentionDays *int64
// The Backup Vault Lock setting that specifies the minimum retention period that
// the vault retains its recovery points. If this parameter is not specified, Vault
// Lock does not enforce a minimum retention period. If specified, any backup or
// copy job to the vault must have a lifecycle policy with a retention period equal
// to or longer than the minimum retention period. If the job's retention period is
// shorter than that minimum retention period, then the vault fails the backup or
// copy job, and you should either modify your lifecycle settings or use a
// different vault. Recovery points already stored in the vault prior to Vault Lock
// are not affected.
MinRetentionDays *int64
// The number of recovery points that are stored in a backup vault.
NumberOfRecoveryPoints int64
noSmithyDocumentSerde
}
// Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify
// a lifecycle for a recovery point. The lifecycle defines when a protected
// resource is transitioned to cold storage and when it expires. Backup transitions
// and expires backups automatically according to the lifecycle that you define.
// Backups transitioned to cold storage must be stored in cold storage for a
// minimum of 90 days. Therefore, the “retention” setting must be 90 days greater
// than the “transition to cold after days” setting. The “transition to cold after
// days” setting cannot be changed after a backup has been transitioned to cold.
// Resource types that are able to be transitioned to cold storage are listed in
// the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types.
type CalculatedLifecycle struct {
// A timestamp that specifies when to delete a recovery point.
DeleteAt *time.Time
// A timestamp that specifies when to transition a recovery point to cold storage.
MoveToColdStorageAt *time.Time
noSmithyDocumentSerde
}
// Contains an array of triplets made up of a condition type (such as StringEquals
// ), a key, and a value. Used to filter resources using their tags and assign them
// to a backup plan. Case sensitive.
type Condition struct {
// The key in a key-value pair. For example, in the tag Department: Accounting ,
// Department is the key.
//
// This member is required.
ConditionKey *string
// An operation applied to a key-value pair used to assign resources to your
// backup plan. Condition only supports StringEquals . For more flexible assignment
// options, including StringLike and the ability to exclude resources from your
// backup plan, use Conditions (with an "s" on the end) for your BackupSelection (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html)
// .
//
// This member is required.
ConditionType ConditionType
// The value in a key-value pair. For example, in the tag Department: Accounting ,
// Accounting is the value.
//
// This member is required.
ConditionValue *string
noSmithyDocumentSerde
}
// Includes information about tags you define to assign tagged resources to a
// backup plan.
type ConditionParameter struct {
// The key in a key-value pair. For example, in the tag Department: Accounting ,
// Department is the key.
ConditionKey *string
// The value in a key-value pair. For example, in the tag Department: Accounting ,
// Accounting is the value.
ConditionValue *string
noSmithyDocumentSerde
}
// Contains information about which resources to include or exclude from a backup
// plan using their tags. Conditions are case sensitive.
type Conditions struct {
// Filters the values of your tagged resources for only those resources that you
// tagged with the same value. Also called "exact matching."
StringEquals []ConditionParameter
// Filters the values of your tagged resources for matching tag values with the
// use of a wildcard character (*) anywhere in the string. For example, "prod*" or
// "*rod*" matches the tag value "production".
StringLike []ConditionParameter
// Filters the values of your tagged resources for only those resources that you
// tagged that do not have the same value. Also called "negated matching."
StringNotEquals []ConditionParameter
// Filters the values of your tagged resources for non-matching tag values with
// the use of a wildcard character (*) anywhere in the string.
StringNotLike []ConditionParameter
noSmithyDocumentSerde
}
// A list of parameters for a control. A control can have zero, one, or more than
// one parameter. An example of a control with two parameters is: "backup plan
// frequency is at least daily and the retention period is at least 1 year ". The
// first parameter is daily . The second parameter is 1 year .
type ControlInputParameter struct {
// The name of a parameter, for example, BackupPlanFrequency .
ParameterName *string
// The value of parameter, for example, hourly .
ParameterValue *string
noSmithyDocumentSerde
}
// A framework consists of one or more controls. Each control has its own control
// scope. The control scope can include one or more resource types, a combination
// of a tag key and value, or a combination of one resource type and one resource
// ID. If no scope is specified, evaluations for the rule are triggered when any
// resource in your recording group changes in configuration. To set a control
// scope that includes all of a particular resource, leave the ControlScope empty
// or do not pass it when calling CreateFramework .
type ControlScope struct {
// The ID of the only Amazon Web Services resource that you want your control
// scope to contain.
ComplianceResourceIds []string
// Describes whether the control scope includes one or more types of resources,
// such as EFS or RDS .
ComplianceResourceTypes []string
// The tag key-value pair applied to those Amazon Web Services resources that you
// want to trigger an evaluation for a rule. A maximum of one key-value pair can be
// provided. The tag value is optional, but it cannot be an empty string. The
// structure to assign a tag is: [{"Key":"string","Value":"string"}] .
Tags map[string]string
noSmithyDocumentSerde
}
// The details of the copy operation.
type CopyAction struct {
// An Amazon Resource Name (ARN) that uniquely identifies the destination backup
// vault for the copied backup. For example,
// arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
//
// This member is required.
DestinationBackupVaultArn *string
// Contains an array of Transition objects specifying how long in days before a
// recovery point transitions to cold storage or is deleted. Backups transitioned
// to cold storage must be stored in cold storage for a minimum of 90 days.
// Therefore, on the console, the “retention” setting must be 90 days greater than
// the “transition to cold after days” setting. The “transition to cold after days”
// setting cannot be changed after a backup has been transitioned to cold. Resource
// types that are able to be transitioned to cold storage are listed in the
// "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types.
Lifecycle *Lifecycle
noSmithyDocumentSerde
}
// Contains detailed information about a copy job.
type CopyJob struct {
// The account ID that owns the copy job.
AccountId *string
// The size, in bytes, of a copy job.
BackupSizeInBytes *int64
// This returns the statistics of the included child (nested) copy jobs.
ChildJobsInState map[string]int64
// The date and time a copy job is completed, in Unix format and Coordinated
// Universal Time (UTC). The value of CompletionDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CompletionDate *time.Time
// This is the identifier of a resource within a composite group, such as nested
// (child) recovery point belonging to a composite (parent) stack. The ID is
// transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax)
// within a stack.
CompositeMemberIdentifier *string
// Uniquely identifies a copy job.
CopyJobId *string
// Contains information about the backup plan and rule that Backup used to
// initiate the recovery point backup.
CreatedBy *RecoveryPointCreator
// The date and time a copy job is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// An Amazon Resource Name (ARN) that uniquely identifies a destination copy
// vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
DestinationBackupVaultArn *string
// An ARN that uniquely identifies a destination recovery point; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
DestinationRecoveryPointArn *string
// Specifies the IAM role ARN used to copy the target recovery point; for example,
// arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// This is a boolean value indicating this is a parent (composite) copy job.
IsParent bool
// This parameter is the job count for the specified message category. Example
// strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and
// InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)
// for a list of MessageCategory strings. The the value ANY returns count of all
// message categories. AGGREGATE_ALL aggregates job counts for all message
// categories and returns the sum
MessageCategory *string
// This is the number of child (nested) copy jobs.
NumberOfChildJobs *int64
// This uniquely identifies a request to Backup to copy a resource. The return
// will be the parent (composite) job ID.
ParentJobId *string
// The Amazon Web Services resource to be copied; for example, an Amazon Elastic
// Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
// RDS) database.
ResourceArn *string
// This is the non-unique name of the resource that belongs to the specified
// backup.
ResourceName *string
// The type of Amazon Web Services resource to be copied; for example, an Amazon
// Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service
// (Amazon RDS) database.
ResourceType *string
// An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for
// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
SourceBackupVaultArn *string
// An ARN that uniquely identifies a source recovery point; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
SourceRecoveryPointArn *string
// The current state of a copy job.
State CopyJobState
// A detailed message explaining the status of the job to copy a resource.
StatusMessage *string
noSmithyDocumentSerde
}
// This is a summary of copy jobs created or running within the most recent 30
// days. The returned summary may contain the following: Region, Account, State,
// RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
type CopyJobSummary struct {
// The account ID that owns the jobs within the summary.
AccountId *string
// The value as a number of jobs in a job summary.
Count int32
// The value of time in number format of a job end time. This value is the time in
// Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
// example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
EndTime *time.Time
// This parameter is the job count for the specified message category. Example
// strings include AccessDenied , Success , and InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)
// for a list of MessageCategory strings. The the value ANY returns count of all
// message categories. AGGREGATE_ALL aggregates job counts for all message
// categories and returns the sum.
MessageCategory *string
// This is the Amazon Web Services Regions within the job summary.
Region *string
// This value is the job count for the specified resource type. The request
// GetSupportedResourceTypes returns strings for supported resource types
ResourceType *string
// The value of time in number format of a job start time. This value is the time
// in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
StartTime *time.Time
// This value is job count for jobs with the specified state.
State CopyJobStatus
noSmithyDocumentSerde
}
// This is a resource filter containing FromDate: DateTime and ToDate: DateTime.
// Both values are required. Future DateTime values are not permitted. The date and
// time are in Unix format and Coordinated Universal Time (UTC), and it is accurate
// to milliseconds ((milliseconds are optional). For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
type DateRange struct {
// This value is the beginning date, inclusive. The date and time are in Unix
// format and Coordinated Universal Time (UTC), and it is accurate to milliseconds
// (milliseconds are optional).
//
// This member is required.
FromDate *time.Time
// This value is the end date, inclusive. The date and time are in Unix format and
// Coordinated Universal Time (UTC), and it is accurate to milliseconds
// (milliseconds are optional).
//
// This member is required.
ToDate *time.Time
noSmithyDocumentSerde
}
// Contains detailed information about a framework. Frameworks contain controls,
// which evaluate and report on your backup events and resources. Frameworks
// generate daily compliance results.
type Framework struct {
// The date and time that a framework is created, in ISO 8601 representation. The
// value of CreationTime is accurate to milliseconds. For example,
// 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8
// hours behind UTC.
CreationTime *time.Time
// The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS |
// UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
DeploymentStatus *string
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
FrameworkArn *string
// An optional description of the framework with a maximum 1,024 characters.
FrameworkDescription *string
// The unique name of a framework. This name is between 1 and 256 characters,
// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and
// underscores (_).
FrameworkName *string
// The number of controls contained by the framework.
NumberOfControls int32
noSmithyDocumentSerde
}
// Contains detailed information about all of the controls of a framework. Each
// framework must contain at least one control.
type FrameworkControl struct {
// The name of a control. This name is between 1 and 256 characters.
//
// This member is required.
ControlName *string
// A list of ParameterName and ParameterValue pairs.
ControlInputParameters []ControlInputParameter
// The scope of a control. The control scope defines what the control will
// evaluate. Three examples of control scopes are: a specific backup plan, all
// backup plans with a specific tag, or all backup plans.
ControlScope *ControlScope
noSmithyDocumentSerde
}
// Pair of two related strings. Allowed characters are letters, white space, and
// numbers that can be represented in UTF-8 and the following characters: + - = .
// _ : /
type KeyValue struct {
// The tag key (String). The key can't start with aws: . Length Constraints:
// Minimum length of 1. Maximum length of 128. Pattern:
// ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
//
// This member is required.
Key *string
// The value of the key. Length Constraints: Maximum length of 256. Pattern:
// ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// A legal hold is an administrative tool that helps prevent backups from being
// deleted while under a hold. While the hold is in place, backups under a hold
// cannot be deleted and lifecycle policies that would alter the backup status
// (such as transition to cold storage) are delayed until the legal hold is
// removed. A backup can have more than one legal hold. Legal holds are applied to
// one or more backups (also known as recovery points). These backups can be
// filtered by resource types and by resource IDs.
type LegalHold struct {
// This is the time in number format when legal hold was cancelled.
CancellationDate *time.Time
// This is the time in number format when legal hold was created.
CreationDate *time.Time
// This is the description of a legal hold.
Description *string
// This is an Amazon Resource Number (ARN) that uniquely identifies the legal
// hold; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
LegalHoldArn *string
// ID of specific legal hold on one or more recovery points.
LegalHoldId *string
// This is the status of the legal hold. Statuses can be ACTIVE , CREATING ,
// CANCELED , and CANCELING .
Status LegalHoldStatus
// This is the title of a legal hold.
Title *string
noSmithyDocumentSerde
}
// Contains an array of Transition objects specifying how long in days before a
// recovery point transitions to cold storage or is deleted. Backups transitioned
// to cold storage must be stored in cold storage for a minimum of 90 days.
// Therefore, on the console, the “retention” setting must be 90 days greater than
// the “transition to cold after days” setting. The “transition to cold after days”
// setting cannot be changed after a backup has been transitioned to cold. Resource
// types that are able to be transitioned to cold storage are listed in the
// "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types.
type Lifecycle struct {
// Specifies the number of days after creation that a recovery point is deleted.
// Must be greater than 90 days plus MoveToColdStorageAfterDays .
DeleteAfterDays *int64
// Specifies the number of days after creation that a recovery point is moved to
// cold storage.
MoveToColdStorageAfterDays *int64
// Optional Boolean. If this is true, this setting will instruct your backup plan
// to transition supported resources to archive (cold) storage tier in accordance
// with your lifecycle settings.
OptInToArchiveForSupportedResources *bool
noSmithyDocumentSerde
}
// A structure that contains information about a backed-up resource.
type ProtectedResource struct {
// The date and time a resource was last backed up, in Unix format and Coordinated
// Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
LastBackupTime *time.Time
// This is the ARN (Amazon Resource Name) of the backup vault that contains the
// most recent backup recovery point.
LastBackupVaultArn *string
// This is the ARN (Amazon Resource Name) of the most recent recovery point.
LastRecoveryPointArn *string
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
ResourceArn *string
// This is the non-unique name of the resource that belongs to the specified
// backup.
ResourceName *string
// The type of Amazon Web Services resource; for example, an Amazon Elastic Block
// Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)
// database. For Windows Volume Shadow Copy Service (VSS) backups, the only
// supported resource type is Amazon EC2.
ResourceType *string
noSmithyDocumentSerde
}
// A list of conditions that you define for resources in your restore testing plan
// using tags. For example, "StringEquals": { "Key":
// "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are
// case sensitive.
type ProtectedResourceConditions struct {
// Filters the values of your tagged resources for only those resources that you
// tagged with the same value. Also called "exact matching."
StringEquals []KeyValue
// Filters the values of your tagged resources for only those resources that you
// tagged that do not have the same value. Also called "negated matching."
StringNotEquals []KeyValue
noSmithyDocumentSerde
}
// Contains detailed information about the recovery points stored in a backup
// vault.
type RecoveryPointByBackupVault struct {
// The size, in bytes, of a backup.
BackupSizeInBytes *int64
// An ARN that uniquely identifies a backup vault; for example,
// arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
BackupVaultArn *string
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
BackupVaultName *string
// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
// timestamps.
CalculatedLifecycle *CalculatedLifecycle
// The date and time a job to restore a recovery point is completed, in Unix
// format and Coordinated Universal Time (UTC). The value of CompletionDate is
// accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26, 2018 12:11:30.087 AM.
CompletionDate *time.Time
// This is the identifier of a resource within a composite group, such as nested
// (child) recovery point belonging to a composite (parent) stack. The ID is
// transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax)
// within a stack.
CompositeMemberIdentifier *string
// Contains identifying information about the creation of a recovery point,
// including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and
// BackupRuleId of the backup plan that is used to create it.
CreatedBy *RecoveryPointCreator
// The date and time a recovery point is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// The server-side encryption key that is used to protect your backups; for
// example,
// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
EncryptionKeyArn *string
// Specifies the IAM role ARN used to create the target recovery point; for
// example, arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// A Boolean value that is returned as TRUE if the specified recovery point is
// encrypted, or FALSE if the recovery point is not encrypted.
IsEncrypted bool
// This is a boolean value indicating this is a parent (composite) recovery point.
IsParent bool
// The date and time a recovery point was last restored, in Unix format and
// Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
LastRestoreTime *time.Time
// The lifecycle defines when a protected resource is transitioned to cold storage
// and when it expires. Backup transitions and expires backups automatically
// according to the lifecycle that you define. Backups transitioned to cold storage
// must be stored in cold storage for a minimum of 90 days. Therefore, the
// “retention” setting must be 90 days greater than the “transition to cold after
// days” setting. The “transition to cold after days” setting cannot be changed
// after a backup has been transitioned to cold. Resource types that are able to be
// transitioned to cold storage are listed in the "Lifecycle to cold storage"
// section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
// table. Backup ignores this expression for other resource types.
Lifecycle *Lifecycle
// This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
ParentRecoveryPointArn *string
// An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for
// example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
RecoveryPointArn *string
// An ARN that uniquely identifies a resource. The format of the ARN depends on
// the resource type.
ResourceArn *string
// This is the non-unique name of the resource that belongs to the specified
// backup.
ResourceName *string
// The type of Amazon Web Services resource saved as a recovery point; for
// example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
// Relational Database Service (Amazon RDS) database. For Windows Volume Shadow
// Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
ResourceType *string
// The backup vault where the recovery point was originally copied from. If the
// recovery point is restored to the same account this value will be null .
SourceBackupVaultArn *string
// A status code specifying the state of the recovery point.
Status RecoveryPointStatus
// A message explaining the reason of the recovery point deletion failure.
StatusMessage *string
// This is the type of vault in which the described recovery point is stored.
VaultType VaultType
noSmithyDocumentSerde
}
// Contains detailed information about a saved recovery point.
type RecoveryPointByResource struct {
// The size, in bytes, of a backup.
BackupSizeBytes *int64
// The name of a logical container where backups are stored. Backup vaults are
// identified by names that are unique to the account used to create them and the
// Amazon Web Services Region where they are created. They consist of lowercase
// letters, numbers, and hyphens.
BackupVaultName *string
// The date and time a recovery point is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// The server-side encryption key that is used to protect your backups; for
// example,
// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
EncryptionKeyArn *string
// This is a boolean value indicating this is a parent (composite) recovery point.
IsParent bool
// This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
ParentRecoveryPointArn *string
// An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for
// example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
RecoveryPointArn *string
// This is the non-unique name of the resource that belongs to the specified
// backup.
ResourceName *string
// A status code specifying the state of the recovery point.
Status RecoveryPointStatus
// A message explaining the reason of the recovery point deletion failure.
StatusMessage *string
noSmithyDocumentSerde
}
// Contains information about the backup plan and rule that Backup used to
// initiate the recovery point backup.
type RecoveryPointCreator struct {
// An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for
// example,
// arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .
BackupPlanArn *string
// Uniquely identifies a backup plan.
BackupPlanId *string
// Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that
// are at most 1,024 bytes long. They cannot be edited.
BackupPlanVersion *string
// Uniquely identifies a rule used to schedule the backup of a selection of
// resources.
BackupRuleId *string
noSmithyDocumentSerde
}
// This is a recovery point which is a child (nested) recovery point of a parent
// (composite) recovery point. These recovery points can be disassociated from
// their parent (composite) recovery point, in which case they will no longer be a
// member.
type RecoveryPointMember struct {
// This is the name of the backup vault (the logical container in which backups
// are stored).
BackupVaultName *string
// This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
RecoveryPointArn *string
// This is the Amazon Resource Name (ARN) that uniquely identifies a saved
// resource.
ResourceArn *string
// This is the Amazon Web Services resource type that is saved as a recovery point.
ResourceType *string
noSmithyDocumentSerde
}
// This specifies criteria to assign a set of resources, such as resource types or
// backup vaults.
type RecoveryPointSelection struct {
// This is a resource filter containing FromDate: DateTime and ToDate: DateTime.
// Both values are required. Future DateTime values are not permitted. The date and
// time are in Unix format and Coordinated Universal Time (UTC), and it is accurate
// to milliseconds ((milliseconds are optional). For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
DateRange *DateRange
// These are the resources included in the resource selection (including type of
// resources and vaults).
ResourceIdentifiers []string
// These are the names of the vaults in which the selected recovery points are
// contained.
VaultNames []string
noSmithyDocumentSerde
}
// Contains information from your report plan about where to deliver your reports,
// specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your
// reports.
type ReportDeliveryChannel struct {
// The unique name of the S3 bucket that receives your reports.
//
// This member is required.
S3BucketName *string
// A list of the format of your reports: CSV , JSON , or both. If not specified,
// the default format is CSV .
Formats []string
// The prefix for where Backup Audit Manager delivers your reports to Amazon S3.
// The prefix is this part of the following path: s3://your-bucket-name/ prefix
// /Backup/us-west-2/year/month/day/report-name. If not specified, there is no
// prefix.
S3KeyPrefix *string
noSmithyDocumentSerde
}
// Contains information from your report job about your report destination.
type ReportDestination struct {
// The unique name of the Amazon S3 bucket that receives your reports.
S3BucketName *string
// The object key that uniquely identifies your reports in your S3 bucket.
S3Keys []string
noSmithyDocumentSerde
}
// Contains detailed information about a report job. A report job compiles a
// report based on a report plan and publishes it to Amazon S3.
type ReportJob struct {
// The date and time that a report job is completed, in Unix format and
// Coordinated Universal Time (UTC). The value of CompletionTime is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
CompletionTime *time.Time
// The date and time that a report job is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationTime *time.Time
// The S3 bucket name and S3 keys for the destination where the report job
// publishes the report.
ReportDestination *ReportDestination
// The identifier for a report job. A unique, randomly generated, Unicode, UTF-8
// encoded string that is at most 1,024 bytes long. Report job IDs cannot be
// edited.
ReportJobId *string
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
ReportPlanArn *string
// Identifies the report template for the report. Reports are built using a report
// template. The report templates are: RESOURCE_COMPLIANCE_REPORT |
// CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT |
// RESTORE_JOB_REPORT
ReportTemplate *string
// The status of a report job. The statuses are: CREATED | RUNNING | COMPLETED |
// FAILED COMPLETED means that the report is available for your review at your
// designated destination. If the status is FAILED , review the StatusMessage for
// the reason.
Status *string
// A message explaining the status of the report job.
StatusMessage *string
noSmithyDocumentSerde
}
// Contains detailed information about a report plan.
type ReportPlan struct {
// The date and time that a report plan is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationTime *time.Time
// The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS |
// UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
DeploymentStatus *string
// The date and time that a report job associated with this report plan last
// attempted to run, in Unix format and Coordinated Universal Time (UTC). The value
// of LastAttemptedExecutionTime is accurate to milliseconds. For example, the
// value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastAttemptedExecutionTime *time.Time
// The date and time that a report job associated with this report plan last
// successfully ran, in Unix format and Coordinated Universal Time (UTC). The value
// of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the
// value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastSuccessfulExecutionTime *time.Time
// Contains information about where and how to deliver your reports, specifically
// your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportDeliveryChannel *ReportDeliveryChannel
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
ReportPlanArn *string
// An optional description of the report plan with a maximum 1,024 characters.
ReportPlanDescription *string
// The unique name of the report plan. This name is between 1 and 256 characters
// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and
// underscores (_).
ReportPlanName *string
// Identifies the report template for the report. Reports are built using a report
// template. The report templates are: RESOURCE_COMPLIANCE_REPORT |
// CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT |
// RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or
// CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage
// by Amazon Web Services Regions and frameworks.
ReportSetting *ReportSetting
noSmithyDocumentSerde
}
// Contains detailed information about a report setting.
type ReportSetting struct {
// Identifies the report template for the report. Reports are built using a report
// template. The report templates are: RESOURCE_COMPLIANCE_REPORT |
// CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT |
// RESTORE_JOB_REPORT
//
// This member is required.
ReportTemplate *string
// These are the accounts to be included in the report.
Accounts []string
// The Amazon Resource Names (ARNs) of the frameworks a report covers.
FrameworkArns []string
// The number of frameworks a report covers.
NumberOfFrameworks int32
// These are the Organizational Units to be included in the report.
OrganizationUnits []string
// These are the Regions to be included in the report.
Regions []string
noSmithyDocumentSerde
}
// Contains information about the restore testing plan that Backup used to
// initiate the restore job.
type RestoreJobCreator struct {
// An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
RestoreTestingPlanArn *string
noSmithyDocumentSerde
}
// Contains metadata about a restore job.
type RestoreJobsListMember struct {
// The account ID that owns the restore job.
AccountId *string
// The size, in bytes, of the restored resource.
BackupSizeInBytes *int64
// The date and time a job to restore a recovery point is completed, in Unix
// format and Coordinated Universal Time (UTC). The value of CompletionDate is
// accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26, 2018 12:11:30.087 AM.
CompletionDate *time.Time
// Contains identifying information about the creation of a restore job.
CreatedBy *RestoreJobCreator
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
CreatedResourceArn *string
// The date and time a restore job is created, in Unix format and Coordinated
// Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
CreationDate *time.Time
// This notes the status of the data generated by the restore test. The status may
// be Deleting , Failed , or Successful .
DeletionStatus RestoreDeletionStatus
// This describes the restore job deletion status.
DeletionStatusMessage *string
// The amount of time in minutes that a job restoring a recovery point is expected
// to take.
ExpectedCompletionTimeMinutes *int64
// Specifies the IAM role ARN used to create the target recovery point; for
// example, arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// Contains an estimated percentage complete of a job at the time the job status
// was queried.
PercentDone *string
// An ARN that uniquely identifies a recovery point; for example,
// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
// .
RecoveryPointArn *string
// The date on which a recovery point was created.
RecoveryPointCreationDate *time.Time
// The resource type of the listed restore jobs; for example, an Amazon Elastic
// Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
// RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only
// supported resource type is Amazon EC2.
ResourceType *string
// Uniquely identifies the job that restores a recovery point.
RestoreJobId *string
// A status code specifying the state of the job initiated by Backup to restore a
// recovery point.
Status RestoreJobStatus
// A detailed message explaining the status of the job to restore a recovery point.
StatusMessage *string
// This is the status of validation run on the indicated restore job.
ValidationStatus RestoreValidationStatus
// This describes the status of validation run on the indicated restore job.
ValidationStatusMessage *string
noSmithyDocumentSerde
}
// This is a summary of restore jobs created or running within the most recent 30
// days. The returned summary may contain the following: Region, Account, State,
// ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
type RestoreJobSummary struct {
// The account ID that owns the jobs within the summary.
AccountId *string
// The value as a number of jobs in a job summary.
Count int32
// The value of time in number format of a job end time. This value is the time in
// Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
// example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
EndTime *time.Time
// The Amazon Web Services Regions within the job summary.
Region *string
// This value is the job count for the specified resource type. The request
// GetSupportedResourceTypes returns strings for supported resource types.
ResourceType *string
// The value of time in number format of a job start time. This value is the time
// in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds.
// For example, the value 1516925490.087 represents Friday, January 26, 2018
// 12:11:30.087 AM.
StartTime *time.Time
// This value is job count for jobs with the specified state.
State RestoreJobState
noSmithyDocumentSerde
}
// This contains metadata about a restore testing plan.
type RestoreTestingPlanForCreate struct {
// Required: Algorithm; Required: Recovery point types; IncludeVaults (one or
// more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults
// (list of selectors), defaults to empty list if not listed.
//
// This member is required.
RecoveryPointSelection *RestoreTestingRecoveryPointSelection
// The RestoreTestingPlanName is a unique string that is the name of the restore
// testing plan. This cannot be changed after creation, and it must consist of only
// alphanumeric characters and underscores.
//
// This member is required.
RestoreTestingPlanName *string
// A CRON expression in specified timezone when a restore testing plan is executed.
//
// This member is required.
ScheduleExpression *string
// Optional. This is the timezone in which the schedule expression is set. By
// default, ScheduleExpressions are in UTC. You can modify this to a specified
// timezone.
ScheduleExpressionTimezone *string
// Defaults to 24 hours. A value in hours after a restore test is scheduled before
// a job will be canceled if it doesn't start successfully. This value is optional.
// If this value is included, this parameter has a maximum value of 168 hours (one
// week).
StartWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing plan.
type RestoreTestingPlanForGet struct {
// The date and time that a restore testing plan was created, in Unix format and
// Coordinated Universal Time (UTC). The value of CreationTime is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
//
// This member is required.
CreationTime *time.Time
// The specified criteria to assign a set of resources, such as recovery point
// types or backup vaults.
//
// This member is required.
RecoveryPointSelection *RestoreTestingRecoveryPointSelection
// An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
//
// This member is required.
RestoreTestingPlanArn *string
// This is the restore testing plan name.
//
// This member is required.
RestoreTestingPlanName *string
// A CRON expression in specified timezone when a restore testing plan is executed.
//
// This member is required.
ScheduleExpression *string
// This identifies the request and allows failed requests to be retried without
// the risk of running the operation twice. If the request includes a
// CreatorRequestId that matches an existing backup plan, that plan is returned.
// This parameter is optional. If used, this parameter must contain 1 to 50
// alphanumeric or '-_.' characters.
CreatorRequestId *string
// The last time a restore test was run with the specified restore testing plan. A
// date and time, in Unix format and Coordinated Universal Time (UTC). The value of
// LastExecutionDate is accurate to milliseconds. For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastExecutionTime *time.Time
// The date and time that the restore testing plan was updated. This update is in
// Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime
// is accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26, 2018 12:11:30.087 AM.
LastUpdateTime *time.Time
// Optional. This is the timezone in which the schedule expression is set. By
// default, ScheduleExpressions are in UTC. You can modify this to a specified
// timezone.
ScheduleExpressionTimezone *string
// Defaults to 24 hours. A value in hours after a restore test is scheduled before
// a job will be canceled if it doesn't start successfully. This value is optional.
// If this value is included, this parameter has a maximum value of 168 hours (one
// week).
StartWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing plan.
type RestoreTestingPlanForList struct {
// The date and time that a restore testing plan was created, in Unix format and
// Coordinated Universal Time (UTC). The value of CreationTime is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 2018 12:11:30.087 AM.
//
// This member is required.
CreationTime *time.Time
// An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.
//
// This member is required.
RestoreTestingPlanArn *string
// This is the restore testing plan name.
//
// This member is required.
RestoreTestingPlanName *string
// A CRON expression in specified timezone when a restore testing plan is executed.
//
// This member is required.
ScheduleExpression *string
// The last time a restore test was run with the specified restore testing plan. A
// date and time, in Unix format and Coordinated Universal Time (UTC). The value of
// LastExecutionDate is accurate to milliseconds. For example, the value
// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastExecutionTime *time.Time
// The date and time that the restore testing plan was updated. This update is in
// Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime
// is accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26, 2018 12:11:30.087 AM.
LastUpdateTime *time.Time
// Optional. This is the timezone in which the schedule expression is set. By
// default, ScheduleExpressions are in UTC. You can modify this to a specified
// timezone.
ScheduleExpressionTimezone *string
// Defaults to 24 hours. A value in hours after a restore test is scheduled before
// a job will be canceled if it doesn't start successfully. This value is optional.
// If this value is included, this parameter has a maximum value of 168 hours (one
// week).
StartWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing plan.
type RestoreTestingPlanForUpdate struct {
// Required: Algorithm ; RecoveryPointTypes ; IncludeVaults (one or more).
// Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults
// to empty list if not listed).
RecoveryPointSelection *RestoreTestingRecoveryPointSelection
// A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpression *string
// Optional. This is the timezone in which the schedule expression is set. By
// default, ScheduleExpressions are in UTC. You can modify this to a specified
// timezone.
ScheduleExpressionTimezone *string
// Defaults to 24 hours. A value in hours after a restore test is scheduled before
// a job will be canceled if it doesn't start successfully. This value is optional.
// If this value is included, this parameter has a maximum value of 168 hours (one
// week).
StartWindowHours int32
noSmithyDocumentSerde
}
// Required: Algorithm; Required: Recovery point types; IncludeVaults(one or
// more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list
// of selectors), defaults to empty list if not listed.
type RestoreTestingRecoveryPointSelection struct {
// Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
Algorithm RestoreTestingRecoveryPointSelectionAlgorithm
// Accepted values include specific ARNs or list of selectors. Defaults to empty
// list if not listed.
ExcludeVaults []string
// Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard
// replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...]
// ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]
IncludeVaults []string
// These are the types of recovery points.
RecoveryPointTypes []RestoreTestingRecoveryPointType
// Accepted values are integers from 1 to 365.
SelectionWindowDays int32
noSmithyDocumentSerde
}
// This contains metadata about a specific restore testing selection.
// ProtectedResourceType is required, such as Amazon EBS or Amazon EC2. This
// consists of RestoreTestingSelectionName , ProtectedResourceType , and one of the
// following:
// - ProtectedResourceArns
// - ProtectedResourceConditions
//
// Each protected resource type can have one single value. A restore testing
// selection can include a wildcard value ("*") for ProtectedResourceArns along
// with ProtectedResourceConditions . Alternatively, you can include up to 30
// specific protected resource ARNs in ProtectedResourceArns .
// ProtectedResourceConditions examples include as StringEquals and StringNotEquals
// .
type RestoreTestingSelectionForCreate struct {
// The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the
// target resource; for example: arn:aws:iam::123456789012:role/S3Access .
//
// This member is required.
IamRoleArn *string
// The type of Amazon Web Services resource included in a restore testing
// selection; for example, an Amazon EBS volume or an Amazon RDS database.
// Supported resource types accepted include:
// - Aurora for Amazon Aurora
// - DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
// - DynamoDB for Amazon DynamoDB
// - EBS for Amazon Elastic Block Store
// - EC2 for Amazon Elastic Compute Cloud
// - EFS for Amazon Elastic File System
// - FSx for Amazon FSx
// - Neptune for Amazon Neptune
// - RDS for Amazon Relational Database Service
// - S3 for Amazon S3
//
// This member is required.
ProtectedResourceType *string
// This is the unique name of the restore testing selection that belongs to the
// related restore testing plan.
//
// This member is required.
RestoreTestingSelectionName *string
// Each protected resource can be filtered by its specific ARNs, such as
// ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or by a wildcard:
// ProtectedResourceArns: ["*"] , but not both.
ProtectedResourceArns []string
// If you have included the wildcard in ProtectedResourceArns, you can include
// resource conditions, such as ProtectedResourceConditions: { StringEquals: [{
// key: "XXXX", value: "YYYY" }] .
ProtectedResourceConditions *ProtectedResourceConditions
// You can override certain restore metadata keys by including the parameter
// RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are
// not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)
// .
RestoreMetadataOverrides map[string]string
// This is amount of hours (1 to 168) available to run a validation script on the
// data. The data will be deleted upon the completion of the validation script or
// the end of the specified retention period, whichever comes first.
ValidationWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing selection.
type RestoreTestingSelectionForGet struct {
// The date and time that a restore testing selection was created, in Unix format
// and Coordinated Universal Time (UTC). The value of CreationTime is accurate to
// milliseconds. For example, the value 1516925490.087 represents Friday, January
// 26, 201812:11:30.087 AM.
//
// This member is required.
CreationTime *time.Time
// The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the
// target resource; for example: arn:aws:iam::123456789012:role/S3Access .
//
// This member is required.
IamRoleArn *string
// The type of Amazon Web Services resource included in a resource testing
// selection; for example, an Amazon EBS volume or an Amazon RDS database.
//
// This member is required.
ProtectedResourceType *string
// The RestoreTestingPlanName is a unique string that is the name of the restore
// testing plan.
//
// This member is required.
RestoreTestingPlanName *string
// This is the unique name of the restore testing selection that belongs to the
// related restore testing plan.
//
// This member is required.
RestoreTestingSelectionName *string
// This identifies the request and allows failed requests to be retried without
// the risk of running the operation twice. If the request includes a
// CreatorRequestId that matches an existing backup plan, that plan is returned.
// This parameter is optional. If used, this parameter must contain 1 to 50
// alphanumeric or '-_.' characters.
CreatorRequestId *string
// You can include specific ARNs, such as ProtectedResourceArns: ["arn:aws:...",
// "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"] , but
// not both.
ProtectedResourceArns []string
// In a resource testing selection, this parameter filters by specific conditions
// such as StringEquals or StringNotEquals .
ProtectedResourceConditions *ProtectedResourceConditions
// You can override certain restore metadata keys by including the parameter
// RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are
// not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)
// .
RestoreMetadataOverrides map[string]string
// This is amount of hours (1 to 168) available to run a validation script on the
// data. The data will be deleted upon the completion of the validation script or
// the end of the specified retention period, whichever comes first.
ValidationWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing selection.
type RestoreTestingSelectionForList struct {
// This is the date and time that a restore testing selection was created, in Unix
// format and Coordinated Universal Time (UTC). The value of CreationTime is
// accurate to milliseconds. For example, the value 1516925490.087 represents
// Friday, January 26,2018 12:11:30.087 AM.
//
// This member is required.
CreationTime *time.Time
// The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the
// target resource; for example: arn:aws:iam::123456789012:role/S3Access .
//
// This member is required.
IamRoleArn *string
// The type of Amazon Web Services resource included in a restore testing
// selection; for example, an Amazon EBS volume or an Amazon RDS database.
//
// This member is required.
ProtectedResourceType *string
// Unique string that is the name of the restore testing plan. The name cannot be
// changed after creation. The name must consist of only alphanumeric characters
// and underscores. Maximum length is 50.
//
// This member is required.
RestoreTestingPlanName *string
// Unique name of a restore testing selection.
//
// This member is required.
RestoreTestingSelectionName *string
// This value represents the time, in hours, data is retained after a restore test
// so that optional validation can be completed. Accepted value is an integer
// between 0 and 168 (the hourly equivalent of seven days).
ValidationWindowHours int32
noSmithyDocumentSerde
}
// This contains metadata about a restore testing selection.
type RestoreTestingSelectionForUpdate struct {
// The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the
// target resource; for example: arn:aws:iam::123456789012:role/S3Access .
IamRoleArn *string
// You can include a list of specific ARNs, such as ProtectedResourceArns:
// ["arn:aws:...", "arn:aws:..."] or you can include a wildcard:
// ProtectedResourceArns: ["*"] , but not both.
ProtectedResourceArns []string
// A list of conditions that you define for resources in your restore testing plan
// using tags. For example, "StringEquals": { "Key":
// "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are
// case sensitive.
ProtectedResourceConditions *ProtectedResourceConditions
// You can override certain restore metadata keys by including the parameter
// RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are
// not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)
// .
RestoreMetadataOverrides map[string]string
// This value represents the time, in hours, data is retained after a restore test
// so that optional validation can be completed. Accepted value is an integer
// between 0 and 168 (the hourly equivalent of seven days).
ValidationWindowHours int32
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|