Chilkat Online Tools

UpdateRuleGroup Powershell Example

AWS Network Firewall

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object 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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

# 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

$json = New-Object Chilkat.JsonObject
$json.UpdateString("Description","string")
$json.UpdateInt("DryRun",123)
$json.UpdateString("EncryptionConfiguration.KeyId","string")
$json.UpdateString("EncryptionConfiguration.Type","string")
$json.UpdateString("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType","string")
$json.UpdateString("RuleGroup.RulesSource.RulesSourceList.Targets[0]","string")
$json.UpdateString("RuleGroup.RulesSource.RulesSourceList.TargetTypes[0]","string")
$json.UpdateString("RuleGroup.RulesSource.RulesString","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Action","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.Destination","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.DestinationPort","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.Direction","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.Protocol","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.Source","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].Header.SourcePort","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].RuleOptions[0].Keyword","string")
$json.UpdateString("RuleGroup.RulesSource.StatefulRules[0].RuleOptions[0].Settings[0]","string")
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[0].ActionDefinition.PublishMetricAction.Dimensions[0].Value","string")
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[0].ActionName","string")
$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].Priority",123)
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.Actions[0]","string")
$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.DestinationPorts[0].FromPort",123)
$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.DestinationPorts[0].ToPort",123)
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.Destinations[0].AddressDefinition","string")
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
ERROR: Undefined variable(number)
$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.Protocols[0]",$number)ERROR: Undefined variable(number)

$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.SourcePorts[0].FromPort",123)
$json.UpdateInt("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.SourcePorts[0].ToPort",123)
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.Sources[0].AddressDefinition","string")
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.TCPFlags[0].Flags[0]","string")
$json.UpdateString("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[0].RuleDefinition.MatchAttributes.TCPFlags[0].Masks[0]","string")
$json.UpdateString("RuleGroup.RuleVariables.IPSets.string.Definition[0]","string")
$json.UpdateString("RuleGroup.RuleVariables.PortSets.string.Definition[0]","string")
$json.UpdateString("RuleGroup.StatefulRuleOptions.RuleOrder","string")
$json.UpdateString("RuleGroupArn","string")
$json.UpdateString("RuleGroupName","string")
$json.UpdateString("Rules","string")
$json.UpdateString("SourceMetadata.SourceArn","string")
$json.UpdateString("SourceMetadata.SourceUpdateToken","string")
$json.UpdateString("Type","string")
$json.UpdateString("UpdateToken","string")

# The JSON request body created by the above code:

# {
#   "Description": "string",
#   "DryRun": boolean,
#   "EncryptionConfiguration": {
#     "KeyId": "string",
#     "Type": "string"
#   },
#   "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"
#     }
#   },
#   "RuleGroupArn": "string",
#   "RuleGroupName": "string",
#   "Rules": "string",
#   "SourceMetadata": {
#     "SourceArn": "string",
#     "SourceUpdateToken": "string"
#   },
#   "Type": "string",
#   "UpdateToken": "string"
# }

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

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object 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

$Capacity = $jResp.IntOf("RuleGroupResponse.Capacity")
$ConsumedCapacity = $jResp.IntOf("RuleGroupResponse.ConsumedCapacity")
$Description = $jResp.StringOf("RuleGroupResponse.Description")
$KeyId = $jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.KeyId")
$v_Type = $jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.Type")
$LastModifiedTime = $jResp.IntOf("RuleGroupResponse.LastModifiedTime")
$NumberOfAssociations = $jResp.IntOf("RuleGroupResponse.NumberOfAssociations")
$RuleGroupArn = $jResp.StringOf("RuleGroupResponse.RuleGroupArn")
$RuleGroupId = $jResp.StringOf("RuleGroupResponse.RuleGroupId")
$RuleGroupName = $jResp.StringOf("RuleGroupResponse.RuleGroupName")
$RuleGroupStatus = $jResp.StringOf("RuleGroupResponse.RuleGroupStatus")
$SnsTopic = $jResp.StringOf("RuleGroupResponse.SnsTopic")
$SourceArn = $jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceArn")
$SourceUpdateToken = $jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken")
$RuleGroupResponseType = $jResp.StringOf("RuleGroupResponse.Type")
$UpdateToken = $jResp.StringOf("UpdateToken")
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroupResponse.Tags")
while ($i -lt $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:

# {
#   "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"
# }