Chilkat Online Tools

DescribeFirewall Ruby Example

AWS Network Firewall

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
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)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("FirewallArn","string")
json.UpdateString("FirewallName","string")

# The JSON request body created by the above code:

# {
#   "FirewallArn": "string",
#   "FirewallName": "string"
# }

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
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

DeleteProtection = jResp.IntOf("Firewall.DeleteProtection")
Description = jResp.stringOf("Firewall.Description")
KeyId = jResp.stringOf("Firewall.EncryptionConfiguration.KeyId")
v_Type = jResp.stringOf("Firewall.EncryptionConfiguration.Type")
FirewallArn = jResp.stringOf("Firewall.FirewallArn")
FirewallId = jResp.stringOf("Firewall.FirewallId")
FirewallName = jResp.stringOf("Firewall.FirewallName")
FirewallPolicyArn = jResp.stringOf("Firewall.FirewallPolicyArn")
FirewallPolicyChangeProtection = jResp.IntOf("Firewall.FirewallPolicyChangeProtection")
SubnetChangeProtection = jResp.IntOf("Firewall.SubnetChangeProtection")
VpcId = jResp.stringOf("Firewall.VpcId")
ConfigurationSyncStateSummary = jResp.stringOf("FirewallStatus.ConfigurationSyncStateSummary")
Status = jResp.stringOf("FirewallStatus.Status")
EndpointId = jResp.stringOf("FirewallStatus.SyncStates.string.Attachment.EndpointId")
AttachmentStatus = jResp.stringOf("FirewallStatus.SyncStates.string.Attachment.Status")
SubnetId = jResp.stringOf("FirewallStatus.SyncStates.string.Attachment.SubnetId")
SyncStatus = jResp.stringOf("FirewallStatus.SyncStates.string.Config.string.SyncStatus")
UpdateToken = jResp.stringOf("FirewallStatus.SyncStates.string.Config.string.UpdateToken")
UpdateToken = jResp.stringOf("UpdateToken")
i = 0
count_i = jResp.SizeOfArray("Firewall.SubnetMappings")
while i < count_i
    jResp.put_I(i)
    SubnetId = jResp.stringOf("Firewall.SubnetMappings[i].SubnetId")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Firewall.Tags")
while i < count_i
    jResp.put_I(i)
    Key = jResp.stringOf("Firewall.Tags[i].Key")
    Value = jResp.stringOf("Firewall.Tags[i].Value")
    i = i + 1
end

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

# {
#   "Firewall": {
#     "DeleteProtection": boolean,
#     "Description": "string",
#     "EncryptionConfiguration": {
#       "KeyId": "string",
#       "Type": "string"
#     },
#     "FirewallArn": "string",
#     "FirewallId": "string",
#     "FirewallName": "string",
#     "FirewallPolicyArn": "string",
#     "FirewallPolicyChangeProtection": boolean,
#     "SubnetChangeProtection": boolean,
#     "SubnetMappings": [
#       {
#         "SubnetId": "string"
#       }
#     ],
#     "Tags": [
#       {
#         "Key": "string",
#         "Value": "string"
#       }
#     ],
#     "VpcId": "string"
#   },
#   "FirewallStatus": {
#     "ConfigurationSyncStateSummary": "string",
#     "Status": "string",
#     "SyncStates": {
#       "string": {
#         "Attachment": {
#           "EndpointId": "string",
#           "Status": "string",
#           "SubnetId": "string"
#         },
#         "Config": {
#           "string": {
#             "SyncStatus": "string",
#             "UpdateToken": "string"
#           }
#         }
#       }
#     }
#   },
#   "UpdateToken": "string"
# }