Chilkat Online Tools

DescribeRuleGroup Node.js Example

AWS Network Firewall

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node17-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node17-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node17-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node17-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node17-linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('@chilkat/ck-node17-macosx');
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();
    var success;

    var authAws = new chilkat.AuthAws();
    authAws.AccessKey = "AWS_ACCESS_KEY";
    authAws.SecretKey = "AWS_SECRET_KEY";

    // Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
    authAws.Region = "us-west-2";
    authAws.ServiceName = "network-firewall";
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    rest.SetAuthAws(authAws);

    // URL: https://network-firewall.us-west-2.amazonaws.com/
    // Use the same region as specified above.
    success = rest.Connect("network-firewall.us-west-2.amazonaws.com",443,true,true);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    // The following code creates the JSON request body.
    // The JSON created by this code is shown below.

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    var json = new chilkat.JsonObject();
    json.UpdateString("RuleGroupArn","string");
    json.UpdateString("RuleGroupName","string");
    json.UpdateString("Type","string");

    // The JSON request body created by the above code:

    // {
    //   "RuleGroupArn": "string",
    //   "RuleGroupName": "string",
    //   "Type": "string"
    // }

    rest.AddHeader("Content-Type","application/x-amz-json-1.0");
    rest.AddHeader("X-Amz-Target","NetworkFirewall_20201112.DescribeRuleGroup");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    console.log("response status code = " + respStatusCode);
    if (respStatusCode !== 200) {
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);

    // The following code parses the JSON response.
    // A sample JSON response is shown below the sample code.

    // Use this online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    var strVal;
    var Action;
    var Destination;
    var DestinationPort;
    var Direction;
    var Protocol;
    var Source;
    var SourcePort;
    var j;
    var count_j;
    var Keyword;
    var k;
    var count_k;
    var ActionName;
    var Value;
    var Priority;
    var FromPort;
    var ToPort;
    var AddressDefinition;
    var intVal;
    var Key;

    var GeneratedRulesType = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType");
    var RulesString = jResp.StringOf("RuleGroup.RulesSource.RulesString");
    var RuleOrder = jResp.StringOf("RuleGroup.StatefulRuleOptions.RuleOrder");
    var Capacity = jResp.IntOf("RuleGroupResponse.Capacity");
    var ConsumedCapacity = jResp.IntOf("RuleGroupResponse.ConsumedCapacity");
    var Description = jResp.StringOf("RuleGroupResponse.Description");
    var KeyId = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.KeyId");
    var v_Type = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.Type");
    var LastModifiedTime = jResp.IntOf("RuleGroupResponse.LastModifiedTime");
    var NumberOfAssociations = jResp.IntOf("RuleGroupResponse.NumberOfAssociations");
    var RuleGroupArn = jResp.StringOf("RuleGroupResponse.RuleGroupArn");
    var RuleGroupId = jResp.StringOf("RuleGroupResponse.RuleGroupId");
    var RuleGroupName = jResp.StringOf("RuleGroupResponse.RuleGroupName");
    var RuleGroupStatus = jResp.StringOf("RuleGroupResponse.RuleGroupStatus");
    var SnsTopic = jResp.StringOf("RuleGroupResponse.SnsTopic");
    var SourceArn = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceArn");
    var SourceUpdateToken = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken");
    var RuleGroupResponseType = jResp.StringOf("RuleGroupResponse.Type");
    var UpdateToken = jResp.StringOf("UpdateToken");
    var i = 0;
    var count_i = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.Targets");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.Targets[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.TargetTypes");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.TargetTypes[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules");
    while (i < count_i) {
        jResp.I = i;
        Action = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Action");
        Destination = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Destination");
        DestinationPort = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.DestinationPort");
        Direction = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Direction");
        Protocol = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Protocol");
        Source = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Source");
        SourcePort = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.SourcePort");
        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules[i].RuleOptions");
        while (j < count_j) {
            jResp.J = j;
            Keyword = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Keyword");
            k = 0;
            count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings");
            while (k < count_k) {
                jResp.K = k;
                strVal = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings[k]");
                k = k+1;
            }

            j = j+1;
        }

        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions");
    while (i < count_i) {
        jResp.I = i;
        ActionName = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionName");
        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions");
        while (j < count_j) {
            jResp.J = j;
            Value = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value");
            j = j+1;
        }

        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules");
    while (i < count_i) {
        jResp.I = i;
        Priority = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].Priority");
        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts");
        while (j < count_j) {
            jResp.J = j;
            FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].FromPort");
            ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].ToPort");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations");
        while (j < count_j) {
            jResp.J = j;
            AddressDefinition = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations[j].AddressDefinition");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols");
        while (j < count_j) {
            jResp.J = j;
            intVal = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts");
        while (j < count_j) {
            jResp.J = j;
            FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].FromPort");
            ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].ToPort");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources");
        while (j < count_j) {
            jResp.J = j;
            AddressDefinition = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources[j].AddressDefinition");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags");
        while (j < count_j) {
            jResp.J = j;
            k = 0;
            count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags");
            while (k < count_k) {
                jResp.K = k;
                strVal = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags[k]");
                k = k+1;
            }

            k = 0;
            count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks");
            while (k < count_k) {
                jResp.K = k;
                strVal = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks[k]");
                k = k+1;
            }

            j = j+1;
        }

        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RuleVariables.IPSets.string.Definition");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("RuleGroup.RuleVariables.IPSets.string.Definition[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroup.RuleVariables.PortSets.string.Definition");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("RuleGroup.RuleVariables.PortSets.string.Definition[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("RuleGroupResponse.Tags");
    while (i < count_i) {
        jResp.I = i;
        Key = jResp.StringOf("RuleGroupResponse.Tags[i].Key");
        Value = jResp.StringOf("RuleGroupResponse.Tags[i].Value");
        i = i+1;
    }

    // A sample JSON response body parsed by the above code:

    // {
    //   "RuleGroup": {
    //     "RulesSource": {
    //       "RulesSourceList": {
    //         "GeneratedRulesType": "string",
    //         "Targets": [
    //           "string"
    //         ],
    //         "TargetTypes": [
    //           "string"
    //         ]
    //       },
    //       "RulesString": "string",
    //       "StatefulRules": [
    //         {
    //           "Action": "string",
    //           "Header": {
    //             "Destination": "string",
    //             "DestinationPort": "string",
    //             "Direction": "string",
    //             "Protocol": "string",
    //             "Source": "string",
    //             "SourcePort": "string"
    //           },
    //           "RuleOptions": [
    //             {
    //               "Keyword": "string",
    //               "Settings": [
    //                 "string"
    //               ]
    //             }
    //           ]
    //         }
    //       ],
    //       "StatelessRulesAndCustomActions": {
    //         "CustomActions": [
    //           {
    //             "ActionDefinition": {
    //               "PublishMetricAction": {
    //                 "Dimensions": [
    //                   {
    //                     "Value": "string"
    //                   }
    //                 ]
    //               }
    //             },
    //             "ActionName": "string"
    //           }
    //         ],
    //         "StatelessRules": [
    //           {
    //             "Priority": number,
    //             "RuleDefinition": {
    //               "Actions": [
    //                 "string"
    //               ],
    //               "MatchAttributes": {
    //                 "DestinationPorts": [
    //                   {
    //                     "FromPort": number,
    //                     "ToPort": number
    //                   }
    //                 ],
    //                 "Destinations": [
    //                   {
    //                     "AddressDefinition": "string"
    //                   }
    //                 ],
    //                 "Protocols": [
    //                   number
    //                 ],
    //                 "SourcePorts": [
    //                   {
    //                     "FromPort": number,
    //                     "ToPort": number
    //                   }
    //                 ],
    //                 "Sources": [
    //                   {
    //                     "AddressDefinition": "string"
    //                   }
    //                 ],
    //                 "TCPFlags": [
    //                   {
    //                     "Flags": [
    //                       "string"
    //                     ],
    //                     "Masks": [
    //                       "string"
    //                     ]
    //                   }
    //                 ]
    //               }
    //             }
    //           }
    //         ]
    //       }
    //     },
    //     "RuleVariables": {
    //       "IPSets": {
    //         "string": {
    //           "Definition": [
    //             "string"
    //           ]
    //         }
    //       },
    //       "PortSets": {
    //         "string": {
    //           "Definition": [
    //             "string"
    //           ]
    //         }
    //       }
    //     },
    //     "StatefulRuleOptions": {
    //       "RuleOrder": "string"
    //     }
    //   },
    //   "RuleGroupResponse": {
    //     "Capacity": number,
    //     "ConsumedCapacity": number,
    //     "Description": "string",
    //     "EncryptionConfiguration": {
    //       "KeyId": "string",
    //       "Type": "string"
    //     },
    //     "LastModifiedTime": number,
    //     "NumberOfAssociations": number,
    //     "RuleGroupArn": "string",
    //     "RuleGroupId": "string",
    //     "RuleGroupName": "string",
    //     "RuleGroupStatus": "string",
    //     "SnsTopic": "string",
    //     "SourceMetadata": {
    //       "SourceArn": "string",
    //       "SourceUpdateToken": "string"
    //     },
    //     "Tags": [
    //       {
    //         "Key": "string",
    //         "Value": "string"
    //       }
    //     ],
    //     "Type": "string"
    //   },
    //   "UpdateToken": "string"
    // }

}

chilkatExample();