Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(gamelift-alpha): fix typos #32881

Closed
wants to merge 3 commits into from
Closed

docs(gamelift-alpha): fix typos #32881

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
957c97b
chore(docs): fix typos
andyu17 Jan 13, 2025
e78caea
Update fleet-base.ts
andyu17 Jan 13, 2025
2300a9f
Delete packages/@aws-cdk/aws-gamelift-alpha/README.md
andyu17 Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
526 changes: 308 additions & 218 deletions packages/@aws-cdk/aws-gamelift-alpha/README.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/build-fleet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export class BuildFleet extends FleetBase implements IBuildFleet {
public readonly content: IBuild;

/**
* The IAM role GameLift assumes by fleet instances to access AWS ressources.
* The IAM role GameLift assumes by fleet instances to access AWS resources.
*/
public readonly role: iam.IRole;

Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ export class Build extends BuildBase {
public readonly buildArn: string;

/**
* The IAM role GameLift assumes to acccess server build content.
* The IAM role GameLift assumes to access server build content.
*/
public readonly role: iam.IRole;

Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/content.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export abstract class Content {
* Game content as an S3 object.
* @param bucket The S3 bucket
* @param key The object key
* @param objectVersion Optional S3 ob ject version
* @param objectVersion Optional S3 object version
*/
public static fromBucket(bucket: s3.IBucket, key: string, objectVersion?: string): S3Content {
return new S3Content(bucket, key, objectVersion);
Expand Down
8 changes: 4 additions & 4 deletions packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ export interface FleetProps {
*
* You can't change this property after you create the fleet.
*
* Additionnal info:
* Additional info:
* AWS Certificate Manager (ACM) certificates expire after 13 months.
* Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet.
* We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
Expand All @@ -265,7 +265,7 @@ export interface FleetProps {
readonly useCertificate?: boolean;

/**
* The IAM role assumed by GameLift fleet instances to access AWS ressources.
* The IAM role assumed by GameLift fleet instances to access AWS resources.
* With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes).
* If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com).
* No permission is required by default.
Expand Down Expand Up @@ -396,7 +396,7 @@ export interface FleetAttributes {
readonly fleetId?: string;

/**
* The IAM role assumed by GameLift fleet instances to access AWS ressources.
* The IAM role assumed by GameLift fleet instances to access AWS resources.
*
* @default the imported fleet cannot be granted access to other resources as an `iam.IGrantable`.
*/
Expand Down Expand Up @@ -644,7 +644,7 @@ export abstract class FleetBase extends cdk.Resource implements IFleet {
}

protected warnVpcPeeringAuthorizations(scope: Construct): void {
cdk.Annotations.of(scope).addWarningV2('@aws-cdk/aws-gamelift:fleetAutorizeVpcPeering', [
cdk.Annotations.of(scope).addWarningV2('@aws-cdk/aws-gamelift:fleetAuthorizeVpcPeering', [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As much as this is fixing a typo, changing this value changes observable behavior, and is therefore not okay.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I have restored the points you pointed out.

'To authorize the VPC peering, call the GameLift service API CreateVpcPeeringAuthorization() or use the AWS CLI command create-vpc-peering-authorization.',
'Make this call using the account that manages your non-GameLift resources.',
'See: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html',
Expand Down
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-gamelift-alpha/lib/game-session-queue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface IGameSessionQueueDestination {
}

/**
* Priority to condider when placing new game sessions
* Priority to consider when placing new game sessions
*/
export enum PriorityType {
/**
Expand Down Expand Up @@ -294,7 +294,7 @@ export abstract class GameSessionQueueBase extends cdk.Resource implements IGame
/**
* The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.
* A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session.
* Queues can have destinations (GameLift fleets or gameSessionQueuees), which determine where the queue can place new game sessions.
* Queues can have destinations (GameLift fleets or gameSessionQueues), which determine where the queue can place new game sessions.
* A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region.
*
* @resource AWS::GameLift::GameSessionQueue
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/matchmaking-configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export interface MatchmakingConfigurationAttributes {
*
* @see https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
*
* @default no notification target binded to imported ressource
* @default no notification target binded to imported resource
*/
readonly notificationTarget?: sns.ITopic;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/script.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ export class Script extends ScriptBase {
public readonly scriptArn: string;

/**
* The IAM role GameLift assumes to acccess server script content.
* The IAM role GameLift assumes to access server script content.
*/
public readonly role: iam.IRole;

Expand Down
Loading