RanVaknin
commented
9 months ago Hi @carcher5432 ,
If the service can accepts "***" as a valid input parameter, then it itself is deviating from the defined API model.
If you didn't know, the SDK is code-generated from the various AWS Services' API models.
In this case, the service defined SecurityGroupIds and SubnetIds as a list of strings. This means that the SDK's code generation platform, will use those API definition to generate types from.
So this is an issue that needs to be resolved upstream with the synthetics service team itself.
You can intercept and re-write the serialized request before its being sent by using request handlers:
package main
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/synthetics"
"io"
"strings"
)
func modifyRequestToAsterisk(r *request.Request) {
if r.Operation.Name == "UpdateCanary" {
body := r.GetBody()
originalPayloadBytes, err := io.ReadAll(body)
if err != nil {
fmt.Println("Error reading request body:", err)
return
}
originalPayload := string(originalPayloadBytes)
modifiedPayload := strings.ReplaceAll(originalPayload, "\"SecurityGroupIds\":[]", "\"SecurityGroupIds\":\"***\"")
modifiedPayload = strings.ReplaceAll(modifiedPayload, "\"SubnetIds\":[]", "\"SubnetIds\":\"***\"")
r.HTTPRequest.Header.Set("Content-Length", fmt.Sprintf("%d", len(modifiedPayload)))
r.SetBufferBody([]byte(modifiedPayload))
}
}
func main() {
sess, err := session.NewSession(&aws.Config{
Region: aws.String("us-east-1"),
LogLevel: aws.LogLevel(aws.LogDebugWithHTTPBody),
})
if err != nil {
fmt.Println("Error creating session:", err)
return
}
svc := synthetics.New(sess)
req, _ := svc.UpdateCanaryRequest(&synthetics.UpdateCanaryInput{
Name: aws.String("canary-name"),
VpcConfig: &synthetics.VpcConfigInput{
SecurityGroupIds: []*string{},
SubnetIds: []*string{},
},
})
req.Handlers.Send.PushFront(modifyRequestToAsterisk)
err = req.Send()
if err != nil {
panic(err)
}
}This will result in this serialized request:
---[ REQUEST POST-SIGN ]-----------------------------
PATCH /canary/canary-name HTTP/1.1
Host: synthetics.us-west-2.amazonaws.com
User-Agent: aws-sdk-go/1.45.10 (go1.19.1; darwin; arm64)
Content-Length: 58
Authorization: AWS4-HMAC-SHA256 Credential=REDACTED/20230929/us-east-1/synthetics/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=REDACTED
Content-Type: application/json
X-Amz-Date: 20230929T212532Z
Accept-Encoding: gzip
{"VpcConfig":{"SecurityGroupIds":"***","SubnetIds":"***"}}Please note that I did not actually reproduce this with a vpc configuration on my own. This solution is an example on how you can hook alter the serialization logic the SDK provides you.
Please let me know if this is helpful.
Thanks, Ran~
github-actions[bot]
carcher5432
tim-finnigan
Describe the bug
There is no way in the SDK to send the correct request that AWS expects in order to remove VPC Config from an existing canary.
Expected Behavior
VPC Config can be removed from canary.
Current Behavior
AWS API request that successfully removes the vpc configuration:
*output comes from CloudTrail
With this structure for the VPC Config Input and no additional logic to set the "***" that the AWS API expects, it doesn't seem possible to remove an existing VPC Config.
Reproduction Steps
N/A
Possible Solution
I don't know what the best solution would be, given the current type constraints. It might require an additional field on the VpcConfigInput type and custom logic where the json body for the API request is created.
Additional Information/Context
No response
SDK version used
latest
Environment details (Version of Go (
go version)? OS name and version, etc.)N/A, core feature