chore(cognito): fix grammar in UserPool IDP docstrings (#29255)

Closes gh-29254. ### Issue # (if applicable) Closes #29254. ### Reason for this change This fixes minor grammar issues in docs. ### Description of changes I made no functional code changes, only changes to docs via comments. I made no design decisions. ### Description of how you validated changes Doc changes only. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Feb 27, 2024 · cfd93b9 · cfd93b9
1 parent a21e429
commit cfd93b9
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/amazon.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/amazon.ts
@@ -8,12 +8,12 @@ import { CfnUserPoolIdentityProvider } from '../cognito.generated';
  */
 export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityProviderProps {
   /**
-   * The client id recognized by 'Login with Amazon' APIs.
+   * The client id recognized by Login with Amazon APIs.
    * @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
    */
   readonly clientId: string;
   /**
-   * The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.
+   * The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
    * @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
    */
   readonly clientSecret: string;
@@ -26,7 +26,7 @@ export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityPro
 }
 
 /**
- * Represents a identity provider that integrates with 'Login with Amazon'
+ * Represents an identity provider that integrates with Login with Amazon
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderAmazon extends UserPoolIdentityProviderBase {

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/apple.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/apple.ts
@@ -33,7 +33,7 @@ export interface UserPoolIdentityProviderAppleProps extends UserPoolIdentityProv
 }
 
 /**
- * Represents a identity provider that integrates with 'Apple'
+ * Represents an identity provider that integrates with Apple
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderApple extends UserPoolIdentityProviderBase {

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/facebook.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/facebook.ts
@@ -12,12 +12,12 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
    */
   readonly clientId: string;
   /**
-   * The client secret to be accompanied with clientUd for Facebook to authenticate the client.
+   * The client secret to be accompanied with clientId for Facebook to authenticate the client.
    * @see https://developers.facebook.com/docs/facebook-login/security#appsecret
    */
   readonly clientSecret: string;
   /**
-   * The list of facebook permissions to obtain for getting access to the Facebook profile.
+   * The list of Facebook permissions to obtain for getting access to the Facebook profile.
    * @see https://developers.facebook.com/docs/facebook-login/permissions
    * @default [ public_profile ]
    */
@@ -30,7 +30,7 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
 }
 
 /**
- * Represents a identity provider that integrates with 'Facebook Login'
+ * Represents an identity provider that integrates with Facebook Login
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderFacebook extends UserPoolIdentityProviderBase {

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/google.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/google.ts
@@ -27,15 +27,15 @@ export interface UserPoolIdentityProviderGoogleProps extends UserPoolIdentityPro
    */
   readonly clientSecretValue?: SecretValue;
   /**
-   * The list of google permissions to obtain for getting access to the google profile
+   * The list of Google permissions to obtain for getting access to the Google profile
    * @see https://developers.google.com/identity/sign-in/web/sign-in
    * @default [ profile ]
    */
   readonly scopes?: string[];
 }
 
 /**
- * Represents a identity provider that integrates with 'Google'
+ * Represents an identity provider that integrates with Google
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderGoogle extends UserPoolIdentityProviderBase {

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/oidc.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/oidc.ts
@@ -98,7 +98,7 @@ export enum OidcAttributeRequestMethod {
 }
 
 /**
- * Represents a identity provider that integrates with OpenID Connect
+ * Represents an identity provider that integrates with OpenID Connect
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderOidc extends UserPoolIdentityProviderBase {

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/saml.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/saml.ts
@@ -78,7 +78,7 @@ export class UserPoolIdentityProviderSamlMetadata {
 }
 
 /**
- * Represents a identity provider that integrates with SAML.
+ * Represents an identity provider that integrates with SAML.
  * @resource AWS::Cognito::UserPoolIdentityProvider
  */
 export class UserPoolIdentityProviderSaml extends UserPoolIdentityProviderBase {