Skip to content

Commit 4f544d7

Browse files
author
awstools
committed
docs(client-fms): The policy scope resource tag is always a string value, either a non-empty string or an empty string.
1 parent 0189ee3 commit 4f544d7

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

clients/client-fms/src/commands/PutPolicyCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea
7070
* </li>
7171
* <li>
7272
* <p>
73-
* <b>Third-party firewall policy</b> - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at <a href="https://aws.amazon.com/marketplace">Amazon Web Services Marketplace</a>.</p>
73+
* <b>Third-party firewall policy</b> - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at <a href="http://aws.amazon.com/marketplace">Amazon Web Services Marketplace</a>.</p>
7474
* <ul>
7575
* <li>
7676
* <p>

clients/client-fms/src/models/models_0.ts

+8-4
Original file line numberDiff line numberDiff line change
@@ -1151,6 +1151,10 @@ export type CustomerPolicyStatus = (typeof CustomerPolicyStatus)[keyof typeof Cu
11511151
* tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have
11521152
* all the specified tags to be included or excluded. For more information, see
11531153
* <a href="https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html">Working with Tag Editor</a>.</p>
1154+
* <p>Every resource tag must have a string value, either a non-empty string or an empty string. If you don't
1155+
* provide a value for a resource tag, Firewall Manager saves the value as an empty string: "". When Firewall Manager compares tags, it only
1156+
* matches two tags if they have the same key and the same value. A tag with an empty string value only
1157+
* matches with tags that also have an empty string value. </p>
11541158
* @public
11551159
*/
11561160
export interface ResourceTag {
@@ -1161,7 +1165,7 @@ export interface ResourceTag {
11611165
Key: string | undefined;
11621166

11631167
/**
1164-
* <p>The resource tag value.</p>
1168+
* <p>The resource tag value. To specify an empty string value, either don't provide this or specify it as "". </p>
11651169
* @public
11661170
*/
11671171
Value?: string;
@@ -1293,7 +1297,7 @@ export interface NetworkAclEntrySet {
12931297
* violations that involve conflicts between the custom entries and the policy entries. </p>
12941298
* <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to
12951299
* remediate. For more information about the remediation behavior, see
1296-
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html">Network access control list (ACL) policies</a>
1300+
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation">Remediation for managed network ACLs</a>
12971301
* in the <i>Firewall Manager Developer Guide</i>.</p>
12981302
* @public
12991303
*/
@@ -1315,7 +1319,7 @@ export interface NetworkAclEntrySet {
13151319
* violations that involve conflicts between the custom entries and the policy entries. </p>
13161320
* <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to
13171321
* remediate. For more information about the remediation behavior, see
1318-
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html">Network access control list (ACL) policies</a>
1322+
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation">Remediation for managed network ACLs</a>
13191323
* in the <i>Firewall Manager Developer Guide</i>.</p>
13201324
* @public
13211325
*/
@@ -1857,7 +1861,7 @@ export interface Policy {
18571861
ResourceSetIds?: string[];
18581862

18591863
/**
1860-
* <p>The definition of the Network Firewall firewall policy.</p>
1864+
* <p>Your description of the Firewall Manager policy.</p>
18611865
* @public
18621866
*/
18631867
PolicyDescription?: string;

codegen/sdk-codegen/aws-models/fms.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -5275,7 +5275,7 @@
52755275
"ForceRemediateForFirstEntries": {
52765276
"target": "com.amazonaws.fms#BooleanObject",
52775277
"traits": {
5278-
"smithy.api#documentation": "<p>Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries. </p>\n <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n<a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html\">Network access control list (ACL) policies</a> \n in the <i>Firewall Manager Developer Guide</i>.</p>",
5278+
"smithy.api#documentation": "<p>Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries. </p>\n <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n<a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation\">Remediation for managed network ACLs</a> \n in the <i>Firewall Manager Developer Guide</i>.</p>",
52795279
"smithy.api#required": {}
52805280
}
52815281
},
@@ -5288,7 +5288,7 @@
52885288
"ForceRemediateForLastEntries": {
52895289
"target": "com.amazonaws.fms#BooleanObject",
52905290
"traits": {
5291-
"smithy.api#documentation": "<p>Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries. </p>\n <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n<a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html\">Network access control list (ACL) policies</a> \n in the <i>Firewall Manager Developer Guide</i>.</p>",
5291+
"smithy.api#documentation": "<p>Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries. </p>\n <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n<a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation\">Remediation for managed network ACLs</a> \n in the <i>Firewall Manager Developer Guide</i>.</p>",
52925292
"smithy.api#required": {}
52935293
}
52945294
}
@@ -6145,7 +6145,7 @@
61456145
"PolicyDescription": {
61466146
"target": "com.amazonaws.fms#ResourceDescription",
61476147
"traits": {
6148-
"smithy.api#documentation": "<p>The definition of the Network Firewall firewall policy.</p>"
6148+
"smithy.api#documentation": "<p>Your description of the Firewall Manager policy.</p>"
61496149
}
61506150
},
61516151
"PolicyStatus": {
@@ -6799,7 +6799,7 @@
67996799
}
68006800
],
68016801
"traits": {
6802-
"smithy.api#documentation": "<p>Creates an Firewall Manager policy.</p>\n <p>A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type. </p>\n <p>If you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy. </p>\n <p>Firewall Manager provides the following types of policies: </p>\n <ul>\n <li>\n <p>\n <b>WAF policy</b> - This policy applies WAF web ACL\n\t\t\t\tprotections to specified accounts and resources. </p>\n </li>\n <li>\n <p>\n <b>Shield Advanced policy</b> - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources. </p>\n </li>\n <li>\n <p>\n <b>Security Groups policy</b> - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization. </p>\n </li>\n <li>\n <p>\n <b>Network ACL policy</b> - This type of policy gives you\n\t\t\t\tcontrol over the network ACLs that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of first and last network ACL rules across your organization. </p>\n </li>\n <li>\n <p>\n <b>Network Firewall policy</b> - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs. </p>\n </li>\n <li>\n <p>\n <b>DNS Firewall policy</b> - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs. </p>\n </li>\n <li>\n <p>\n <b>Third-party firewall policy</b> - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at <a href=\"https://aws.amazon.com/marketplace\">Amazon Web Services Marketplace</a>.</p>\n <ul>\n <li>\n <p>\n <b>Palo Alto Networks Cloud NGFW policy</b> - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.</p>\n </li>\n <li>\n <p>\n <b>Fortigate CNF policy</b> - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.</p>\n </li>\n </ul>\n </li>\n </ul>"
6802+
"smithy.api#documentation": "<p>Creates an Firewall Manager policy.</p>\n <p>A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\n\t\tpolicy types across accounts, you can create multiple policies. You can create more than one\n\t\tpolicy for each type. </p>\n <p>If you add a new account to an organization that you created with Organizations, Firewall Manager\n\t\tautomatically applies the policy to the resources in that account that are within scope of\n\t\tthe policy. </p>\n <p>Firewall Manager provides the following types of policies: </p>\n <ul>\n <li>\n <p>\n <b>WAF policy</b> - This policy applies WAF web ACL\n\t\t\t\tprotections to specified accounts and resources. </p>\n </li>\n <li>\n <p>\n <b>Shield Advanced policy</b> - This policy applies Shield Advanced\n\t\t\t\tprotection to specified accounts and resources. </p>\n </li>\n <li>\n <p>\n <b>Security Groups policy</b> - This type of policy gives you\n\t\t\t\tcontrol over security groups that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of rules across your organization. </p>\n </li>\n <li>\n <p>\n <b>Network ACL policy</b> - This type of policy gives you\n\t\t\t\tcontrol over the network ACLs that are in use throughout your organization in\n\t\t\t\tOrganizations and lets you enforce a baseline set of first and last network ACL rules across your organization. </p>\n </li>\n <li>\n <p>\n <b>Network Firewall policy</b> - This policy applies\n\t\t\t\tNetwork Firewall protection to your organization's VPCs. </p>\n </li>\n <li>\n <p>\n <b>DNS Firewall policy</b> - This policy applies\n\t\t\t\tAmazon Route 53 Resolver DNS Firewall protections to your organization's VPCs. </p>\n </li>\n <li>\n <p>\n <b>Third-party firewall policy</b> - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at <a href=\"http://aws.amazon.com/marketplace\">Amazon Web Services Marketplace</a>.</p>\n <ul>\n <li>\n <p>\n <b>Palo Alto Networks Cloud NGFW policy</b> - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.</p>\n </li>\n <li>\n <p>\n <b>Fortigate CNF policy</b> - This policy applies\n\t\t\t\t\t\tFortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.</p>\n </li>\n </ul>\n </li>\n </ul>"
68036803
}
68046804
},
68056805
"com.amazonaws.fms#PutPolicyRequest": {
@@ -7396,12 +7396,12 @@
73967396
"Value": {
73977397
"target": "com.amazonaws.fms#ResourceTagValue",
73987398
"traits": {
7399-
"smithy.api#documentation": "<p>The resource tag value.</p>"
7399+
"smithy.api#documentation": "<p>The resource tag value. To specify an empty string value, either don't provide this or specify it as \"\". </p>"
74007400
}
74017401
}
74027402
},
74037403
"traits": {
7404-
"smithy.api#documentation": "<p>The resource tags that Firewall Manager uses to determine if a particular resource\n should be included or excluded from the Firewall Manager policy. Tags enable you to\n categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see\n <a href=\"https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html\">Working with Tag Editor</a>.</p>"
7404+
"smithy.api#documentation": "<p>The resource tags that Firewall Manager uses to determine if a particular resource\n should be included or excluded from the Firewall Manager policy. Tags enable you to\n categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see\n <a href=\"https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html\">Working with Tag Editor</a>.</p>\n <p>Every resource tag must have a string value, either a non-empty string or an empty string. If you don't \n provide a value for a resource tag, Firewall Manager saves the value as an empty string: \"\". When Firewall Manager compares tags, it only \n matches two tags if they have the same key and the same value. A tag with an empty string value only \n matches with tags that also have an empty string value. </p>"
74057405
}
74067406
},
74077407
"com.amazonaws.fms#ResourceTagKey": {

0 commit comments

Comments
 (0)