Merge pull request #1575 from achetronic/chore/document-bucket-field-…

…error
crossplane-contrib · Nov 22, 2022 · 095bdea · 095bdea
2 parents b7bc0a6 + 0056275
commit 095bdea
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/apis/s3/v1beta1/bucket_types.go b/apis/s3/v1beta1/bucket_types.go
@@ -35,6 +35,9 @@ type BucketParameters struct {
 
 	// LocationConstraint specifies the Region where the bucket will be created.
 	// It is a required field.
+	// Due to AWS API limitations lacking on a proper response, when this field is set to a wrong value,
+	// or to non-existent region on bucket creation, it's impossible forwarding a meaningful status message to the user
+	// about the problem, producing connection errors instead.
 	LocationConstraint string `json:"locationConstraint"`
 
 	// Allows grantee the read, write, read ACP, and write ACP permissions on the

diff --git a/package/crds/s3.aws.crossplane.io_buckets.yaml b/package/crds/s3.aws.crossplane.io_buckets.yaml
@@ -413,7 +413,11 @@ spec:
                     type: object
                   locationConstraint:
                     description: LocationConstraint specifies the Region where the
-                      bucket will be created. It is a required field.
+                      bucket will be created. It is a required field. Due to AWS API
+                      limitations lacking on a proper response, when this field is
+                      set to a wrong value, or to non-existent region on bucket creation,
+                      it's impossible forwarding a meaning status message to the user
+                      about the problem, producing some errors related to dial
                     type: string
                   loggingConfiguration:
                     description: Specifies logging parameters for an Amazon S3 bucket.