Skip to content

Commit cfd93b9

Browse files
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*
1 parent a21e429 commit cfd93b9

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/amazon.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ import { CfnUserPoolIdentityProvider } from '../cognito.generated';
88
*/
99
export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityProviderProps {
1010
/**
11-
* The client id recognized by 'Login with Amazon' APIs.
11+
* The client id recognized by Login with Amazon APIs.
1212
* @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
1313
*/
1414
readonly clientId: string;
1515
/**
16-
* The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.
16+
* The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
1717
* @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
1818
*/
1919
readonly clientSecret: string;
@@ -26,7 +26,7 @@ export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityPro
2626
}
2727

2828
/**
29-
* Represents a identity provider that integrates with 'Login with Amazon'
29+
* Represents an identity provider that integrates with Login with Amazon
3030
* @resource AWS::Cognito::UserPoolIdentityProvider
3131
*/
3232
export class UserPoolIdentityProviderAmazon extends UserPoolIdentityProviderBase {

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/apple.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface UserPoolIdentityProviderAppleProps extends UserPoolIdentityProv
3333
}
3434

3535
/**
36-
* Represents a identity provider that integrates with 'Apple'
36+
* Represents an identity provider that integrates with Apple
3737
* @resource AWS::Cognito::UserPoolIdentityProvider
3838
*/
3939
export class UserPoolIdentityProviderApple extends UserPoolIdentityProviderBase {

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/facebook.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
1212
*/
1313
readonly clientId: string;
1414
/**
15-
* The client secret to be accompanied with clientUd for Facebook to authenticate the client.
15+
* The client secret to be accompanied with clientId for Facebook to authenticate the client.
1616
* @see https://developers.facebook.com/docs/facebook-login/security#appsecret
1717
*/
1818
readonly clientSecret: string;
1919
/**
20-
* The list of facebook permissions to obtain for getting access to the Facebook profile.
20+
* The list of Facebook permissions to obtain for getting access to the Facebook profile.
2121
* @see https://developers.facebook.com/docs/facebook-login/permissions
2222
* @default [ public_profile ]
2323
*/
@@ -30,7 +30,7 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
3030
}
3131

3232
/**
33-
* Represents a identity provider that integrates with 'Facebook Login'
33+
* Represents an identity provider that integrates with Facebook Login
3434
* @resource AWS::Cognito::UserPoolIdentityProvider
3535
*/
3636
export class UserPoolIdentityProviderFacebook extends UserPoolIdentityProviderBase {

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/google.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ export interface UserPoolIdentityProviderGoogleProps extends UserPoolIdentityPro
2727
*/
2828
readonly clientSecretValue?: SecretValue;
2929
/**
30-
* The list of google permissions to obtain for getting access to the google profile
30+
* The list of Google permissions to obtain for getting access to the Google profile
3131
* @see https://developers.google.com/identity/sign-in/web/sign-in
3232
* @default [ profile ]
3333
*/
3434
readonly scopes?: string[];
3535
}
3636

3737
/**
38-
* Represents a identity provider that integrates with 'Google'
38+
* Represents an identity provider that integrates with Google
3939
* @resource AWS::Cognito::UserPoolIdentityProvider
4040
*/
4141
export class UserPoolIdentityProviderGoogle extends UserPoolIdentityProviderBase {

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/oidc.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export enum OidcAttributeRequestMethod {
9898
}
9999

100100
/**
101-
* Represents a identity provider that integrates with OpenID Connect
101+
* Represents an identity provider that integrates with OpenID Connect
102102
* @resource AWS::Cognito::UserPoolIdentityProvider
103103
*/
104104
export class UserPoolIdentityProviderOidc extends UserPoolIdentityProviderBase {

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/saml.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export class UserPoolIdentityProviderSamlMetadata {
7878
}
7979

8080
/**
81-
* Represents a identity provider that integrates with SAML.
81+
* Represents an identity provider that integrates with SAML.
8282
* @resource AWS::Cognito::UserPoolIdentityProvider
8383
*/
8484
export class UserPoolIdentityProviderSaml extends UserPoolIdentityProviderBase {

0 commit comments

Comments
 (0)