Skip to content

Commit

Permalink
docs(client-fms): The policy scope resource tag is always a string va…
Browse files Browse the repository at this point in the history
…lue, either a non-empty string or an empty string.
  • Loading branch information
awstools committed May 8, 2024
1 parent 0189ee3 commit 4f544d7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
2 changes: 1 addition & 1 deletion clients/client-fms/src/commands/PutPolicyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea
* </li>
* <li>
* <p>
* <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>
* <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>
* <ul>
* <li>
* <p>
Expand Down
12 changes: 8 additions & 4 deletions clients/client-fms/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1151,6 +1151,10 @@ export type CustomerPolicyStatus = (typeof CustomerPolicyStatus)[keyof typeof Cu
* tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have
* all the specified tags to be included or excluded. For more information, see
* <a href="https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html">Working with Tag Editor</a>.</p>
* <p>Every resource tag must have a string value, either a non-empty string or an empty string. If you don't
* provide a value for a resource tag, Firewall Manager saves the value as an empty string: "". When Firewall Manager compares tags, it only
* matches two tags if they have the same key and the same value. A tag with an empty string value only
* matches with tags that also have an empty string value. </p>
* @public
*/
export interface ResourceTag {
Expand All @@ -1161,7 +1165,7 @@ export interface ResourceTag {
Key: string | undefined;

/**
* <p>The resource tag value.</p>
* <p>The resource tag value. To specify an empty string value, either don't provide this or specify it as "". </p>
* @public
*/
Value?: string;
Expand Down Expand Up @@ -1293,7 +1297,7 @@ export interface NetworkAclEntrySet {
* violations that involve conflicts between the custom entries and the policy entries. </p>
* <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to
* remediate. For more information about the remediation behavior, see
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html">Network access control list (ACL) policies</a>
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation">Remediation for managed network ACLs</a>
* in the <i>Firewall Manager Developer Guide</i>.</p>
* @public
*/
Expand All @@ -1315,7 +1319,7 @@ export interface NetworkAclEntrySet {
* violations that involve conflicts between the custom entries and the policy entries. </p>
* <p>If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to
* remediate. For more information about the remediation behavior, see
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html">Network access control list (ACL) policies</a>
* <a href="https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation">Remediation for managed network ACLs</a>
* in the <i>Firewall Manager Developer Guide</i>.</p>
* @public
*/
Expand Down Expand Up @@ -1857,7 +1861,7 @@ export interface Policy {
ResourceSetIds?: string[];

/**
* <p>The definition of the Network Firewall firewall policy.</p>
* <p>Your description of the Firewall Manager policy.</p>
* @public
*/
PolicyDescription?: string;
Expand Down
12 changes: 6 additions & 6 deletions codegen/sdk-codegen/aws-models/fms.json
Original file line number Diff line number Diff line change
Expand Up @@ -5275,7 +5275,7 @@
"ForceRemediateForFirstEntries": {
"target": "com.amazonaws.fms#BooleanObject",
"traits": {
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand All @@ -5288,7 +5288,7 @@
"ForceRemediateForLastEntries": {
"target": "com.amazonaws.fms#BooleanObject",
"traits": {
"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>",
"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>",
"smithy.api#required": {}
}
}
Expand Down Expand Up @@ -6145,7 +6145,7 @@
"PolicyDescription": {
"target": "com.amazonaws.fms#ResourceDescription",
"traits": {
"smithy.api#documentation": "<p>The definition of the Network Firewall firewall policy.</p>"
"smithy.api#documentation": "<p>Your description of the Firewall Manager policy.</p>"
}
},
"PolicyStatus": {
Expand Down Expand Up @@ -6799,7 +6799,7 @@
}
],
"traits": {
"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>"
"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>"
}
},
"com.amazonaws.fms#PutPolicyRequest": {
Expand Down Expand Up @@ -7396,12 +7396,12 @@
"Value": {
"target": "com.amazonaws.fms#ResourceTagValue",
"traits": {
"smithy.api#documentation": "<p>The resource tag value.</p>"
"smithy.api#documentation": "<p>The resource tag value. To specify an empty string value, either don't provide this or specify it as \"\". </p>"
}
}
},
"traits": {
"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>"
"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>"
}
},
"com.amazonaws.fms#ResourceTagKey": {
Expand Down

0 comments on commit 4f544d7

Please sign in to comment.