Allow option to disable host prefix injection

[wong-a]

Describe the feature

AWS Python SDK/boto has inject_host_prefix setting so clients can disable host prefix injection but AWS CLI does not allow customers to configure this.

Setting this to False disables the injection of operation parameters into the prefix of the hostname. This is useful for clients providing custom endpoints that should not have their host prefix modified.

Use Case

Clients providing a custom endpoint through the --endpoint option should not have their host prefix modified.

One example is with Step Functions Local, where clients will use the AWS CLI to call a local version of Step Functions on localhost. When calling start-sync-execution Host prefix injection preprends sync- to the hostname, which not reachable.

aws stepfunctions start-sync-execution --endpoint http://localhost:8083 --statemachine-arn <my_state_machine>

Error:

Could not connect to the endpoint URL http://sync-localhost:8083

Proposed Solution

Add a new optional boolean parameter to AWS CLI --inject_host_prefix that allows the caller to disable host prefix injection. The parameter would set the inject_host_prefix setting for the boto client.

aws stepfunctions start-sync-execution --endpoint http://localhost:8083 --statemachine-arn <my_state_machine> --inject_host_prefix=False

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CLI version used

2.4.27

Environment details (OS name and version, etc.)

macOS

[tim-finnigan]

Thanks @wong-a for the feature request. We saw that there is already an internal backlog item for this and asked the point of contact for an update. We will update that ticket and this issue as soon as we have more information.

[tim-finnigan]

I brought this up for discussion with the team and got some feedback. Adding a boolean parameter such as --inject_host_prefix seems like a reasonable proposal. But rather than adding this as a global parameter, this could potentially be added based on whether the host prefix is injected for a given operation. It would take some time and effort to determine the best interface for this but in the meantime we ask the community to 👍 and leave feedback on this issue if it is something that you would like to see prioritized.

[xquek]

this feature is available on the SDK (at least on java) will be great if the CLI support this as well.

[wong-a]

Any updates on this?

[ashovlin]

In 2.24.16 we added support for the AWS_DISABLE_HOST_PREFIX_INJECTION environment variable or the disable_host_prefix_injection parameter in the shared config file.

Cross-SDK documentation: https://docs.aws.amazon.com/sdkref/latest/guide/feature-host-prefix.html

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.