@aws-sdk/client-fms 3.316.0 → 3.318.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -1
- package/dist-cjs/FMS.js +8 -0
- package/dist-cjs/commands/GetAdminScopeCommand.js +45 -0
- package/dist-cjs/commands/ListAdminAccountsForOrganizationCommand.js +45 -0
- package/dist-cjs/commands/ListAdminsManagingAccountCommand.js +45 -0
- package/dist-cjs/commands/PutAdminAccountCommand.js +45 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +27 -13
- package/dist-cjs/pagination/ListAdminAccountsForOrganizationPaginator.js +29 -0
- package/dist-cjs/pagination/ListAdminsManagingAccountPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +192 -2
- package/dist-es/FMS.js +8 -0
- package/dist-es/commands/GetAdminScopeCommand.js +41 -0
- package/dist-es/commands/ListAdminAccountsForOrganizationCommand.js +41 -0
- package/dist-es/commands/ListAdminsManagingAccountCommand.js +41 -0
- package/dist-es/commands/PutAdminAccountCommand.js +41 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +26 -12
- package/dist-es/pagination/ListAdminAccountsForOrganizationPaginator.js +25 -0
- package/dist-es/pagination/ListAdminsManagingAccountPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +182 -0
- package/dist-types/FMS.d.ts +29 -1
- package/dist-types/FMSClient.d.ts +7 -3
- package/dist-types/commands/AssociateAdminAccountCommand.d.ts +2 -4
- package/dist-types/commands/DisassociateAdminAccountCommand.d.ts +2 -3
- package/dist-types/commands/GetAdminAccountCommand.d.ts +1 -1
- package/dist-types/commands/GetAdminScopeCommand.d.ts +80 -0
- package/dist-types/commands/GetComplianceDetailCommand.d.ts +4 -4
- package/dist-types/commands/ListAdminAccountsForOrganizationCommand.d.ts +79 -0
- package/dist-types/commands/ListAdminsManagingAccountCommand.d.ts +74 -0
- package/dist-types/commands/ListMemberAccountsCommand.d.ts +1 -2
- package/dist-types/commands/PutAdminAccountCommand.d.ts +112 -0
- package/dist-types/commands/PutNotificationChannelCommand.d.ts +2 -3
- package/dist-types/commands/PutPolicyCommand.d.ts +1 -0
- package/dist-types/commands/PutResourceSetCommand.d.ts +1 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +436 -59
- package/dist-types/pagination/ListAdminAccountsForOrganizationPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAdminsManagingAccountPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/FMS.d.ts +68 -0
- package/dist-types/ts3.4/FMSClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/GetAdminScopeCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/ListAdminAccountsForOrganizationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListAdminsManagingAccountCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/PutAdminAccountCommand.d.ts +32 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +94 -14
- package/dist-types/ts3.4/pagination/ListAdminAccountsForOrganizationPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAdminsManagingAccountPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +1 -1
|
@@ -15,6 +15,24 @@ export declare const AccountRoleStatus: {
|
|
|
15
15
|
* @public
|
|
16
16
|
*/
|
|
17
17
|
export type AccountRoleStatus = (typeof AccountRoleStatus)[keyof typeof AccountRoleStatus];
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <p>Configures the accounts within the administrator's Organizations organization that the specified Firewall Manager administrator can apply policies to.</p>
|
|
21
|
+
*/
|
|
22
|
+
export interface AccountScope {
|
|
23
|
+
/**
|
|
24
|
+
* <p>The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of <code>ExcludeSpecifiedAccounts</code>. If <code>ExcludeSpecifiedAccounts</code> is set to <code>true</code>, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If <code>ExcludeSpecifiedAccounts</code> is set to <code>false</code>, then the Firewall Manager administrator can only apply policies to the accounts in this list.</p>
|
|
25
|
+
*/
|
|
26
|
+
Accounts?: string[];
|
|
27
|
+
/**
|
|
28
|
+
* <p>A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in <code>AccountScope$Accounts</code>. You cannot specify both.</p>
|
|
29
|
+
*/
|
|
30
|
+
AllAccountsEnabled?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* <p>A boolean value that excludes the accounts in <code>AccountScope$Accounts</code> from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in <code>AccountScope$Accounts</code>. You can either specify a list of accounts to exclude by <code>AccountScope$Accounts</code>, or you can enable management of all accounts by <code>AccountScope$AllAccountsEnabled</code>. You cannot specify both.</p>
|
|
33
|
+
*/
|
|
34
|
+
ExcludeSpecifiedAccounts?: boolean;
|
|
35
|
+
}
|
|
18
36
|
/**
|
|
19
37
|
* @public
|
|
20
38
|
* <p>Describes a remediation action target.</p>
|
|
@@ -29,6 +47,146 @@ export interface ActionTarget {
|
|
|
29
47
|
*/
|
|
30
48
|
Description?: string;
|
|
31
49
|
}
|
|
50
|
+
/**
|
|
51
|
+
* @public
|
|
52
|
+
* @enum
|
|
53
|
+
*/
|
|
54
|
+
export declare const OrganizationStatus: {
|
|
55
|
+
readonly Offboarding: "OFFBOARDING";
|
|
56
|
+
readonly OffboardingComplete: "OFFBOARDING_COMPLETE";
|
|
57
|
+
readonly Onboarding: "ONBOARDING";
|
|
58
|
+
readonly OnboardingComplete: "ONBOARDING_COMPLETE";
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export type OrganizationStatus = (typeof OrganizationStatus)[keyof typeof OrganizationStatus];
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
* <p>Contains high level information about the Firewall Manager administrator account.</p>
|
|
67
|
+
*/
|
|
68
|
+
export interface AdminAccountSummary {
|
|
69
|
+
/**
|
|
70
|
+
* <p>The Amazon Web Services account ID of the Firewall Manager administrator's account.</p>
|
|
71
|
+
*/
|
|
72
|
+
AdminAccount?: string;
|
|
73
|
+
/**
|
|
74
|
+
* <p>A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html">Managing Firewall Manager administrators</a> in the <i>Firewall Manager Developer Guide</i>.</p>
|
|
75
|
+
*/
|
|
76
|
+
DefaultAdmin?: boolean;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The current status of the request to onboard a member account as an Firewall Manager administator.</p>
|
|
79
|
+
* <ul>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>
|
|
82
|
+
* <code>ONBOARDING</code> - The account is onboarding to Firewall Manager as an administrator.</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>
|
|
86
|
+
* <code>ONBOARDING_COMPLETE</code> - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their <a>AdminScope</a>.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>
|
|
90
|
+
* <code>OFFBOARDING</code> - The account is being removed as an Firewall Manager administrator.</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>
|
|
94
|
+
* <code>OFFBOARDING_COMPLETE</code> - The account has been removed as an Firewall Manager administrator.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* </ul>
|
|
97
|
+
*/
|
|
98
|
+
Status?: OrganizationStatus | string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
* <p>Defines the Organizations organizational units (OUs) that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html">Managing organizational units (OUs)
|
|
103
|
+
* </a> in the <i>Organizations User Guide</i>.</p>
|
|
104
|
+
*/
|
|
105
|
+
export interface OrganizationalUnitScope {
|
|
106
|
+
/**
|
|
107
|
+
* <p>The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of <code>OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits</code>. If <code>OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits</code> is set to <code>true</code>, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If <code>OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits</code> is set to <code>false</code>, then the Firewall Manager administrator can only apply policies to the OUs in this list.</p>
|
|
108
|
+
*/
|
|
109
|
+
OrganizationalUnits?: string[];
|
|
110
|
+
/**
|
|
111
|
+
* <p>A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in <code>OrganizationalUnitScope$OrganizationalUnits</code>. You cannot specify both.</p>
|
|
112
|
+
*/
|
|
113
|
+
AllOrganizationalUnitsEnabled?: boolean;
|
|
114
|
+
/**
|
|
115
|
+
* <p>A boolean value that excludes the OUs in <code>OrganizationalUnitScope$OrganizationalUnits</code> from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in <code>OrganizationalUnitScope$OrganizationalUnits</code>. You can either specify a list of OUs to exclude by <code>OrganizationalUnitScope$OrganizationalUnits</code>, or you can enable management of all OUs by <code>OrganizationalUnitScope$AllOrganizationalUnitsEnabled</code>. You cannot specify both.</p>
|
|
116
|
+
*/
|
|
117
|
+
ExcludeSpecifiedOrganizationalUnits?: boolean;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* @enum
|
|
122
|
+
*/
|
|
123
|
+
export declare const SecurityServiceType: {
|
|
124
|
+
readonly DNS_FIREWALL: "DNS_FIREWALL";
|
|
125
|
+
readonly IMPORT_NETWORK_FIREWALL: "IMPORT_NETWORK_FIREWALL";
|
|
126
|
+
readonly NETWORK_FIREWALL: "NETWORK_FIREWALL";
|
|
127
|
+
readonly SECURITY_GROUPS_COMMON: "SECURITY_GROUPS_COMMON";
|
|
128
|
+
readonly SECURITY_GROUPS_CONTENT_AUDIT: "SECURITY_GROUPS_CONTENT_AUDIT";
|
|
129
|
+
readonly SECURITY_GROUPS_USAGE_AUDIT: "SECURITY_GROUPS_USAGE_AUDIT";
|
|
130
|
+
readonly SHIELD_ADVANCED: "SHIELD_ADVANCED";
|
|
131
|
+
readonly THIRD_PARTY_FIREWALL: "THIRD_PARTY_FIREWALL";
|
|
132
|
+
readonly WAF: "WAF";
|
|
133
|
+
readonly WAFV2: "WAFV2";
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export type SecurityServiceType = (typeof SecurityServiceType)[keyof typeof SecurityServiceType];
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
* <p>Defines the policy types that the specified Firewall Manager administrator can manage.</p>
|
|
142
|
+
*/
|
|
143
|
+
export interface PolicyTypeScope {
|
|
144
|
+
/**
|
|
145
|
+
* <p>The list of policy types that the specified Firewall Manager administrator can manage.</p>
|
|
146
|
+
*/
|
|
147
|
+
PolicyTypes?: (SecurityServiceType | string)[];
|
|
148
|
+
/**
|
|
149
|
+
* <p>Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.</p>
|
|
150
|
+
*/
|
|
151
|
+
AllPolicyTypesEnabled?: boolean;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can manage.</p>
|
|
156
|
+
*/
|
|
157
|
+
export interface RegionScope {
|
|
158
|
+
/**
|
|
159
|
+
* <p>The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.</p>
|
|
160
|
+
*/
|
|
161
|
+
Regions?: string[];
|
|
162
|
+
/**
|
|
163
|
+
* <p>Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.</p>
|
|
164
|
+
*/
|
|
165
|
+
AllRegionsEnabled?: boolean;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
* <p>Defines the resources that the Firewall Manager administrator can manage. For more information about administrative scope, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html">Managing Firewall Manager administrators</a> in the <i>Firewall Manager Developer Guide</i>.</p>
|
|
170
|
+
*/
|
|
171
|
+
export interface AdminScope {
|
|
172
|
+
/**
|
|
173
|
+
* <p>Defines the accounts that the specified Firewall Manager administrator can apply policies to.</p>
|
|
174
|
+
*/
|
|
175
|
+
AccountScope?: AccountScope;
|
|
176
|
+
/**
|
|
177
|
+
* <p>Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html">Managing organizational units (OUs)
|
|
178
|
+
* </a> in the <i>Organizations User Guide</i>.</p>
|
|
179
|
+
*/
|
|
180
|
+
OrganizationalUnitScope?: OrganizationalUnitScope;
|
|
181
|
+
/**
|
|
182
|
+
* <p>Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.</p>
|
|
183
|
+
*/
|
|
184
|
+
RegionScope?: RegionScope;
|
|
185
|
+
/**
|
|
186
|
+
* <p>Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.</p>
|
|
187
|
+
*/
|
|
188
|
+
PolicyTypeScope?: PolicyTypeScope;
|
|
189
|
+
}
|
|
32
190
|
/**
|
|
33
191
|
* @public
|
|
34
192
|
* <p>An individual Firewall Manager application.</p>
|
|
@@ -111,7 +269,8 @@ export interface AppsListDataSummary {
|
|
|
111
269
|
export interface AssociateAdminAccountRequest {
|
|
112
270
|
/**
|
|
113
271
|
* <p>The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager
|
|
114
|
-
* administrator account. This must be
|
|
272
|
+
* default administrator account. This account must be
|
|
273
|
+
* a member account of the organization in Organizations whose resources you want to protect.
|
|
115
274
|
* For more information about Organizations, see
|
|
116
275
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the Amazon Web Services Accounts in Your Organization</a>. </p>
|
|
117
276
|
*/
|
|
@@ -232,27 +391,27 @@ export type ThirdPartyFirewallAssociationStatus = (typeof ThirdPartyFirewallAsso
|
|
|
232
391
|
export interface AssociateThirdPartyFirewallResponse {
|
|
233
392
|
/**
|
|
234
393
|
* <p>The current status for setting a Firewall Manager policy administrator's account as an administrator of the third-party firewall tenant.</p>
|
|
235
|
-
*
|
|
394
|
+
* <ul>
|
|
236
395
|
* <li>
|
|
237
|
-
*
|
|
396
|
+
* <p>
|
|
238
397
|
* <code>ONBOARDING</code> - The Firewall Manager policy administrator is being designated as a tenant administrator.</p>
|
|
239
|
-
*
|
|
398
|
+
* </li>
|
|
240
399
|
* <li>
|
|
241
|
-
*
|
|
400
|
+
* <p>
|
|
242
401
|
* <code>ONBOARD_COMPLETE</code> - The Firewall Manager policy administrator is designated as a tenant administrator.</p>
|
|
243
|
-
*
|
|
402
|
+
* </li>
|
|
244
403
|
* <li>
|
|
245
|
-
*
|
|
404
|
+
* <p>
|
|
246
405
|
* <code>OFFBOARDING</code> - The Firewall Manager policy administrator is being removed as a tenant administrator.</p>
|
|
247
|
-
*
|
|
406
|
+
* </li>
|
|
248
407
|
* <li>
|
|
249
|
-
*
|
|
408
|
+
* <p>
|
|
250
409
|
* <code>OFFBOARD_COMPLETE</code> - The Firewall Manager policy administrator has been removed as a tenant administrator.</p>
|
|
251
|
-
*
|
|
410
|
+
* </li>
|
|
252
411
|
* <li>
|
|
253
|
-
*
|
|
412
|
+
* <p>
|
|
254
413
|
* <code>NOT_EXIST</code> - The Firewall Manager policy administrator doesn't exist as a tenant administrator.</p>
|
|
255
|
-
*
|
|
414
|
+
* </li>
|
|
256
415
|
* </ul>
|
|
257
416
|
*/
|
|
258
417
|
ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus | string;
|
|
@@ -290,7 +449,7 @@ export interface AwsEc2InstanceViolation {
|
|
|
290
449
|
*/
|
|
291
450
|
export interface BatchAssociateResourceRequest {
|
|
292
451
|
/**
|
|
293
|
-
* <p>A unique identifier for the resource set, used in a
|
|
452
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
294
453
|
*/
|
|
295
454
|
ResourceSetIdentifier: string | undefined;
|
|
296
455
|
/**
|
|
@@ -333,7 +492,7 @@ export interface FailedItem {
|
|
|
333
492
|
*/
|
|
334
493
|
export interface BatchAssociateResourceResponse {
|
|
335
494
|
/**
|
|
336
|
-
* <p>A unique identifier for the resource set, used in a
|
|
495
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
337
496
|
*/
|
|
338
497
|
ResourceSetIdentifier: string | undefined;
|
|
339
498
|
/**
|
|
@@ -346,7 +505,7 @@ export interface BatchAssociateResourceResponse {
|
|
|
346
505
|
*/
|
|
347
506
|
export interface BatchDisassociateResourceRequest {
|
|
348
507
|
/**
|
|
349
|
-
* <p>A unique identifier for the resource set, used in a
|
|
508
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
350
509
|
*/
|
|
351
510
|
ResourceSetIdentifier: string | undefined;
|
|
352
511
|
/**
|
|
@@ -359,7 +518,7 @@ export interface BatchDisassociateResourceRequest {
|
|
|
359
518
|
*/
|
|
360
519
|
export interface BatchDisassociateResourceResponse {
|
|
361
520
|
/**
|
|
362
|
-
* <p>A unique identifier for the resource set, used in a
|
|
521
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
363
522
|
*/
|
|
364
523
|
ResourceSetIdentifier: string | undefined;
|
|
365
524
|
/**
|
|
@@ -440,7 +599,7 @@ export interface DeleteProtocolsListRequest {
|
|
|
440
599
|
*/
|
|
441
600
|
export interface DeleteResourceSetRequest {
|
|
442
601
|
/**
|
|
443
|
-
* <p>A unique identifier for the resource set, used in a
|
|
602
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
444
603
|
*/
|
|
445
604
|
Identifier: string | undefined;
|
|
446
605
|
}
|
|
@@ -477,15 +636,55 @@ export interface GetAdminAccountRequest {
|
|
|
477
636
|
*/
|
|
478
637
|
export interface GetAdminAccountResponse {
|
|
479
638
|
/**
|
|
480
|
-
* <p>The
|
|
639
|
+
* <p>The account that is set as the Firewall Manager default administrator.</p>
|
|
481
640
|
*/
|
|
482
641
|
AdminAccount?: string;
|
|
483
642
|
/**
|
|
484
|
-
* <p>The status of the
|
|
485
|
-
* administrator.</p>
|
|
643
|
+
* <p>The status of the account that you set as the Firewall Manager
|
|
644
|
+
* default administrator.</p>
|
|
486
645
|
*/
|
|
487
646
|
RoleStatus?: AccountRoleStatus | string;
|
|
488
647
|
}
|
|
648
|
+
/**
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
export interface GetAdminScopeRequest {
|
|
652
|
+
/**
|
|
653
|
+
* <p>The administator account that you want to get the details for.</p>
|
|
654
|
+
*/
|
|
655
|
+
AdminAccount: string | undefined;
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
export interface GetAdminScopeResponse {
|
|
661
|
+
/**
|
|
662
|
+
* <p>Contains details about the administrative scope of the requested account.</p>
|
|
663
|
+
*/
|
|
664
|
+
AdminScope?: AdminScope;
|
|
665
|
+
/**
|
|
666
|
+
* <p>The current status of the request to onboard a member account as an Firewall Manager administator.</p>
|
|
667
|
+
* <ul>
|
|
668
|
+
* <li>
|
|
669
|
+
* <p>
|
|
670
|
+
* <code>ONBOARDING</code> - The account is onboarding to Firewall Manager as an administrator.</p>
|
|
671
|
+
* </li>
|
|
672
|
+
* <li>
|
|
673
|
+
* <p>
|
|
674
|
+
* <code>ONBOARDING_COMPLETE</code> - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their <a>AdminScope</a>.</p>
|
|
675
|
+
* </li>
|
|
676
|
+
* <li>
|
|
677
|
+
* <p>
|
|
678
|
+
* <code>OFFBOARDING</code> - The account is being removed as an Firewall Manager administrator.</p>
|
|
679
|
+
* </li>
|
|
680
|
+
* <li>
|
|
681
|
+
* <p>
|
|
682
|
+
* <code>OFFBOARDING_COMPLETE</code> - The account has been removed as an Firewall Manager administrator.</p>
|
|
683
|
+
* </li>
|
|
684
|
+
* </ul>
|
|
685
|
+
*/
|
|
686
|
+
Status?: OrganizationStatus | string;
|
|
687
|
+
}
|
|
489
688
|
/**
|
|
490
689
|
* @public
|
|
491
690
|
*/
|
|
@@ -692,6 +891,18 @@ export declare const CustomerPolicyScopeIdType: {
|
|
|
692
891
|
* @public
|
|
693
892
|
*/
|
|
694
893
|
export type CustomerPolicyScopeIdType = (typeof CustomerPolicyScopeIdType)[keyof typeof CustomerPolicyScopeIdType];
|
|
894
|
+
/**
|
|
895
|
+
* @public
|
|
896
|
+
* @enum
|
|
897
|
+
*/
|
|
898
|
+
export declare const CustomerPolicyStatus: {
|
|
899
|
+
readonly ACTIVE: "ACTIVE";
|
|
900
|
+
readonly OUT_OF_ADMIN_SCOPE: "OUT_OF_ADMIN_SCOPE";
|
|
901
|
+
};
|
|
902
|
+
/**
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
905
|
+
export type CustomerPolicyStatus = (typeof CustomerPolicyStatus)[keyof typeof CustomerPolicyStatus];
|
|
695
906
|
/**
|
|
696
907
|
* @public
|
|
697
908
|
* <p>The resource tags that Firewall Manager uses to determine if a particular resource
|
|
@@ -762,26 +973,6 @@ export interface PolicyOption {
|
|
|
762
973
|
*/
|
|
763
974
|
ThirdPartyFirewallPolicy?: ThirdPartyFirewallPolicy;
|
|
764
975
|
}
|
|
765
|
-
/**
|
|
766
|
-
* @public
|
|
767
|
-
* @enum
|
|
768
|
-
*/
|
|
769
|
-
export declare const SecurityServiceType: {
|
|
770
|
-
readonly DNS_FIREWALL: "DNS_FIREWALL";
|
|
771
|
-
readonly IMPORT_NETWORK_FIREWALL: "IMPORT_NETWORK_FIREWALL";
|
|
772
|
-
readonly NETWORK_FIREWALL: "NETWORK_FIREWALL";
|
|
773
|
-
readonly SECURITY_GROUPS_COMMON: "SECURITY_GROUPS_COMMON";
|
|
774
|
-
readonly SECURITY_GROUPS_CONTENT_AUDIT: "SECURITY_GROUPS_CONTENT_AUDIT";
|
|
775
|
-
readonly SECURITY_GROUPS_USAGE_AUDIT: "SECURITY_GROUPS_USAGE_AUDIT";
|
|
776
|
-
readonly SHIELD_ADVANCED: "SHIELD_ADVANCED";
|
|
777
|
-
readonly THIRD_PARTY_FIREWALL: "THIRD_PARTY_FIREWALL";
|
|
778
|
-
readonly WAF: "WAF";
|
|
779
|
-
readonly WAFV2: "WAFV2";
|
|
780
|
-
};
|
|
781
|
-
/**
|
|
782
|
-
* @public
|
|
783
|
-
*/
|
|
784
|
-
export type SecurityServiceType = (typeof SecurityServiceType)[keyof typeof SecurityServiceType];
|
|
785
976
|
/**
|
|
786
977
|
* @public
|
|
787
978
|
* <p>Details about the security service that is being used to protect the resources.</p>
|
|
@@ -810,6 +1001,18 @@ export interface SecurityServicePolicyData {
|
|
|
810
1001
|
* </note>
|
|
811
1002
|
* </li>
|
|
812
1003
|
* <li>
|
|
1004
|
+
* <p>Example: <code>IMPORT_NETWORK_FIREWALL</code>
|
|
1005
|
+
* <code>"\{\"type\":\"IMPORT_NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":\{\"networkFirewallStatelessRuleGroupReferences\":[\{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\/rg1\",\"priority\":1\}],\"networkFirewallStatelessDefaultActions\":[\"aws:drop\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[],\"networkFirewallStatefulRuleGroupReferences\":[\{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\/ThreatSignaturesEmergingEventsStrictOrder\",\"priority\":8\}],\"networkFirewallStatefulEngineOptions\":\{\"ruleOrder\":\"STRICT_ORDER\"\},\"networkFirewallStatefulDefaultActions\":[\"aws:drop_strict\"]\}\}"</code>
|
|
1006
|
+
* </p>
|
|
1007
|
+
* <p>
|
|
1008
|
+
* <code>"\{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[\{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10\}],\"postProcessRuleGroups\":[\{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911\}]\}"</code>
|
|
1009
|
+
* </p>
|
|
1010
|
+
* <note>
|
|
1011
|
+
* <p>Valid values for <code>preProcessRuleGroups</code> are between 1 and 99. Valid
|
|
1012
|
+
* values for <code>postProcessRuleGroups</code> are between 9901 and 10000.</p>
|
|
1013
|
+
* </note>
|
|
1014
|
+
* </li>
|
|
1015
|
+
* <li>
|
|
813
1016
|
* <p>Example: <code>NETWORK_FIREWALL</code> - Centralized deployment
|
|
814
1017
|
* model</p>
|
|
815
1018
|
* <p>
|
|
@@ -967,16 +1170,30 @@ export interface SecurityServicePolicyData {
|
|
|
967
1170
|
* <code>ManagedServiceData</code> configuration is an empty string.</p>
|
|
968
1171
|
* </li>
|
|
969
1172
|
* <li>
|
|
970
|
-
* <p>Example: <code>WAFV2</code>
|
|
1173
|
+
* <p>Example: <code>WAFV2</code> - Account takeover prevention and Bot Control managed rule groups, and rule action override
|
|
1174
|
+
* </p>
|
|
1175
|
+
* <p>
|
|
1176
|
+
* <code>"\{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[\{\"ruleGroupArn\":null,\"overrideAction\":\{\"type\":\"NONE\"\},\"managedRuleGroupIdentifier\":\{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesATPRuleSet\",\"managedRuleGroupConfigs\":[\{\"awsmanagedRulesATPRuleSet\":\{\"loginPath\":\"/loginpath\",\"requestInspection\":\{\"payloadType\":\"FORM_ENCODED|JSON\",\"usernameField\":\{\"identifier\":\"/form/username\"\},\"passwordField\":\{\"identifier\":\"/form/password\"\}\}\}\}]\},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true\},\{\"ruleGroupArn\":null,\"overrideAction\":\{\"type\":\"NONE\"\},\"managedRuleGroupIdentifier\":\{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesBotControlRuleSet\",\"managedRuleGroupConfigs\":[\{\"awsmanagedRulesBotControlRuleSet\":\{\"inspectionLevel\":\"TARGETED|COMMON\"\}\}]\},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true,\"ruleActionOverrides\":[\{\"name\":\"Rule1\",\"actionToUse\":\{\"allow|block|count|captcha|challenge\":\{\}\}\},\{\"name\":\"Rule2\",\"actionToUse\":\{\"allow|block|count|captcha|challenge\":\{\}\}\}]\}],\"postProcessRuleGroups\":[],\"defaultAction\":\{\"type\":\"ALLOW\"\},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true\}"</code>
|
|
971
1177
|
* </p>
|
|
1178
|
+
* <ul>
|
|
1179
|
+
* <li>
|
|
1180
|
+
* <p>Fraud Control account takeover prevention (ATP) - For information about the properties available for <code>AWSManagedRulesATPRuleSet</code> managed rule groups, see <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesATPRuleSet.html">AWSManagedRulesATPRuleSet</a> in the <i>WAF API Reference</i>.</p>
|
|
1181
|
+
* </li>
|
|
1182
|
+
* <li>
|
|
1183
|
+
* <p>Bot Control - For information about <code>AWSManagedRulesBotControlRuleSet</code> managed rule groups, see <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesBotControlRuleSet.html">AWSManagedRulesBotControlRuleSet</a> in the <i>WAF API Reference</i>.</p>
|
|
1184
|
+
* </li>
|
|
1185
|
+
* <li>
|
|
1186
|
+
* <p>Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a <code>RuleActionOverrides</code> add the <code>Name</code> of the rule to override, and <code>ActionToUse</code>, which is the new action to use for the rule. For information about using rule action override, see <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_RuleActionOverride.html">RuleActionOverride</a> in the <i>WAF API Reference</i>.</p>
|
|
1187
|
+
* </li>
|
|
1188
|
+
* </ul>
|
|
1189
|
+
* </li>
|
|
1190
|
+
* <li>
|
|
1191
|
+
* <p>Example: <code>WAFV2</code> - <code>CAPTCHA</code> and <code>Challenge</code> configs
|
|
1192
|
+
* </p>
|
|
972
1193
|
* <p>
|
|
973
|
-
* <code>"\{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[\{\"ruleGroupArn\":null,\"overrideAction\":\{\"type\":\"NONE\"\},\"managedRuleGroupIdentifier\":\{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"
|
|
1194
|
+
* <code>"\{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[\{\"ruleGroupArn\":null,\"overrideAction\":\{\"type\":\"NONE\"\},\"managedRuleGroupIdentifier\":\{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"\},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true\}],\"postProcessRuleGroups\":[],\"defaultAction\":\{\"type\":\"ALLOW\"\},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"captchaConfig\":\{\"immunityTimeProperty\":\{\"immunityTime\":500\}\},\"challengeConfig\":\{\"immunityTimeProperty\":\{\"immunityTime\":800\}\},\"tokenDomains\":[\"google.com\",\"amazon.com\"]\}"</code>
|
|
974
1195
|
* </p>
|
|
975
|
-
* <p>
|
|
976
|
-
* <code>logDestinationConfigs</code>, you can optionally provide up to 20
|
|
977
|
-
* <code>redactedFields</code>, and the <code>RedactedFieldType</code> must be one of
|
|
978
|
-
* <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or
|
|
979
|
-
* <code>METHOD</code>.</p>
|
|
1196
|
+
* <p>If you update the policy's values for <code>captchaConfig</code>, <code>challengeConfig</code>, or <code>tokenDomains</code>, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's <code>captchaConfig</code>, <code>challengeConfig</code>, or <code>tokenDomains</code> values, the values in your local web ACLs will remain unchanged. For information about CAPTCHA and Challenge configs, see <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_CaptchaConfig.html">CaptchaConfig</a> and <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_ChallengeConfig.html">ChallengeConfig</a> in the <i>WAF API Reference</i>.</p>
|
|
980
1197
|
* </li>
|
|
981
1198
|
* <li>
|
|
982
1199
|
* <p>Example: <code>WAFV2</code> - Firewall Manager support for WAF managed rule group versioning
|
|
@@ -989,6 +1206,20 @@ export interface SecurityServicePolicyData {
|
|
|
989
1206
|
* </p>
|
|
990
1207
|
* </li>
|
|
991
1208
|
* <li>
|
|
1209
|
+
* <p>Example: <code>WAFV2</code> - Logging configurations
|
|
1210
|
+
* </p>
|
|
1211
|
+
* <p>
|
|
1212
|
+
* <code>"\{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[\{\"ruleGroupArn\":null, \"overrideAction\":\{\"type\":\"NONE\"\},\"managedRuleGroupIdentifier\": \{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\", \"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"\} ,\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[], \"sampledRequestsEnabled\":true\}],\"postProcessRuleGroups\":[], \"defaultAction\":\{\"type\":\"ALLOW\"\},\"customRequestHandling\" :null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\" :false,\"loggingConfiguration\":\{\"logDestinationConfigs\": [\"arn:aws:s3:::aws-waf-logs-example-bucket\"] ,\"redactedFields\":[],\"loggingFilterConfigs\":\{\"defaultBehavior\":\"KEEP\", \"filters\":[\{\"behavior\":\"KEEP\",\"requirement\":\"MEETS_ALL\", \"conditions\":[\{\"actionCondition\":\"CAPTCHA\"\},\{\"actionCondition\": \"CHALLENGE\"\}, \{\"actionCondition\":\"EXCLUDED_AS_COUNT\"\}]\}]\}\},\"sampledRequestsEnabledForDefaultActions\":true\}"</code>
|
|
1213
|
+
* </p>
|
|
1214
|
+
* <p>Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the <code>logDestinationConfigs</code> in your <code>loggingConfiguration</code>. For information about WAF logging configurations, see <a href="https://docs.aws.amazon.com/waf/latest/APIReference/API_LoggingConfiguration.html">LoggingConfiguration</a> in the <i>WAF API Reference</i>
|
|
1215
|
+
* </p>
|
|
1216
|
+
* <p>In the <code>loggingConfiguration</code>, you can specify one
|
|
1217
|
+
* <code>logDestinationConfigs</code>. Optionally provide as many as 20
|
|
1218
|
+
* <code>redactedFields</code>. The <code>RedactedFieldType</code> must be one of
|
|
1219
|
+
* <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or
|
|
1220
|
+
* <code>METHOD</code>.</p>
|
|
1221
|
+
* </li>
|
|
1222
|
+
* <li>
|
|
992
1223
|
* <p>Example: <code>WAF Classic</code>
|
|
993
1224
|
* </p>
|
|
994
1225
|
* <p>
|
|
@@ -1035,7 +1266,7 @@ export interface Policy {
|
|
|
1035
1266
|
* <p>The type of resource protected by or in scope of the policy. This is in the format shown
|
|
1036
1267
|
* in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types Reference</a>.
|
|
1037
1268
|
* To apply this policy to multiple resource types, specify a resource type of <code>ResourceTypeList</code> and then specify the resource types in a <code>ResourceTypeList</code>.</p>
|
|
1038
|
-
*
|
|
1269
|
+
* <p>For WAF and Shield Advanced, resource types include
|
|
1039
1270
|
* <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code>, <code>AWS::ElasticLoadBalancing::LoadBalancer</code>, <code>AWS::EC2::EIP</code>, and
|
|
1040
1271
|
* <code>AWS::CloudFront::Distribution</code>. For a security group common policy, valid values
|
|
1041
1272
|
* are <code>AWS::EC2::NetworkInterface</code> and <code>AWS::EC2::Instance</code>. For a
|
|
@@ -1075,7 +1306,7 @@ export interface Policy {
|
|
|
1075
1306
|
/**
|
|
1076
1307
|
* <p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy.
|
|
1077
1308
|
* Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p>
|
|
1078
|
-
*
|
|
1309
|
+
* <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager
|
|
1079
1310
|
* applies the policy to all accounts specified by the <code>IncludeMap</code>, and
|
|
1080
1311
|
* does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager
|
|
1081
1312
|
* applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p>
|
|
@@ -1099,7 +1330,7 @@ export interface Policy {
|
|
|
1099
1330
|
/**
|
|
1100
1331
|
* <p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy.
|
|
1101
1332
|
* Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p>
|
|
1102
|
-
*
|
|
1333
|
+
* <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager
|
|
1103
1334
|
* applies the policy to all accounts specified by the <code>IncludeMap</code>, and
|
|
1104
1335
|
* does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager
|
|
1105
1336
|
* applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p>
|
|
@@ -1128,6 +1359,20 @@ export interface Policy {
|
|
|
1128
1359
|
* <p>The definition of the Network Firewall firewall policy.</p>
|
|
1129
1360
|
*/
|
|
1130
1361
|
PolicyDescription?: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>Indicates whether the policy is in or out of an admin's policy or Region scope.</p>
|
|
1364
|
+
* <ul>
|
|
1365
|
+
* <li>
|
|
1366
|
+
* <p>
|
|
1367
|
+
* <code>ACTIVE</code> - The administrator can manage and delete the policy.</p>
|
|
1368
|
+
* </li>
|
|
1369
|
+
* <li>
|
|
1370
|
+
* <p>
|
|
1371
|
+
* <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.</p>
|
|
1372
|
+
* </li>
|
|
1373
|
+
* </ul>
|
|
1374
|
+
*/
|
|
1375
|
+
PolicyStatus?: CustomerPolicyStatus | string;
|
|
1131
1376
|
}
|
|
1132
1377
|
/**
|
|
1133
1378
|
* @public
|
|
@@ -1308,10 +1553,22 @@ export interface GetProtocolsListResponse {
|
|
|
1308
1553
|
*/
|
|
1309
1554
|
export interface GetResourceSetRequest {
|
|
1310
1555
|
/**
|
|
1311
|
-
* <p>A unique identifier for the resource set, used in a
|
|
1556
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
1312
1557
|
*/
|
|
1313
1558
|
Identifier: string | undefined;
|
|
1314
1559
|
}
|
|
1560
|
+
/**
|
|
1561
|
+
* @public
|
|
1562
|
+
* @enum
|
|
1563
|
+
*/
|
|
1564
|
+
export declare const ResourceSetStatus: {
|
|
1565
|
+
readonly ACTIVE: "ACTIVE";
|
|
1566
|
+
readonly OUT_OF_ADMIN_SCOPE: "OUT_OF_ADMIN_SCOPE";
|
|
1567
|
+
};
|
|
1568
|
+
/**
|
|
1569
|
+
* @public
|
|
1570
|
+
*/
|
|
1571
|
+
export type ResourceSetStatus = (typeof ResourceSetStatus)[keyof typeof ResourceSetStatus];
|
|
1315
1572
|
/**
|
|
1316
1573
|
* @public
|
|
1317
1574
|
* <p>A set of resources to include in a policy.</p>
|
|
@@ -1346,6 +1603,20 @@ export interface ResourceSet {
|
|
|
1346
1603
|
* <p>The last time that the resource set was changed.</p>
|
|
1347
1604
|
*/
|
|
1348
1605
|
LastUpdateTime?: Date;
|
|
1606
|
+
/**
|
|
1607
|
+
* <p>Indicates whether the resource set is in or out of an admin's Region scope.</p>
|
|
1608
|
+
* <ul>
|
|
1609
|
+
* <li>
|
|
1610
|
+
* <p>
|
|
1611
|
+
* <code>ACTIVE</code> - The administrator can manage and delete the resource set.</p>
|
|
1612
|
+
* </li>
|
|
1613
|
+
* <li>
|
|
1614
|
+
* <p>
|
|
1615
|
+
* <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.</p>
|
|
1616
|
+
* </li>
|
|
1617
|
+
* </ul>
|
|
1618
|
+
*/
|
|
1619
|
+
ResourceSetStatus?: ResourceSetStatus | string;
|
|
1349
1620
|
}
|
|
1350
1621
|
/**
|
|
1351
1622
|
* @public
|
|
@@ -1414,19 +1685,19 @@ export interface GetThirdPartyFirewallAssociationStatusResponse {
|
|
|
1414
1685
|
ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus | string;
|
|
1415
1686
|
/**
|
|
1416
1687
|
* <p>The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.</p>
|
|
1417
|
-
*
|
|
1688
|
+
* <ul>
|
|
1418
1689
|
* <li>
|
|
1419
|
-
*
|
|
1690
|
+
* <p>
|
|
1420
1691
|
* <code>NO_SUBSCRIPTION</code> - The Firewall Manager policy administrator isn't subscribed to the third-party firewall service in the Amazon Web Services Marketplace.</p>
|
|
1421
|
-
*
|
|
1692
|
+
* </li>
|
|
1422
1693
|
* <li>
|
|
1423
|
-
*
|
|
1694
|
+
* <p>
|
|
1424
1695
|
* <code>NOT_COMPLETE</code> - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn't yet have an active subscription.</p>
|
|
1425
|
-
*
|
|
1696
|
+
* </li>
|
|
1426
1697
|
* <li>
|
|
1427
|
-
*
|
|
1698
|
+
* <p>
|
|
1428
1699
|
* <code>COMPLETE</code> - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.</p>
|
|
1429
|
-
*
|
|
1700
|
+
* </li>
|
|
1430
1701
|
* </ul>
|
|
1431
1702
|
*/
|
|
1432
1703
|
MarketplaceOnboardingStatus?: MarketplaceSubscriptionOnboardingStatus | string;
|
|
@@ -2776,6 +3047,70 @@ export interface GetViolationDetailsResponse {
|
|
|
2776
3047
|
*/
|
|
2777
3048
|
ViolationDetail?: ViolationDetail;
|
|
2778
3049
|
}
|
|
3050
|
+
/**
|
|
3051
|
+
* @public
|
|
3052
|
+
*/
|
|
3053
|
+
export interface ListAdminAccountsForOrganizationRequest {
|
|
3054
|
+
/**
|
|
3055
|
+
* <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
|
|
3056
|
+
* for retrieval exceeds the maximum you requested, Firewall Manager returns a <code>NextToken</code>
|
|
3057
|
+
* value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
|
|
3058
|
+
*/
|
|
3059
|
+
NextToken?: string;
|
|
3060
|
+
/**
|
|
3061
|
+
* <p>The maximum number of objects that you want Firewall Manager to return for this request. If more
|
|
3062
|
+
* objects are available, in the response, Firewall Manager provides a
|
|
3063
|
+
* <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
|
|
3064
|
+
*/
|
|
3065
|
+
MaxResults?: number;
|
|
3066
|
+
}
|
|
3067
|
+
/**
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
export interface ListAdminAccountsForOrganizationResponse {
|
|
3071
|
+
/**
|
|
3072
|
+
* <p>A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by <a>AssociateAdminAccount</a> or <a>PutAdminAccount</a>.</p>
|
|
3073
|
+
*/
|
|
3074
|
+
AdminAccounts?: AdminAccountSummary[];
|
|
3075
|
+
/**
|
|
3076
|
+
* <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
|
|
3077
|
+
* for retrieval exceeds the maximum you requested, Firewall Manager returns a <code>NextToken</code>
|
|
3078
|
+
* value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
|
|
3079
|
+
*/
|
|
3080
|
+
NextToken?: string;
|
|
3081
|
+
}
|
|
3082
|
+
/**
|
|
3083
|
+
* @public
|
|
3084
|
+
*/
|
|
3085
|
+
export interface ListAdminsManagingAccountRequest {
|
|
3086
|
+
/**
|
|
3087
|
+
* <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
|
|
3088
|
+
* for retrieval exceeds the maximum you requested, Firewall Manager returns a <code>NextToken</code>
|
|
3089
|
+
* value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
|
|
3090
|
+
*/
|
|
3091
|
+
NextToken?: string;
|
|
3092
|
+
/**
|
|
3093
|
+
* <p>The maximum number of objects that you want Firewall Manager to return for this request. If more
|
|
3094
|
+
* objects are available, in the response, Firewall Manager provides a
|
|
3095
|
+
* <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
|
|
3096
|
+
*/
|
|
3097
|
+
MaxResults?: number;
|
|
3098
|
+
}
|
|
3099
|
+
/**
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
3102
|
+
export interface ListAdminsManagingAccountResponse {
|
|
3103
|
+
/**
|
|
3104
|
+
* <p>The list of accounts who manage member accounts within their <a>AdminScope</a>.</p>
|
|
3105
|
+
*/
|
|
3106
|
+
AdminAccounts?: string[];
|
|
3107
|
+
/**
|
|
3108
|
+
* <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
|
|
3109
|
+
* for retrieval exceeds the maximum you requested, Firewall Manager returns a <code>NextToken</code>
|
|
3110
|
+
* value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
|
|
3111
|
+
*/
|
|
3112
|
+
NextToken?: string;
|
|
3113
|
+
}
|
|
2779
3114
|
/**
|
|
2780
3115
|
* @public
|
|
2781
3116
|
*/
|
|
@@ -3101,6 +3436,20 @@ export interface PolicySummary {
|
|
|
3101
3436
|
* <p>This option is not available for Shield Advanced or WAF Classic policies.</p>
|
|
3102
3437
|
*/
|
|
3103
3438
|
DeleteUnusedFMManagedResources?: boolean;
|
|
3439
|
+
/**
|
|
3440
|
+
* <p>Indicates whether the policy is in or out of an admin's policy or Region scope.</p>
|
|
3441
|
+
* <ul>
|
|
3442
|
+
* <li>
|
|
3443
|
+
* <p>
|
|
3444
|
+
* <code>ACTIVE</code> - The administrator can manage and delete the policy.</p>
|
|
3445
|
+
* </li>
|
|
3446
|
+
* <li>
|
|
3447
|
+
* <p>
|
|
3448
|
+
* <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.</p>
|
|
3449
|
+
* </li>
|
|
3450
|
+
* </ul>
|
|
3451
|
+
*/
|
|
3452
|
+
PolicyStatus?: CustomerPolicyStatus | string;
|
|
3104
3453
|
}
|
|
3105
3454
|
/**
|
|
3106
3455
|
* @public
|
|
@@ -3182,7 +3531,7 @@ export interface ListProtocolsListsResponse {
|
|
|
3182
3531
|
*/
|
|
3183
3532
|
export interface ListResourceSetResourcesRequest {
|
|
3184
3533
|
/**
|
|
3185
|
-
* <p>A unique identifier for the resource set, used in a
|
|
3534
|
+
* <p>A unique identifier for the resource set, used in a request to refer to the resource set.</p>
|
|
3186
3535
|
*/
|
|
3187
3536
|
Identifier: string | undefined;
|
|
3188
3537
|
/**
|
|
@@ -3265,6 +3614,20 @@ export interface ResourceSetSummary {
|
|
|
3265
3614
|
* <p>The last time that the resource set was changed.</p>
|
|
3266
3615
|
*/
|
|
3267
3616
|
LastUpdateTime?: Date;
|
|
3617
|
+
/**
|
|
3618
|
+
* <p>Indicates whether the resource set is in or out of an admin's Region scope.</p>
|
|
3619
|
+
* <ul>
|
|
3620
|
+
* <li>
|
|
3621
|
+
* <p>
|
|
3622
|
+
* <code>ACTIVE</code> - The administrator can manage and delete the resource set.</p>
|
|
3623
|
+
* </li>
|
|
3624
|
+
* <li>
|
|
3625
|
+
* <p>
|
|
3626
|
+
* <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.</p>
|
|
3627
|
+
* </li>
|
|
3628
|
+
* </ul>
|
|
3629
|
+
*/
|
|
3630
|
+
ResourceSetStatus?: ResourceSetStatus | string;
|
|
3268
3631
|
}
|
|
3269
3632
|
/**
|
|
3270
3633
|
* @public
|
|
@@ -3353,6 +3716,20 @@ export interface ListThirdPartyFirewallFirewallPoliciesResponse {
|
|
|
3353
3716
|
*/
|
|
3354
3717
|
NextToken?: string;
|
|
3355
3718
|
}
|
|
3719
|
+
/**
|
|
3720
|
+
* @public
|
|
3721
|
+
*/
|
|
3722
|
+
export interface PutAdminAccountRequest {
|
|
3723
|
+
/**
|
|
3724
|
+
* <p>The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by <a>AssociateAdminAccount</a>. For more information about Organizations, see
|
|
3725
|
+
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the Amazon Web Services Accounts in Your Organization</a>.</p>
|
|
3726
|
+
*/
|
|
3727
|
+
AdminAccount: string | undefined;
|
|
3728
|
+
/**
|
|
3729
|
+
* <p>Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.</p>
|
|
3730
|
+
*/
|
|
3731
|
+
AdminScope?: AdminScope;
|
|
3732
|
+
}
|
|
3356
3733
|
/**
|
|
3357
3734
|
* @public
|
|
3358
3735
|
*/
|