aws-sdk 2.1102.0 → 2.1105.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/CHANGELOG.md +18 -1
- package/README.md +1 -1
- package/apis/ec2-2016-11-15.min.json +863 -807
- package/apis/fms-2018-01-01.min.json +210 -83
- package/apis/fms-2018-01-01.paginators.json +6 -0
- package/apis/fsx-2018-03-01.min.json +3 -0
- package/apis/grafana-2020-08-18.min.json +117 -19
- package/apis/iot-data-2015-05-28.min.json +1 -1
- package/apis/metadata.json +4 -0
- package/apis/organizations-2016-11-28.min.json +77 -62
- package/apis/pinpoint-sms-voice-v2-2022-03-31.examples.json +5 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +1681 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +70 -0
- package/apis/pinpoint-sms-voice-v2-2022-03-31.waiters2.json +5 -0
- package/apis/route53-recovery-cluster-2019-12-02.min.json +39 -4
- package/apis/route53-recovery-cluster-2019-12-02.paginators.json +6 -0
- package/apis/workspaces-2015-04-08.min.json +195 -27
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/auditmanager.d.ts +4 -4
- package/clients/cloudcontrol.d.ts +22 -22
- package/clients/databrew.d.ts +3 -3
- package/clients/ec2.d.ts +77 -3
- package/clients/fms.d.ts +222 -8
- package/clients/fsx.d.ts +12 -8
- package/clients/grafana.d.ts +81 -5
- package/clients/iot.d.ts +13 -13
- package/clients/iotdata.d.ts +7 -7
- package/clients/organizations.d.ts +144 -129
- package/clients/pinpointsmsvoicev2.d.ts +2367 -0
- package/clients/pinpointsmsvoicev2.js +19 -0
- package/clients/route53recoverycluster.d.ts +75 -12
- package/clients/workspaces.d.ts +239 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +58 -14
- package/dist/aws-sdk.js +871 -811
- package/dist/aws-sdk.min.js +69 -69
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/fms.d.ts
CHANGED
|
@@ -19,6 +19,14 @@ declare class FMS extends Service {
|
|
|
19
19
|
* Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. The account that you associate with Firewall Manager is called the Firewall Manager administrator account.
|
|
20
20
|
*/
|
|
21
21
|
associateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
22
|
+
/**
|
|
23
|
+
* Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.
|
|
24
|
+
*/
|
|
25
|
+
associateThirdPartyFirewall(params: FMS.Types.AssociateThirdPartyFirewallRequest, callback?: (err: AWSError, data: FMS.Types.AssociateThirdPartyFirewallResponse) => void): Request<FMS.Types.AssociateThirdPartyFirewallResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.
|
|
28
|
+
*/
|
|
29
|
+
associateThirdPartyFirewall(callback?: (err: AWSError, data: FMS.Types.AssociateThirdPartyFirewallResponse) => void): Request<FMS.Types.AssociateThirdPartyFirewallResponse, AWSError>;
|
|
22
30
|
/**
|
|
23
31
|
* Permanently deletes an Firewall Manager applications list.
|
|
24
32
|
*/
|
|
@@ -59,6 +67,14 @@ declare class FMS extends Service {
|
|
|
59
67
|
* Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.
|
|
60
68
|
*/
|
|
61
69
|
disassociateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
70
|
+
/**
|
|
71
|
+
* Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.
|
|
72
|
+
*/
|
|
73
|
+
disassociateThirdPartyFirewall(params: FMS.Types.DisassociateThirdPartyFirewallRequest, callback?: (err: AWSError, data: FMS.Types.DisassociateThirdPartyFirewallResponse) => void): Request<FMS.Types.DisassociateThirdPartyFirewallResponse, AWSError>;
|
|
74
|
+
/**
|
|
75
|
+
* Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.
|
|
76
|
+
*/
|
|
77
|
+
disassociateThirdPartyFirewall(callback?: (err: AWSError, data: FMS.Types.DisassociateThirdPartyFirewallResponse) => void): Request<FMS.Types.DisassociateThirdPartyFirewallResponse, AWSError>;
|
|
62
78
|
/**
|
|
63
79
|
* Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
|
|
64
80
|
*/
|
|
@@ -115,6 +131,14 @@ declare class FMS extends Service {
|
|
|
115
131
|
* Returns information about the specified Firewall Manager protocols list.
|
|
116
132
|
*/
|
|
117
133
|
getProtocolsList(callback?: (err: AWSError, data: FMS.Types.GetProtocolsListResponse) => void): Request<FMS.Types.GetProtocolsListResponse, AWSError>;
|
|
134
|
+
/**
|
|
135
|
+
* The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
|
|
136
|
+
*/
|
|
137
|
+
getThirdPartyFirewallAssociationStatus(params: FMS.Types.GetThirdPartyFirewallAssociationStatusRequest, callback?: (err: AWSError, data: FMS.Types.GetThirdPartyFirewallAssociationStatusResponse) => void): Request<FMS.Types.GetThirdPartyFirewallAssociationStatusResponse, AWSError>;
|
|
138
|
+
/**
|
|
139
|
+
* The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
|
|
140
|
+
*/
|
|
141
|
+
getThirdPartyFirewallAssociationStatus(callback?: (err: AWSError, data: FMS.Types.GetThirdPartyFirewallAssociationStatusResponse) => void): Request<FMS.Types.GetThirdPartyFirewallAssociationStatusResponse, AWSError>;
|
|
118
142
|
/**
|
|
119
143
|
* Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
|
|
120
144
|
*/
|
|
@@ -171,6 +195,14 @@ declare class FMS extends Service {
|
|
|
171
195
|
* Retrieves the list of tags for the specified Amazon Web Services resource.
|
|
172
196
|
*/
|
|
173
197
|
listTagsForResource(callback?: (err: AWSError, data: FMS.Types.ListTagsForResourceResponse) => void): Request<FMS.Types.ListTagsForResourceResponse, AWSError>;
|
|
198
|
+
/**
|
|
199
|
+
* Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
|
|
200
|
+
*/
|
|
201
|
+
listThirdPartyFirewallFirewallPolicies(params: FMS.Types.ListThirdPartyFirewallFirewallPoliciesRequest, callback?: (err: AWSError, data: FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse) => void): Request<FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse, AWSError>;
|
|
202
|
+
/**
|
|
203
|
+
* Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
|
|
204
|
+
*/
|
|
205
|
+
listThirdPartyFirewallFirewallPolicies(callback?: (err: AWSError, data: FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse) => void): Request<FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse, AWSError>;
|
|
174
206
|
/**
|
|
175
207
|
* Creates an Firewall Manager applications list.
|
|
176
208
|
*/
|
|
@@ -303,6 +335,18 @@ declare namespace FMS {
|
|
|
303
335
|
*/
|
|
304
336
|
AdminAccount: AWSAccountId;
|
|
305
337
|
}
|
|
338
|
+
export interface AssociateThirdPartyFirewallRequest {
|
|
339
|
+
/**
|
|
340
|
+
* The name of the third-party firewall vendor.
|
|
341
|
+
*/
|
|
342
|
+
ThirdPartyFirewall: ThirdPartyFirewall;
|
|
343
|
+
}
|
|
344
|
+
export interface AssociateThirdPartyFirewallResponse {
|
|
345
|
+
/**
|
|
346
|
+
* The current status for setting a Firewall Manager policy administrator's account as an administrator of the third-party firewall tenant. ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator. ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator. OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator. OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator. NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.
|
|
347
|
+
*/
|
|
348
|
+
ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus;
|
|
349
|
+
}
|
|
306
350
|
export interface AwsEc2InstanceViolation {
|
|
307
351
|
/**
|
|
308
352
|
* The resource ID of the EC2 instance.
|
|
@@ -398,6 +442,18 @@ declare namespace FMS {
|
|
|
398
442
|
export type DetailedInfo = string;
|
|
399
443
|
export interface DisassociateAdminAccountRequest {
|
|
400
444
|
}
|
|
445
|
+
export interface DisassociateThirdPartyFirewallRequest {
|
|
446
|
+
/**
|
|
447
|
+
* The name of the third-party firewall vendor.
|
|
448
|
+
*/
|
|
449
|
+
ThirdPartyFirewall: ThirdPartyFirewall;
|
|
450
|
+
}
|
|
451
|
+
export interface DisassociateThirdPartyFirewallResponse {
|
|
452
|
+
/**
|
|
453
|
+
* The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.
|
|
454
|
+
*/
|
|
455
|
+
ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus;
|
|
456
|
+
}
|
|
401
457
|
export interface DnsDuplicateRuleGroupViolation {
|
|
402
458
|
/**
|
|
403
459
|
* Information about the VPC ID.
|
|
@@ -632,7 +688,9 @@ declare namespace FMS {
|
|
|
632
688
|
*/
|
|
633
689
|
FirewallCreationConfig?: ManagedServiceData;
|
|
634
690
|
}
|
|
635
|
-
export type FirewallDeploymentModel = "CENTRALIZED"|string;
|
|
691
|
+
export type FirewallDeploymentModel = "CENTRALIZED"|"DISTRIBUTED"|string;
|
|
692
|
+
export type FirewallPolicyId = string;
|
|
693
|
+
export type FirewallPolicyName = string;
|
|
636
694
|
export interface FirewallSubnetIsOutOfScopeViolation {
|
|
637
695
|
/**
|
|
638
696
|
* The ID of the firewall subnet that violates the policy scope.
|
|
@@ -655,6 +713,24 @@ declare namespace FMS {
|
|
|
655
713
|
*/
|
|
656
714
|
VpcEndpointId?: ResourceId;
|
|
657
715
|
}
|
|
716
|
+
export interface FirewallSubnetMissingVPCEndpointViolation {
|
|
717
|
+
/**
|
|
718
|
+
* The ID of the firewall that this VPC endpoint is associated with.
|
|
719
|
+
*/
|
|
720
|
+
FirewallSubnetId?: ResourceId;
|
|
721
|
+
/**
|
|
722
|
+
* The resource ID of the VPC associated with the deleted VPC subnet.
|
|
723
|
+
*/
|
|
724
|
+
VpcId?: ResourceId;
|
|
725
|
+
/**
|
|
726
|
+
* The name of the Availability Zone of the deleted VPC subnet.
|
|
727
|
+
*/
|
|
728
|
+
SubnetAvailabilityZone?: LengthBoundedString;
|
|
729
|
+
/**
|
|
730
|
+
* The ID of the Availability Zone of the deleted VPC subnet.
|
|
731
|
+
*/
|
|
732
|
+
SubnetAvailabilityZoneId?: LengthBoundedString;
|
|
733
|
+
}
|
|
658
734
|
export interface GetAdminAccountRequest {
|
|
659
735
|
}
|
|
660
736
|
export interface GetAdminAccountResponse {
|
|
@@ -795,6 +871,22 @@ declare namespace FMS {
|
|
|
795
871
|
*/
|
|
796
872
|
ProtocolsListArn?: ResourceArn;
|
|
797
873
|
}
|
|
874
|
+
export interface GetThirdPartyFirewallAssociationStatusRequest {
|
|
875
|
+
/**
|
|
876
|
+
* The name of the third-party firewall vendor.
|
|
877
|
+
*/
|
|
878
|
+
ThirdPartyFirewall: ThirdPartyFirewall;
|
|
879
|
+
}
|
|
880
|
+
export interface GetThirdPartyFirewallAssociationStatusResponse {
|
|
881
|
+
/**
|
|
882
|
+
* The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant. ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator. ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator. OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator. OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator. NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.
|
|
883
|
+
*/
|
|
884
|
+
ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus;
|
|
885
|
+
/**
|
|
886
|
+
* The status for subscribing to the third-party firewall vendor in the AWS Marketplace. NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed to the third-party firewall service in the AWS Marketplace. NOT_COMPLETE - 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. COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.
|
|
887
|
+
*/
|
|
888
|
+
MarketplaceOnboardingStatus?: MarketplaceSubscriptionOnboardingStatus;
|
|
889
|
+
}
|
|
798
890
|
export interface GetViolationDetailsRequest {
|
|
799
891
|
/**
|
|
800
892
|
* The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
|
|
@@ -948,7 +1040,32 @@ declare namespace FMS {
|
|
|
948
1040
|
*/
|
|
949
1041
|
TagList?: TagList;
|
|
950
1042
|
}
|
|
1043
|
+
export interface ListThirdPartyFirewallFirewallPoliciesRequest {
|
|
1044
|
+
/**
|
|
1045
|
+
* The name of the third-party firewall vendor.
|
|
1046
|
+
*/
|
|
1047
|
+
ThirdPartyFirewall: ThirdPartyFirewall;
|
|
1048
|
+
/**
|
|
1049
|
+
* If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn't include a NextToken element, there are no more third-party firewall policies to get.
|
|
1050
|
+
*/
|
|
1051
|
+
NextToken?: PaginationToken;
|
|
1052
|
+
/**
|
|
1053
|
+
* The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.
|
|
1054
|
+
*/
|
|
1055
|
+
MaxResults: PaginationMaxResults;
|
|
1056
|
+
}
|
|
1057
|
+
export interface ListThirdPartyFirewallFirewallPoliciesResponse {
|
|
1058
|
+
/**
|
|
1059
|
+
* A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall policies that the specified third-party firewall vendor is associated with. Each ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.
|
|
1060
|
+
*/
|
|
1061
|
+
ThirdPartyFirewallFirewallPolicies?: ThirdPartyFirewallFirewallPolicies;
|
|
1062
|
+
/**
|
|
1063
|
+
* The value that you will use for NextToken in the next ListThirdPartyFirewallFirewallPolicies request.
|
|
1064
|
+
*/
|
|
1065
|
+
NextToken?: PaginationToken;
|
|
1066
|
+
}
|
|
951
1067
|
export type ManagedServiceData = string;
|
|
1068
|
+
export type MarketplaceSubscriptionOnboardingStatus = "NO_SUBSCRIPTION"|"NOT_COMPLETE"|"COMPLETE"|string;
|
|
952
1069
|
export type MemberAccounts = AWSAccountId[];
|
|
953
1070
|
export type NetworkFirewallAction = string;
|
|
954
1071
|
export type NetworkFirewallActionList = NetworkFirewallAction[];
|
|
@@ -1297,7 +1414,7 @@ declare namespace FMS {
|
|
|
1297
1414
|
*/
|
|
1298
1415
|
ResourceTags?: ResourceTags;
|
|
1299
1416
|
/**
|
|
1300
|
-
* If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.
|
|
1417
|
+
* If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.
|
|
1301
1418
|
*/
|
|
1302
1419
|
ExcludeResourceTags: Boolean;
|
|
1303
1420
|
/**
|
|
@@ -1309,11 +1426,11 @@ declare namespace FMS {
|
|
|
1309
1426
|
*/
|
|
1310
1427
|
DeleteUnusedFMManagedResources?: Boolean;
|
|
1311
1428
|
/**
|
|
1312
|
-
* Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. 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. You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap. You can specify account IDs, OUs, or a combination: Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
|
|
1429
|
+
* Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. 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. You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap. You can specify account IDs, OUs, or a combination: Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
|
|
1313
1430
|
*/
|
|
1314
1431
|
IncludeMap?: CustomerPolicyScopeMap;
|
|
1315
1432
|
/**
|
|
1316
|
-
* Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. 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. You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap. You can specify account IDs, OUs, or a combination: Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
|
|
1433
|
+
* Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. 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. You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap. You can specify account IDs, OUs, or a combination: Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
|
|
1317
1434
|
*/
|
|
1318
1435
|
ExcludeMap?: CustomerPolicyScopeMap;
|
|
1319
1436
|
}
|
|
@@ -1385,6 +1502,10 @@ declare namespace FMS {
|
|
|
1385
1502
|
* Defines the deployment model to use for the firewall policy.
|
|
1386
1503
|
*/
|
|
1387
1504
|
NetworkFirewallPolicy?: NetworkFirewallPolicy;
|
|
1505
|
+
/**
|
|
1506
|
+
* Defines the policy options for a third-party firewall policy.
|
|
1507
|
+
*/
|
|
1508
|
+
ThirdPartyFirewallPolicy?: ThirdPartyFirewallPolicy;
|
|
1388
1509
|
}
|
|
1389
1510
|
export interface PolicySummary {
|
|
1390
1511
|
/**
|
|
@@ -1713,6 +1834,22 @@ declare namespace FMS {
|
|
|
1713
1834
|
* Contains details about the route endpoint that violates the policy scope.
|
|
1714
1835
|
*/
|
|
1715
1836
|
RouteHasOutOfScopeEndpointViolation?: RouteHasOutOfScopeEndpointViolation;
|
|
1837
|
+
/**
|
|
1838
|
+
* The violation details for a third-party firewall that's been deleted.
|
|
1839
|
+
*/
|
|
1840
|
+
ThirdPartyFirewallMissingFirewallViolation?: ThirdPartyFirewallMissingFirewallViolation;
|
|
1841
|
+
/**
|
|
1842
|
+
* The violation details for a third-party firewall's subnet that's been deleted.
|
|
1843
|
+
*/
|
|
1844
|
+
ThirdPartyFirewallMissingSubnetViolation?: ThirdPartyFirewallMissingSubnetViolation;
|
|
1845
|
+
/**
|
|
1846
|
+
* The violation details for a third-party firewall that has the Firewall Manager managed route table that was associated with the third-party firewall has been deleted.
|
|
1847
|
+
*/
|
|
1848
|
+
ThirdPartyFirewallMissingExpectedRouteTableViolation?: ThirdPartyFirewallMissingExpectedRouteTableViolation;
|
|
1849
|
+
/**
|
|
1850
|
+
* The violation details for a third-party firewall's VPC endpoint subnet that was deleted.
|
|
1851
|
+
*/
|
|
1852
|
+
FirewallSubnetMissingVPCEndpointViolation?: FirewallSubnetMissingVPCEndpointViolation;
|
|
1716
1853
|
}
|
|
1717
1854
|
export type ResourceViolations = ResourceViolation[];
|
|
1718
1855
|
export interface Route {
|
|
@@ -1835,7 +1972,7 @@ declare namespace FMS {
|
|
|
1835
1972
|
*/
|
|
1836
1973
|
Type: SecurityServiceType;
|
|
1837
1974
|
/**
|
|
1838
|
-
* Details about the service that are specific to the service type, in JSON format. Example: DNS_FIREWALL "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}" Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000. Example: NETWORK_FIREWALL - Centralized deployment model. "{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}" To use the centralized deployment model, you must set PolicyOption to CENTRALIZED. Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. "{ \"type\": \"NETWORK_FIREWALL\", \"networkFirewallStatelessRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\", \"priority\": 1 } ], \"networkFirewallStatelessDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessCustomActions\": [ { \"actionName\": \"customActionName\", \"actionDefinition\": { \"publishMetricAction\": { \"dimensions\": [ { \"value\": \"metricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\": { \"singleFirewallEndpointPerVPC\": false, \"allowedIPV4CidrList\": [ \"10.0.0.0/28\", \"192.168.0.0/28\" ], \"routeManagementAction\": \"OFF\" }, \"networkFirewallLoggingConfiguration\": { \"logDestinationConfigs\": [ { \"logDestinationType\": \"S3\", \"logType\": \"ALERT\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } }, { \"logDestinationType\": \"S3\", \"logType\": \"FLOW\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } } ], \"overrideExistingConfig\": true } }" To use the distributed deployment model, you must set PolicyOption to NULL. Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration, and route management. "{ \"type\": \"NETWORK_FIREWALL\", \"networkFirewallStatelessRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\", \"priority\": 1 } ], \"networkFirewallStatelessDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessCustomActions\": [ { \"actionName\": \"customActionName\", \"actionDefinition\": { \"publishMetricAction\": { \"dimensions\": [ { \"value\": \"metricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\": { \"singleFirewallEndpointPerVPC\": false, \"allowedIPV4CidrList\": [ \"10.0.0.0/28\", \"192.168.0.0/28\" ], \"routeManagementAction\": \"MONITOR\", \"routeManagementTargetTypes\": [ \"InternetGateway\" ] }, \"networkFirewallLoggingConfiguration\": { \"logDestinationConfigs\": [ { \"logDestinationType\": \"S3\", \"logType\": \"ALERT\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } }, { \"logDestinationType\": \"S3\", \"logType\": \"FLOW\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } } ], \"overrideExistingConfig\": true } }" Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. "{ \"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}], \"networkFirewallStatelessDefaultActions\":[ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\":[ \"aws:forward_to_sfe\", \"fragmentcustomactionname\" ], \"networkFirewallStatelessCustomActions\":[ { \"actionName\":\"customActionName\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"metricdimensionvalue\" } ] } } }, { \"actionName\":\"fragmentcustomactionname\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"fragmentmetricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\":[ { \"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\":{ \"firewallCreationConfig\":{ \"endpointLocation\":{ \"availabilityZoneConfigList\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1b\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] } ] } }, \"singleFirewallEndpointPerVPC\":false, \"allowedIPV4CidrList\":null, \"routeManagementAction\":\"OFF\", \"networkFirewallLoggingConfiguration\":{ \"logDestinationConfigs\":[ { \"logDestinationType\":\"S3\", \"logType\":\"ALERT\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } }, { \"logDestinationType\":\"S3\", \"logType\":\"FLOW\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } } ], \"overrideExistingConfig\":boolean } }" Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration, and route management. "{ \"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}], \"networkFirewallStatelessDefaultActions\":[ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\":[ \"aws:forward_to_sfe\", \"fragmentcustomactionname\" ], \"networkFirewallStatelessCustomActions\":[ { \"actionName\":\"customActionName\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"metricdimensionvalue\" } ] } } }, { \"actionName\":\"fragmentcustomactionname\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"fragmentmetricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\":[ { \"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\":{ \"firewallCreationConfig\":{ \"endpointLocation\":{ \"availabilityZoneConfigList\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1b\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] } ] } }, \"singleFirewallEndpointPerVPC\":false, \"allowedIPV4CidrList\":null, \"routeManagementAction\":\"MONITOR\", \"routeManagementTargetTypes\":[ \"InternetGateway\" ], \"routeManagementConfig\":{ \"allowCrossAZTrafficIfNoEndpoint\":true } }, \"networkFirewallLoggingConfiguration\":{ \"logDestinationConfigs\":[ { \"logDestinationType\":\"S3\", \"logType\":\"ALERT\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } }, { \"logDestinationType\":\"S3\", \"logType\":\"FLOW\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } } ], \"overrideExistingConfig\":boolean } }" Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}" For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}" The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false. For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string. Example: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD. Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}" Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}" Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}" Example: SECURITY_GROUPS_CONTENT_AUDIT "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group. Example: SECURITY_GROUPS_USAGE_AUDIT "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
|
|
1975
|
+
* Details about the service that are specific to the service type, in JSON format. Example: DNS_FIREWALL "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}" Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000. Example: DNS_FIREWALL "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}" Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000. Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. "{ \"type\": \"NETWORK_FIREWALL\", \"networkFirewallStatelessRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\", \"priority\": 1 } ], \"networkFirewallStatelessDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessCustomActions\": [ { \"actionName\": \"customActionName\", \"actionDefinition\": { \"publishMetricAction\": { \"dimensions\": [ { \"value\": \"metricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\": { \"singleFirewallEndpointPerVPC\": false, \"allowedIPV4CidrList\": [ \"10.0.0.0/28\", \"192.168.0.0/28\" ], \"routeManagementAction\": \"OFF\" }, \"networkFirewallLoggingConfiguration\": { \"logDestinationConfigs\": [ { \"logDestinationType\": \"S3\", \"logType\": \"ALERT\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } }, { \"logDestinationType\": \"S3\", \"logType\": \"FLOW\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } } ], \"overrideExistingConfig\": true } }" To use the distributed deployment model, you must set PolicyOption to NULL. Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration, and route management. "{ \"type\": \"NETWORK_FIREWALL\", \"networkFirewallStatelessRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\", \"priority\": 1 } ], \"networkFirewallStatelessDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\": [ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessCustomActions\": [ { \"actionName\": \"customActionName\", \"actionDefinition\": { \"publishMetricAction\": { \"dimensions\": [ { \"value\": \"metricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\": [ { \"resourceARN\": \"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\": { \"singleFirewallEndpointPerVPC\": false, \"allowedIPV4CidrList\": [ \"10.0.0.0/28\", \"192.168.0.0/28\" ], \"routeManagementAction\": \"MONITOR\", \"routeManagementTargetTypes\": [ \"InternetGateway\" ] }, \"networkFirewallLoggingConfiguration\": { \"logDestinationConfigs\": [ { \"logDestinationType\": \"S3\", \"logType\": \"ALERT\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } }, { \"logDestinationType\": \"S3\", \"logType\": \"FLOW\", \"logDestination\": { \"bucketName\": \"s3-bucket-name\" } } ], \"overrideExistingConfig\": true } }" Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. "{ \"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}], \"networkFirewallStatelessDefaultActions\":[ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\":[ \"aws:forward_to_sfe\", \"fragmentcustomactionname\" ], \"networkFirewallStatelessCustomActions\":[ { \"actionName\":\"customActionName\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"metricdimensionvalue\" } ] } } }, { \"actionName\":\"fragmentcustomactionname\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"fragmentmetricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\":[ { \"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\":{ \"firewallCreationConfig\":{ \"endpointLocation\":{ \"availabilityZoneConfigList\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1b\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] } ] } }, \"singleFirewallEndpointPerVPC\":false, \"allowedIPV4CidrList\":null, \"routeManagementAction\":\"OFF\", \"networkFirewallLoggingConfiguration\":{ \"logDestinationConfigs\":[ { \"logDestinationType\":\"S3\", \"logType\":\"ALERT\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } }, { \"logDestinationType\":\"S3\", \"logType\":\"FLOW\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } } ], \"overrideExistingConfig\":boolean } }" Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration, and route management. "{ \"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}], \"networkFirewallStatelessDefaultActions\":[ \"aws:forward_to_sfe\", \"customActionName\" ], \"networkFirewallStatelessFragmentDefaultActions\":[ \"aws:forward_to_sfe\", \"fragmentcustomactionname\" ], \"networkFirewallStatelessCustomActions\":[ { \"actionName\":\"customActionName\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"metricdimensionvalue\" } ] } } }, { \"actionName\":\"fragmentcustomactionname\", \"actionDefinition\":{ \"publishMetricAction\":{ \"dimensions\":[ { \"value\":\"fragmentmetricdimensionvalue\" } ] } } } ], \"networkFirewallStatefulRuleGroupReferences\":[ { \"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\" } ], \"networkFirewallOrchestrationConfig\":{ \"firewallCreationConfig\":{ \"endpointLocation\":{ \"availabilityZoneConfigList\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1b\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] } ] } }, \"singleFirewallEndpointPerVPC\":false, \"allowedIPV4CidrList\":null, \"routeManagementAction\":\"MONITOR\", \"routeManagementTargetTypes\":[ \"InternetGateway\" ], \"routeManagementConfig\":{ \"allowCrossAZTrafficIfNoEndpoint\":true } }, \"networkFirewallLoggingConfiguration\":{ \"logDestinationConfigs\":[ { \"logDestinationType\":\"S3\", \"logType\":\"ALERT\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } }, { \"logDestinationType\":\"S3\", \"logType\":\"FLOW\", \"logDestination\":{ \"bucketName\":\"s3-bucket-name\" } } ], \"overrideExistingConfig\":boolean } }" Example: PARTNER_FIREWALL for Firewall Manager "{\"type\":\"THIRD_PARTY_FIREWALL\",\"thirdPartyrFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\",\"thirdPartyFirewallConfig\":{\"thirdPartyFirewallPolicyList\":[\"global-123456789012-1\"],\"networkFirewallLoggingConfiguration\":null},\"firewallDeploymentModel\":{\"distributedFirewallDeploymentModel\":{\"distributedFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.1.0/28\"]}]}},\"allowedIPV4CidrList\":null},\"distributedRouteManagementConfig\":null},\"centralizedFirewallDeploymentModel\":null}}"" Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}" For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}" The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false. For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string. Example: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD. Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}" Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group. Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}" Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}" Example: SECURITY_GROUPS_CONTENT_AUDIT "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group. Example: SECURITY_GROUPS_USAGE_AUDIT "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
|
|
1839
1976
|
*/
|
|
1840
1977
|
ManagedServiceData?: ManagedServiceData;
|
|
1841
1978
|
/**
|
|
@@ -1843,7 +1980,7 @@ declare namespace FMS {
|
|
|
1843
1980
|
*/
|
|
1844
1981
|
PolicyOption?: PolicyOption;
|
|
1845
1982
|
}
|
|
1846
|
-
export type SecurityServiceType = "WAF"|"WAFV2"|"SHIELD_ADVANCED"|"SECURITY_GROUPS_COMMON"|"SECURITY_GROUPS_CONTENT_AUDIT"|"SECURITY_GROUPS_USAGE_AUDIT"|"NETWORK_FIREWALL"|"DNS_FIREWALL"|string;
|
|
1983
|
+
export type SecurityServiceType = "WAF"|"WAFV2"|"SHIELD_ADVANCED"|"SECURITY_GROUPS_COMMON"|"SECURITY_GROUPS_CONTENT_AUDIT"|"SECURITY_GROUPS_USAGE_AUDIT"|"NETWORK_FIREWALL"|"DNS_FIREWALL"|"THIRD_PARTY_FIREWALL"|string;
|
|
1847
1984
|
export interface StatefulRuleGroup {
|
|
1848
1985
|
/**
|
|
1849
1986
|
* The name of the rule group.
|
|
@@ -1900,6 +2037,83 @@ declare namespace FMS {
|
|
|
1900
2037
|
export type TargetType = "GATEWAY"|"CARRIER_GATEWAY"|"INSTANCE"|"LOCAL_GATEWAY"|"NAT_GATEWAY"|"NETWORK_INTERFACE"|"VPC_ENDPOINT"|"VPC_PEERING_CONNECTION"|"EGRESS_ONLY_INTERNET_GATEWAY"|"TRANSIT_GATEWAY"|string;
|
|
1901
2038
|
export type TargetViolationReason = string;
|
|
1902
2039
|
export type TargetViolationReasons = TargetViolationReason[];
|
|
2040
|
+
export type ThirdPartyFirewall = "PALO_ALTO_NETWORKS_CLOUD_NGFW"|string;
|
|
2041
|
+
export type ThirdPartyFirewallAssociationStatus = "ONBOARDING"|"ONBOARD_COMPLETE"|"OFFBOARDING"|"OFFBOARD_COMPLETE"|"NOT_EXIST"|string;
|
|
2042
|
+
export type ThirdPartyFirewallFirewallPolicies = ThirdPartyFirewallFirewallPolicy[];
|
|
2043
|
+
export interface ThirdPartyFirewallFirewallPolicy {
|
|
2044
|
+
/**
|
|
2045
|
+
* The ID of the specified firewall policy.
|
|
2046
|
+
*/
|
|
2047
|
+
FirewallPolicyId?: FirewallPolicyId;
|
|
2048
|
+
/**
|
|
2049
|
+
* The name of the specified firewall policy.
|
|
2050
|
+
*/
|
|
2051
|
+
FirewallPolicyName?: FirewallPolicyName;
|
|
2052
|
+
}
|
|
2053
|
+
export interface ThirdPartyFirewallMissingExpectedRouteTableViolation {
|
|
2054
|
+
/**
|
|
2055
|
+
* The ID of the third-party firewall or VPC resource that's causing the violation.
|
|
2056
|
+
*/
|
|
2057
|
+
ViolationTarget?: ViolationTarget;
|
|
2058
|
+
/**
|
|
2059
|
+
* The resource ID of the VPC associated with a fireawll subnet that's causing the violation.
|
|
2060
|
+
*/
|
|
2061
|
+
VPC?: ResourceId;
|
|
2062
|
+
/**
|
|
2063
|
+
* The Availability Zone of the firewall subnet that's causing the violation.
|
|
2064
|
+
*/
|
|
2065
|
+
AvailabilityZone?: LengthBoundedString;
|
|
2066
|
+
/**
|
|
2067
|
+
* The resource ID of the current route table that's associated with the subnet, if one is available.
|
|
2068
|
+
*/
|
|
2069
|
+
CurrentRouteTable?: ResourceId;
|
|
2070
|
+
/**
|
|
2071
|
+
* The resource ID of the route table that should be associated with the subnet.
|
|
2072
|
+
*/
|
|
2073
|
+
ExpectedRouteTable?: ResourceId;
|
|
2074
|
+
}
|
|
2075
|
+
export interface ThirdPartyFirewallMissingFirewallViolation {
|
|
2076
|
+
/**
|
|
2077
|
+
* The ID of the third-party firewall that's causing the violation.
|
|
2078
|
+
*/
|
|
2079
|
+
ViolationTarget?: ViolationTarget;
|
|
2080
|
+
/**
|
|
2081
|
+
* The resource ID of the VPC associated with a third-party firewall.
|
|
2082
|
+
*/
|
|
2083
|
+
VPC?: ResourceId;
|
|
2084
|
+
/**
|
|
2085
|
+
* The Availability Zone of the third-party firewall that's causing the violation.
|
|
2086
|
+
*/
|
|
2087
|
+
AvailabilityZone?: LengthBoundedString;
|
|
2088
|
+
/**
|
|
2089
|
+
* The reason the resource is causing this violation, if a reason is available.
|
|
2090
|
+
*/
|
|
2091
|
+
TargetViolationReason?: TargetViolationReason;
|
|
2092
|
+
}
|
|
2093
|
+
export interface ThirdPartyFirewallMissingSubnetViolation {
|
|
2094
|
+
/**
|
|
2095
|
+
* The ID of the third-party firewall or VPC resource that's causing the violation.
|
|
2096
|
+
*/
|
|
2097
|
+
ViolationTarget?: ViolationTarget;
|
|
2098
|
+
/**
|
|
2099
|
+
* The resource ID of the VPC associated with a subnet that's causing the violation.
|
|
2100
|
+
*/
|
|
2101
|
+
VPC?: ResourceId;
|
|
2102
|
+
/**
|
|
2103
|
+
* The Availability Zone of a subnet that's causing the violation.
|
|
2104
|
+
*/
|
|
2105
|
+
AvailabilityZone?: LengthBoundedString;
|
|
2106
|
+
/**
|
|
2107
|
+
* The reason the resource is causing the violation, if a reason is available.
|
|
2108
|
+
*/
|
|
2109
|
+
TargetViolationReason?: TargetViolationReason;
|
|
2110
|
+
}
|
|
2111
|
+
export interface ThirdPartyFirewallPolicy {
|
|
2112
|
+
/**
|
|
2113
|
+
* Defines the deployment model to use for the third-party firewall.
|
|
2114
|
+
*/
|
|
2115
|
+
FirewallDeploymentModel?: FirewallDeploymentModel;
|
|
2116
|
+
}
|
|
1903
2117
|
export type TimeStamp = Date;
|
|
1904
2118
|
export interface UntagResourceRequest {
|
|
1905
2119
|
/**
|
|
@@ -1936,7 +2150,7 @@ declare namespace FMS {
|
|
|
1936
2150
|
*/
|
|
1937
2151
|
ResourceViolations: ResourceViolations;
|
|
1938
2152
|
/**
|
|
1939
|
-
* The ResourceTag objects associated with the resource.
|
|
2153
|
+
* The ResourceTag objects associated with the resource.
|
|
1940
2154
|
*/
|
|
1941
2155
|
ResourceTags?: TagList;
|
|
1942
2156
|
/**
|
|
@@ -1944,7 +2158,7 @@ declare namespace FMS {
|
|
|
1944
2158
|
*/
|
|
1945
2159
|
ResourceDescription?: LengthBoundedString;
|
|
1946
2160
|
}
|
|
1947
|
-
export type ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"|"RESOURCE_MISSING_WEB_ACL"|"RESOURCE_INCORRECT_WEB_ACL"|"RESOURCE_MISSING_SHIELD_PROTECTION"|"RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION"|"RESOURCE_MISSING_SECURITY_GROUP"|"RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP"|"SECURITY_GROUP_UNUSED"|"SECURITY_GROUP_REDUNDANT"|"FMS_CREATED_SECURITY_GROUP_EDITED"|"MISSING_FIREWALL"|"MISSING_FIREWALL_SUBNET_IN_AZ"|"MISSING_EXPECTED_ROUTE_TABLE"|"NETWORK_FIREWALL_POLICY_MODIFIED"|"INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE"|"FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE"|"UNEXPECTED_FIREWALL_ROUTES"|"UNEXPECTED_TARGET_GATEWAY_ROUTES"|"TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY"|"INVALID_ROUTE_CONFIGURATION"|"MISSING_TARGET_GATEWAY"|"INTERNET_TRAFFIC_NOT_INSPECTED"|"BLACK_HOLE_ROUTE_DETECTED"|"BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET"|"RESOURCE_MISSING_DNS_FIREWALL"|"
|
|
2161
|
+
export type ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"|"RESOURCE_MISSING_WEB_ACL"|"RESOURCE_INCORRECT_WEB_ACL"|"RESOURCE_MISSING_SHIELD_PROTECTION"|"RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION"|"RESOURCE_MISSING_SECURITY_GROUP"|"RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP"|"SECURITY_GROUP_UNUSED"|"SECURITY_GROUP_REDUNDANT"|"FMS_CREATED_SECURITY_GROUP_EDITED"|"MISSING_FIREWALL"|"MISSING_FIREWALL_SUBNET_IN_AZ"|"MISSING_EXPECTED_ROUTE_TABLE"|"NETWORK_FIREWALL_POLICY_MODIFIED"|"FIREWALL_SUBNET_IS_OUT_OF_SCOPE"|"INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE"|"FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE"|"UNEXPECTED_FIREWALL_ROUTES"|"UNEXPECTED_TARGET_GATEWAY_ROUTES"|"TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY"|"INVALID_ROUTE_CONFIGURATION"|"MISSING_TARGET_GATEWAY"|"INTERNET_TRAFFIC_NOT_INSPECTED"|"BLACK_HOLE_ROUTE_DETECTED"|"BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET"|"RESOURCE_MISSING_DNS_FIREWALL"|"ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT"|"FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT"|string;
|
|
1948
2162
|
export type ViolationTarget = string;
|
|
1949
2163
|
/**
|
|
1950
2164
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
package/clients/fsx.d.ts
CHANGED
|
@@ -60,11 +60,11 @@ declare class FSx extends Service {
|
|
|
60
60
|
*/
|
|
61
61
|
createDataRepositoryTask(callback?: (err: AWSError, data: FSx.Types.CreateDataRepositoryTaskResponse) => void): Request<FSx.Types.CreateDataRepositoryTaskResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport-level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
|
|
63
|
+
* Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system in JSON format. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport-level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
|
|
64
64
|
*/
|
|
65
65
|
createFileSystem(params: FSx.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request<FSx.Types.CreateFileSystemResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport-level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
|
|
67
|
+
* Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system in JSON format. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport-level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
|
|
68
68
|
*/
|
|
69
69
|
createFileSystem(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request<FSx.Types.CreateFileSystemResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -276,11 +276,11 @@ declare class FSx extends Service {
|
|
|
276
276
|
*/
|
|
277
277
|
updateDataRepositoryAssociation(callback?: (err: AWSError, data: FSx.Types.UpdateDataRepositoryAssociationResponse) => void): Request<FSx.Types.UpdateDataRepositoryAssociationResponse, AWSError>;
|
|
278
278
|
/**
|
|
279
|
-
* Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword StorageCapacity WeeklyMaintenanceStartTime For the Amazon FSx for OpenZFS file systems, you can update the following properties: AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime ThroughputCapacity WeeklyMaintenanceStartTime
|
|
279
|
+
* Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For the Amazon FSx for OpenZFS file systems, you can update the following properties: AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime ThroughputCapacity WeeklyMaintenanceStartTime
|
|
280
280
|
*/
|
|
281
281
|
updateFileSystem(params: FSx.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>;
|
|
282
282
|
/**
|
|
283
|
-
* Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword StorageCapacity WeeklyMaintenanceStartTime For the Amazon FSx for OpenZFS file systems, you can update the following properties: AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime ThroughputCapacity WeeklyMaintenanceStartTime
|
|
283
|
+
* Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For the Amazon FSx for OpenZFS file systems, you can update the following properties: AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime ThroughputCapacity WeeklyMaintenanceStartTime
|
|
284
284
|
*/
|
|
285
285
|
updateFileSystem(callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>;
|
|
286
286
|
/**
|
|
@@ -1637,11 +1637,11 @@ declare namespace FSx {
|
|
|
1637
1637
|
*/
|
|
1638
1638
|
DNSName?: DNSName;
|
|
1639
1639
|
/**
|
|
1640
|
-
* The ID of the Key Management Service (KMS) key used to encrypt
|
|
1640
|
+
* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account. Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server
|
|
1641
1641
|
*/
|
|
1642
1642
|
KmsKeyId?: KmsKeyId;
|
|
1643
1643
|
/**
|
|
1644
|
-
* The Amazon Resource Name (ARN)
|
|
1644
|
+
* The Amazon Resource Name (ARN) of the file system resource.
|
|
1645
1645
|
*/
|
|
1646
1646
|
ResourceARN?: ResourceARN;
|
|
1647
1647
|
/**
|
|
@@ -1649,7 +1649,7 @@ declare namespace FSx {
|
|
|
1649
1649
|
*/
|
|
1650
1650
|
Tags?: Tags;
|
|
1651
1651
|
/**
|
|
1652
|
-
* The configuration for this FSx for Windows File Server file system.
|
|
1652
|
+
* The configuration for this Amazon FSx for Windows File Server file system.
|
|
1653
1653
|
*/
|
|
1654
1654
|
WindowsConfiguration?: WindowsFileSystemConfiguration;
|
|
1655
1655
|
LustreConfiguration?: LustreFileSystemConfiguration;
|
|
@@ -1658,7 +1658,7 @@ declare namespace FSx {
|
|
|
1658
1658
|
*/
|
|
1659
1659
|
AdministrativeActions?: AdministrativeActions;
|
|
1660
1660
|
/**
|
|
1661
|
-
* The configuration for this FSx for ONTAP file system.
|
|
1661
|
+
* The configuration for this Amazon FSx for NetApp ONTAP file system.
|
|
1662
1662
|
*/
|
|
1663
1663
|
OntapConfiguration?: OntapFileSystemConfiguration;
|
|
1664
1664
|
/**
|
|
@@ -2416,6 +2416,10 @@ declare namespace FSx {
|
|
|
2416
2416
|
* The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned.
|
|
2417
2417
|
*/
|
|
2418
2418
|
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
2419
|
+
/**
|
|
2420
|
+
* Specifies the throughput of an FSx for NetApp ONTAP file system, measured in megabytes per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
|
|
2421
|
+
*/
|
|
2422
|
+
ThroughputCapacity?: MegabytesPerSecond;
|
|
2419
2423
|
}
|
|
2420
2424
|
export interface UpdateFileSystemOpenZFSConfiguration {
|
|
2421
2425
|
AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays;
|