Chilkat Online Tools

DescribeRuleGroup C++ Example

AWS Network Firewall

#include <CkRest.h>
#include <CkAuthAws.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>

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

    CkRest rest;
    bool success;

    CkAuthAws authAws;
    authAws.put_AccessKey("AWS_ACCESS_KEY");
    authAws.put_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.put_Region("us-west-2");
    authAws.put_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) {
        std::cout << "ConnectFailReason: " << rest.get_ConnectFailReason() << "\r\n";
        std::cout << rest.lastErrorText() << "\r\n";
        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

    CkJsonObject json;
    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");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);
    CkStringBuilder sbResponseBody;
    success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    int respStatusCode = rest.get_ResponseStatusCode();
    std::cout << "response status code = " << respStatusCode << "\r\n";
    if (respStatusCode != 200) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        std::cout << "Response Body:" << "\r\n";
        std::cout << sbResponseBody.getAsString() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    const char *strVal = 0;
    const char *Action = 0;
    const char *Destination = 0;
    const char *DestinationPort = 0;
    const char *Direction = 0;
    const char *Protocol = 0;
    const char *Source = 0;
    const char *SourcePort = 0;
    int j;
    int count_j;
    const char *Keyword = 0;
    int k;
    int count_k;
    const char *ActionName = 0;
    const char *Value = 0;
    int Priority;
    int FromPort;
    int ToPort;
    const char *AddressDefinition = 0;
    int intVal;
    const char *Key = 0;

    const char *GeneratedRulesType = jResp.stringOf("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType");
    const char *RulesString = jResp.stringOf("RuleGroup.RulesSource.RulesString");
    const char *RuleOrder = jResp.stringOf("RuleGroup.StatefulRuleOptions.RuleOrder");
    int Capacity = jResp.IntOf("RuleGroupResponse.Capacity");
    int ConsumedCapacity = jResp.IntOf("RuleGroupResponse.ConsumedCapacity");
    const char *Description = jResp.stringOf("RuleGroupResponse.Description");
    const char *KeyId = jResp.stringOf("RuleGroupResponse.EncryptionConfiguration.KeyId");
    const char *v_Type = jResp.stringOf("RuleGroupResponse.EncryptionConfiguration.Type");
    int LastModifiedTime = jResp.IntOf("RuleGroupResponse.LastModifiedTime");
    int NumberOfAssociations = jResp.IntOf("RuleGroupResponse.NumberOfAssociations");
    const char *RuleGroupArn = jResp.stringOf("RuleGroupResponse.RuleGroupArn");
    const char *RuleGroupId = jResp.stringOf("RuleGroupResponse.RuleGroupId");
    const char *RuleGroupName = jResp.stringOf("RuleGroupResponse.RuleGroupName");
    const char *RuleGroupStatus = jResp.stringOf("RuleGroupResponse.RuleGroupStatus");
    const char *SnsTopic = jResp.stringOf("RuleGroupResponse.SnsTopic");
    const char *SourceArn = jResp.stringOf("RuleGroupResponse.SourceMetadata.SourceArn");
    const char *SourceUpdateToken = jResp.stringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken");
    const char *RuleGroupResponseType = jResp.stringOf("RuleGroupResponse.Type");
    const char *UpdateToken = jResp.stringOf("UpdateToken");
    int i = 0;
    int count_i = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.Targets");
    while (i < count_i) {
        jResp.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_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.put_J(j);
            k = 0;
            count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags");
            while (k < count_k) {
                jResp.put_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.put_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.put_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.put_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.put_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"
    // }
    }