CreateTransitVirtualInterface Ruby Example
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("directconnect")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://directconnect.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("directconnect.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("connectionId","string")
json.UpdateString("newTransitVirtualInterface.addressFamily","string")
json.UpdateString("newTransitVirtualInterface.amazonAddress","string")
json.UpdateInt("newTransitVirtualInterface.asn",123)
json.UpdateString("newTransitVirtualInterface.authKey","string")
json.UpdateString("newTransitVirtualInterface.customerAddress","string")
json.UpdateString("newTransitVirtualInterface.directConnectGatewayId","string")
json.UpdateInt("newTransitVirtualInterface.enableSiteLink",123)
json.UpdateInt("newTransitVirtualInterface.mtu",123)
json.UpdateString("newTransitVirtualInterface.tags[0].key","string")
json.UpdateString("newTransitVirtualInterface.tags[0].value","string")
json.UpdateString("newTransitVirtualInterface.virtualInterfaceName","string")
json.UpdateInt("newTransitVirtualInterface.vlan",123)
# The JSON request body created by the above code:
# {
# "connectionId": "string",
# "newTransitVirtualInterface": {
# "addressFamily": "string",
# "amazonAddress": "string",
# "asn": number,
# "authKey": "string",
# "customerAddress": "string",
# "directConnectGatewayId": "string",
# "enableSiteLink": boolean,
# "mtu": number,
# "tags": [
# {
# "key": "string",
# "value": "string"
# }
# ],
# "virtualInterfaceName": "string",
# "vlan": number
# }
# }
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","OvertureService.CreateTransitVirtualInterface")
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
AddressFamily = jResp.stringOf("virtualInterface.addressFamily")
AmazonAddress = jResp.stringOf("virtualInterface.amazonAddress")
AmazonSideAsn = jResp.IntOf("virtualInterface.amazonSideAsn")
v_Asn = jResp.IntOf("virtualInterface.asn")
AuthKey = jResp.stringOf("virtualInterface.authKey")
AwsDeviceV2 = jResp.stringOf("virtualInterface.awsDeviceV2")
AwsLogicalDeviceId = jResp.stringOf("virtualInterface.awsLogicalDeviceId")
ConnectionId = jResp.stringOf("virtualInterface.connectionId")
CustomerAddress = jResp.stringOf("virtualInterface.customerAddress")
CustomerRouterConfig = jResp.stringOf("virtualInterface.customerRouterConfig")
DirectConnectGatewayId = jResp.stringOf("virtualInterface.directConnectGatewayId")
JumboFrameCapable = jResp.IntOf("virtualInterface.jumboFrameCapable")
Location = jResp.stringOf("virtualInterface.location")
Mtu = jResp.IntOf("virtualInterface.mtu")
OwnerAccount = jResp.stringOf("virtualInterface.ownerAccount")
Region = jResp.stringOf("virtualInterface.region")
SiteLinkEnabled = jResp.IntOf("virtualInterface.siteLinkEnabled")
VirtualGatewayId = jResp.stringOf("virtualInterface.virtualGatewayId")
VirtualInterfaceId = jResp.stringOf("virtualInterface.virtualInterfaceId")
VirtualInterfaceName = jResp.stringOf("virtualInterface.virtualInterfaceName")
VirtualInterfaceState = jResp.stringOf("virtualInterface.virtualInterfaceState")
VirtualInterfaceType = jResp.stringOf("virtualInterface.virtualInterfaceType")
Vlan = jResp.IntOf("virtualInterface.vlan")
i = 0
count_i = jResp.SizeOfArray("virtualInterface.bgpPeers")
while i < count_i
jResp.put_I(i)
addressFamily = jResp.stringOf("virtualInterface.bgpPeers[i].addressFamily")
amazonAddress = jResp.stringOf("virtualInterface.bgpPeers[i].amazonAddress")
asn = jResp.IntOf("virtualInterface.bgpPeers[i].asn")
authKey = jResp.stringOf("virtualInterface.bgpPeers[i].authKey")
awsDeviceV2 = jResp.stringOf("virtualInterface.bgpPeers[i].awsDeviceV2")
awsLogicalDeviceId = jResp.stringOf("virtualInterface.bgpPeers[i].awsLogicalDeviceId")
bgpPeerId = jResp.stringOf("virtualInterface.bgpPeers[i].bgpPeerId")
bgpPeerState = jResp.stringOf("virtualInterface.bgpPeers[i].bgpPeerState")
bgpStatus = jResp.stringOf("virtualInterface.bgpPeers[i].bgpStatus")
customerAddress = jResp.stringOf("virtualInterface.bgpPeers[i].customerAddress")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("virtualInterface.routeFilterPrefixes")
while i < count_i
jResp.put_I(i)
cidr = jResp.stringOf("virtualInterface.routeFilterPrefixes[i].cidr")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("virtualInterface.tags")
while i < count_i
jResp.put_I(i)
key = jResp.stringOf("virtualInterface.tags[i].key")
value = jResp.stringOf("virtualInterface.tags[i].value")
i = i + 1
end
# A sample JSON response body parsed by the above code:
# {
# "virtualInterface": {
# "addressFamily": "string",
# "amazonAddress": "string",
# "amazonSideAsn": number,
# "asn": number,
# "authKey": "string",
# "awsDeviceV2": "string",
# "awsLogicalDeviceId": "string",
# "bgpPeers": [
# {
# "addressFamily": "string",
# "amazonAddress": "string",
# "asn": number,
# "authKey": "string",
# "awsDeviceV2": "string",
# "awsLogicalDeviceId": "string",
# "bgpPeerId": "string",
# "bgpPeerState": "string",
# "bgpStatus": "string",
# "customerAddress": "string"
# }
# ],
# "connectionId": "string",
# "customerAddress": "string",
# "customerRouterConfig": "string",
# "directConnectGatewayId": "string",
# "jumboFrameCapable": boolean,
# "location": "string",
# "mtu": number,
# "ownerAccount": "string",
# "region": "string",
# "routeFilterPrefixes": [
# {
# "cidr": "string"
# }
# ],
# "siteLinkEnabled": boolean,
# "tags": [
# {
# "key": "string",
# "value": "string"
# }
# ],
# "virtualGatewayId": "string",
# "virtualInterfaceId": "string",
# "virtualInterfaceName": "string",
# "virtualInterfaceState": "string",
# "virtualInterfaceType": "string",
# "vlan": number
# }
# }