Skip to content

Commit 87fad88

Browse files
kikuomaxkikuomax
committed
docs: update API documentation
- Fixes typo.
1 parent 3fe5596 commit 87fad88

9 files changed

+15
-15
lines changed

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter._constructor_.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## GhostStringParameter.(constructor)
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Constructs a new instance of the `GhostStringParameter` class

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.grantread.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
## GhostStringParameter.grantRead() method
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
10-
Allows read access.
10+
Allows a given principal to read this parameter.
1111

1212
**Signature:**
1313

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## GhostStringParameter class
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
String parameter stored in Parameter Store on AWS Systems Manager.
@@ -17,9 +17,9 @@ export declare class GhostStringParameter
1717

1818
## Remarks
1919

20-
The main goal of this class is to configure the permission to access a parameter in Parameter Store on AWS Systems Manager.
20+
The main goal of this class is to provide access control over a parameter in Parameter Store on AWS Systems Manager.
2121

22-
To grant access to parameters stored in Parameter Store on AWS Systems Manager, the simplest way is to use CDK's [StringParameter](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)<!-- -->. However, to instantiate a `StringParameter`<!-- -->, you have to provision it beforehand in the CDK stack or bind it to an already existing one; you cannot bind a `StringParameter` to a parameter supposed to exist afterwards.
22+
To grant access to parameters stored in Parameter Store on AWS Systems Manager, the simplest way is to use CDK's [StringParameter](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)<!-- -->. However, to instantiate a `StringParameter`<!-- -->, you have to provision it in the CDK stack or bind it to an already existing one; you cannot bind a `StringParameter` to a parameter supposed to exist afterwards.
2323

2424
You can bind this class to a parameter that does not exist in Parameter Store on AWS Systems Manager without provisioning it.
2525

@@ -42,5 +42,5 @@ Note that this class is not a `Construct`<!-- -->.
4242

4343
| Method | Modifiers | Description |
4444
| --- | --- | --- |
45-
| [grantRead(grantee)](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md) | | **_(BETA)_** Allows read access. |
45+
| [grantRead(grantee)](./cdk-ghost-string-parameter.ghoststringparameter.grantread.md) | | **_(BETA)_** Allows a given principal to read this parameter. |
4646

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.parametername.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## GhostStringParameter.parameterName property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Name of this parameter.

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameter.scope.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## GhostStringParameter.scope property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Scope of this parameter.

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameterprops.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
## GhostStringParameterProps interface
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
10-
Properties given to the constructor of `GhostStringParammeter`<!-- -->.
10+
Properties given to the constructor of [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md)<!-- -->.
1111

1212
**Signature:**
1313

‎api-docs/markdown/cdk-ghost-string-parameter.ghoststringparameterprops.parametername.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## GhostStringParameterProps.parameterName property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Name of the parameter.

‎api-docs/markdown/cdk-ghost-string-parameter.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## cdk-ghost-string-parameter package
66

7-
Provide access control of parameters in Parameter Store on AWS Systems Manager.
7+
Provides access control over parameters in Parameter Store on AWS Systems Manager.
88

99
## Classes
1010

@@ -16,5 +16,5 @@ Provide access control of parameters in Parameter Store on AWS Systems Manager.
1616

1717
| Interface | Description |
1818
| --- | --- |
19-
| [GhostStringParameterProps](./cdk-ghost-string-parameter.ghoststringparameterprops.md) | **_(BETA)_** Properties given to the constructor of <code>GhostStringParammeter</code>. |
19+
| [GhostStringParameterProps](./cdk-ghost-string-parameter.ghoststringparameterprops.md) | **_(BETA)_** Properties given to the constructor of [GhostStringParameter](./cdk-ghost-string-parameter.ghoststringparameter.md)<!-- -->. |
2020

‎api-docs/markdown/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88

99
| Package | Description |
1010
| --- | --- |
11-
| [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) | Provide access control of parameters in Parameter Store on AWS Systems Manager. |
11+
| [cdk-ghost-string-parameter](./cdk-ghost-string-parameter.md) | Provides access control over parameters in Parameter Store on AWS Systems Manager. |
1212

0 commit comments

Comments
 (0)