Skip to content

Commit

Permalink
chore(ssm): fix docs of dataType default value (aws#19739)
Browse files Browse the repository at this point in the history
This PR fix jsdoc of `dataType` default value.
As described in the following document, `dataType` default value is `text`.
https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)?
	* [ ] Did you use `cdk-integ` to deploy the infrastructure and generate the snapshot (i.e. `cdk-integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
yamatatsu authored Apr 4, 2022
1 parent 1fdf122 commit 977b521
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-ssm/lib/parameter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export interface StringParameterProps extends ParameterOptions {
/**
* The data type of the parameter, such as `text` or `aws:ec2:image`.
*
* @default - undefined
* @default ParameterDataType.TEXT
*/
readonly dataType?: ParameterDataType;
}
Expand Down

0 comments on commit 977b521

Please sign in to comment.