Skip to content

Commit

Permalink
docs(client-securityhub): Documentation updates for AWS Security Hub
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Feb 21, 2023
1 parent 3365917 commit 17690f3
Show file tree
Hide file tree
Showing 7 changed files with 597 additions and 544 deletions.
8 changes: 4 additions & 4 deletions clients/client-securityhub/src/SecurityHub.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1512,17 +1512,17 @@ export class SecurityHub extends SecurityHubClient {
* <p>When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings
* from other services that are integrated with Security Hub.</p>
* <p>When you use the <code>EnableSecurityHub</code> operation to enable Security Hub, you also
* automatically enable the following standards.</p>
* automatically enable the following standards:</p>
* <ul>
* <li>
* <p>CIS Amazon Web Services Foundations</p>
* <p>Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0</p>
* </li>
* <li>
* <p>Amazon Web Services Foundational Security Best Practices</p>
* </li>
* </ul>
* <p>You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. </p>
* <p>To not enable the automatically enabled standards, set
* <p>Other standards are not automatically enabled. </p>
* <p>To opt out of automatically enabled standards, set
* <code>EnableDefaultStandards</code> to <code>false</code>.</p>
* <p>After you enable Security Hub, to enable a standard, use the <code>BatchEnableStandards</code> operation. To disable a standard, use the
* <code>BatchDisableStandards</code> operation.</p>
Expand Down
8 changes: 4 additions & 4 deletions clients/client-securityhub/src/commands/EnableSecurityHubCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ export interface EnableSecurityHubCommandOutput extends EnableSecurityHubRespons
* <p>When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings
* from other services that are integrated with Security Hub.</p>
* <p>When you use the <code>EnableSecurityHub</code> operation to enable Security Hub, you also
* automatically enable the following standards.</p>
* automatically enable the following standards:</p>
* <ul>
* <li>
* <p>CIS Amazon Web Services Foundations</p>
* <p>Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0</p>
* </li>
* <li>
* <p>Amazon Web Services Foundational Security Best Practices</p>
* </li>
* </ul>
* <p>You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. </p>
* <p>To not enable the automatically enabled standards, set
* <p>Other standards are not automatically enabled. </p>
* <p>To opt out of automatically enabled standards, set
* <code>EnableDefaultStandards</code> to <code>false</code>.</p>
* <p>After you enable Security Hub, to enable a standard, use the <code>BatchEnableStandards</code> operation. To disable a standard, use the
* <code>BatchDisableStandards</code> operation.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-securityhub/src/endpoint/EndpointParameters.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
};

export interface EndpointParameters extends __EndpointParameters {
Region: string;
Region?: string;
UseDualStack?: boolean;
UseFIPS?: boolean;
Endpoint?: string;
Expand Down
39 changes: 20 additions & 19 deletions clients/client-securityhub/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/securityhub.json */

const q="fn",
r="argv",
s="ref";
const a=true,
b=false,
c="String",
d="PartitionResult",
e="tree",
f="error",
g="endpoint",
h={"required":true,"default":false,"type":"Boolean"},
i={[s]:"Endpoint"},
j={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
k={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
l={},
m={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsFIPS"]}]},
n={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsDualStack"]}]},
const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e="PartitionResult",
f={[q]:false,"type":"String"},
g={[q]:true,"default":false,"type":"Boolean"},
h={[t]:"Endpoint"},
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
k={},
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
n=[i],
o=[j],
p=[k];
const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:h,UseFIPS:h,Endpoint:{required:b,type:c}},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[q]:"isSet",[r]:[i]}],type:e,rules:[{conditions:o,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:p,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:i,properties:l,headers:l},type:g}]}]},{conditions:[j,k],type:e,rules:[{conditions:[m,n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://securityhub-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:o,type:e,rules:[{conditions:[m],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://securityhub-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:p,type:e,rules:[{conditions:[n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://securityhub.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{type:e,rules:[{endpoint:{url:"https://securityhub.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]}]};
p=[{[t]:"Region"}];
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://securityhub-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://securityhub-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://securityhub.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://securityhub.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
export const ruleSet: RuleSetObject = _data;
Loading

0 comments on commit 17690f3

Please sign in to comment.