Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

provider: Support customization of all service endpoints #8096

Closed
wants to merge 1 commit into from

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Mar 27, 2019

Community Note

  • Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
  • Please do not leave "+1" comments, they generate extra noise for pull request followers and do not help prioritize the request

Maintainer Note: The documentation of the additional endpoint configurations will be done based on acceptance of #8092

Closes #7735

Historically, we have treated endpoint customization as an optional enhancement when adding service clients to the provider. Over time, the necessity of service endpoint customization has changed including:

  • FIPS 140-2 compliant endpoints
  • AWS C2S and SC2S potential usage
  • AWS Snowball potential usage
  • Local testing solutions such as LocalStack
  • Rare incorrect default endpoint information provided by the AWS Go SDK

This change enables all existing service clients to support endpoint customization and going forward we can include this support by default. If the AWS Go SDK provides a better customization method in the future or defines environment variable support, we can revisit this in the future. We may also choose to further optimize endpoint handling via new provider configurations (e.g. use all known FIPS 140-2 endpoints).

Endpoint service naming is based on existing configuration. Where we do not have a prior configuration, we opt for using the AWS CLI service naming minus any hyphens. We also deprecate our own naming for kinesis_analytics and r53 with kinesisanalytics and route53 respectively for consistency.

References:

@bflad bflad added enhancement Requests to existing resources that expand the functionality or scope. provider Pertains to the provider itself, rather than any interaction with AWS. labels Mar 27, 2019
@bflad bflad requested a review from a team March 27, 2019 16:58
@ghost ghost added the size/XL Managed by automation to categorize the size of a PR. label Mar 27, 2019
Historically, we have treated endpoint customization as an optional enhancement when adding service clients to the provider. Over time, the necessity of service endpoint customization has changed including:

* FIPS 140-2 compliant endpoints
* AWS C2S and SC2S potential usage
* AWS Snowball potential usage
* Local testing solutions such as LocalStack
* Rare incorrect default endpoint information provided by the AWS Go SDK

This change enables all existing service clients to support endpoint customization and going forward we can include this support by default. If the AWS Go SDK provides a better customization method in the future or defines environment variable support, we can revisit this in the future. We may also choose to further optimize endpoint handling via new provider configurations (e.g. use all known FIPS 140-2 endpoints).

Endpoint service naming is based on existing configuration. Where we do not have a prior configuration, we opt for using the AWS CLI service naming minus any hyphens. We also deprecate our own naming for `kinesis_analytics` and `r53` with `kinesisanalytics` and `route53` respectively for consistency.

References:

* https://aws.amazon.com/compliance/fips/
* https://aws.amazon.com/federal/us-intelligence-community/
* https://aws.amazon.com/snowball/
* https://docs.aws.amazon.com/cli/latest/index.html
* https://localstack.cloud/
* #7735
* #8007
* #7985
* #4967
* #4670
* #3941
* #3888
* #3608
@bflad
Copy link
Contributor Author

bflad commented Apr 1, 2019

Maintainer Note: The documentation of the additional endpoint configurations will be done based on acceptance of #8092

#8092 was accepted so will update this pull request to document all endpoints in the new Custom Service Endpoints Guide 👍

Copy link
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done 👍

@bflad bflad added this to the v2.5.0 milestone Apr 1, 2019
pull bot pushed a commit to KernelPanicAUS/terraform-provider-aws that referenced this pull request Apr 1, 2019
@bflad
Copy link
Contributor Author

bflad commented Apr 1, 2019

Rebased with master and merged with documentation in the Custom Service Endpoints Guide. 👍 (520c43f and e94940d).

@bflad bflad closed this Apr 1, 2019
@bflad bflad deleted the f-custom-all-endpoints branch April 1, 2019 19:09
bflad added a commit that referenced this pull request Apr 1, 2019
bflad added a commit that referenced this pull request Apr 1, 2019
Reference: #8146

This change verifies the new AWS Go SDK client addition process after #8096

Go Modules updated via:

```
go test ./aws
go mod tidy
go mod vendor
```
@bflad
Copy link
Contributor Author

bflad commented Apr 5, 2019

This has been released in version 2.5.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

@ghost
Copy link

ghost commented Mar 30, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked and limited conversation to collaborators Mar 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Requests to existing resources that expand the functionality or scope. provider Pertains to the provider itself, rather than any interaction with AWS. size/XL Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide endpoint for AWS step functions
2 participants