aws / aws/aws-cdk

aws_cdk_s3: enforce_ssl typo

Open
#24,915 3 comments 1 reaction 0 assignees View on GitHub
@aws-cdk/aws-s3 bug documentation effort/small jsii p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
74

Description

### Describe the issue

enforce_ssl parameter has a typo in python documentation under aws_cdk_s3 module

Currently the documentation says:

bucket = s3.Bucket(self, "Bucket",
**enforce_sSL**=True
)

Correct Version:

bucket = s3.Bucket(self, "Bucket",
**enforce_ssl**=True
)

### Links

https://docs.aws.amazon.com/cdk/api/v1/python/aws_cdk.aws_s3/README.html

Contributor guide

Open the contributing guide

Research direction

Open the linked AWS CDK v1 Python aws_cdk.aws_s3 README and find the Bucket example containing the enforce_sSL parameter. Correct the parameter spelling to enforce_ssl and verify that the example matches the documented API.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.