diff --git a/packages/@aws-cdk/aws-amplify-alpha/lib/domain.ts b/packages/@aws-cdk/aws-amplify-alpha/lib/domain.ts index c8f16c47cbe25..0ef41cc0adc5b 100644 --- a/packages/@aws-cdk/aws-amplify-alpha/lib/domain.ts +++ b/packages/@aws-cdk/aws-amplify-alpha/lib/domain.ts @@ -59,7 +59,7 @@ export interface DomainProps extends DomainOptions { /** * The IAM role with access to Route53 when using enableAutoSubdomain - * @default the IAM role from App.grantPrincipal + * @default - the IAM role from App.grantPrincipal */ readonly autoSubDomainIamRole?: iam.IRole; } diff --git a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/outbound-auth/api-key.ts b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/outbound-auth/api-key.ts index 2b2a8a6389dd0..6b847e08b2994 100644 --- a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/outbound-auth/api-key.ts +++ b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/outbound-auth/api-key.ts @@ -114,7 +114,7 @@ export interface ApiKeyCredentialProviderProps { * The location of the API key credential. * This field specifies where in the request the API key should be placed. * - * @default - HEADER + * @default HEADER */ readonly credentialLocation?: ApiKeyCredentialLocation; } diff --git a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/targets/target.ts b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/targets/target.ts index b6eb3f1b2e853..0897dadd4fcab 100644 --- a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/targets/target.ts +++ b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/targets/target.ts @@ -115,7 +115,7 @@ export interface GatewayTargetOpenApiProps extends GatewayTargetCommonProps { /** * Credential providers for authentication * OpenAPI targets support API key and OAuth authentication (not IAM) - * @default: If not provided, defaults to IAM role which will fail at runtime + * @default - If not provided, defaults to IAM role which will fail at runtime */ readonly credentialProviderConfigurations?: ICredentialProviderConfig[]; } diff --git a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/tools/browser.ts b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/tools/browser.ts index 91cec53c3f5c5..028fc6ab18670 100644 --- a/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/tools/browser.ts +++ b/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/tools/browser.ts @@ -483,7 +483,7 @@ export abstract class BrowserCustomBase extends Resource implements IBrowserCust export interface RecordingConfig { /** * Whether recording is enabled - * @default - false + * @default false */ readonly enabled?: boolean; diff --git a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent-alias.ts b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent-alias.ts index f9c556998ce47..84d630b6e4f2c 100644 --- a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent-alias.ts +++ b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent-alias.ts @@ -134,7 +134,7 @@ export interface AgentAliasProps { * The name for the agent alias. * This will be used as the physical name of the agent alias. * - * @default - "latest" + * @default "latest" */ readonly agentAliasName?: string; /** diff --git a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent.ts b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent.ts index b4281a162f022..82ee123073da6 100644 --- a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent.ts +++ b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent.ts @@ -207,7 +207,7 @@ export interface AgentProps { * making changes to the agent. The `DRAFT` version can be continually iterated * upon during internal development. * - * @default - false + * @default false */ readonly shouldPrepareAgent?: boolean; /** @@ -250,19 +250,19 @@ export interface AgentProps { * Select whether the agent can prompt additional information from the user when it does not have * enough information to respond to an utterance * - * @default - false + * @default false */ readonly userInputEnabled?: boolean; /** * Select whether the agent can generate, run, and troubleshoot code when trying to complete a task * - * @default - false + * @default false */ readonly codeInterpreterEnabled?: boolean; /** * Whether to delete the resource even if it's in use. * - * @default - false + * @default false */ readonly forceDelete?: boolean; /** diff --git a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/utils.ts b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/utils.ts index aba7b9f00d5d7..46d213bb376ef 100644 --- a/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/utils.ts +++ b/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/utils.ts @@ -78,7 +78,7 @@ export interface GeneratePhysicalNameV2Options extends cdk.UniqueResourceNameOpt /** * This object is hashed for uniqueness and can force a destroy instead of a replace. - * @default: undefined + * @default undefined */ destroyCreate?: any; } diff --git a/packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts b/packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts index 92c70d9b8666f..19c0daaeb54d3 100644 --- a/packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts +++ b/packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts @@ -517,7 +517,7 @@ export class Ipam extends Resource { /** * IPAM name to be used for tagging - * @default no tag specified + * @default - no tag specified * @attribute IpamName */ public readonly ipamName?: string; diff --git a/packages/@aws-cdk/aws-ec2-alpha/lib/route.ts b/packages/@aws-cdk/aws-ec2-alpha/lib/route.ts index 9b0e564437169..334cd49fa40c1 100644 --- a/packages/@aws-cdk/aws-ec2-alpha/lib/route.ts +++ b/packages/@aws-cdk/aws-ec2-alpha/lib/route.ts @@ -115,7 +115,7 @@ export interface NatGatewayOptions { * The maximum amount of time to wait before forcibly releasing the * IP addresses if connections are still in progress. * - * @default 350seconds + * @default - 350 seconds */ readonly maxDrainDuration?: Duration; diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/lib/cluster.ts b/packages/@aws-cdk/aws-eks-v2-alpha/lib/cluster.ts index 4152d7ce0432a..6282db29b0d44 100644 --- a/packages/@aws-cdk/aws-eks-v2-alpha/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks-v2-alpha/lib/cluster.ts @@ -376,7 +376,7 @@ export interface ClusterCommonOptions { /** * Specify which IP family is used to assign Kubernetes pod and service IP addresses. * - * @default - IpFamily.IP_V4 + * @default IpFamily.IP_V4 * @see https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-ipFamily */ readonly ipFamily?: IpFamily; @@ -1015,7 +1015,7 @@ export class Cluster extends ClusterBase { /** * Specify which IP family is used to assign Kubernetes pod and service IP addresses. * - * @default - IpFamily.IP_V4 + * @default IpFamily.IP_V4 * @see https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-ipFamily */ public readonly ipFamily?: IpFamily; diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/lib/fargate-profile.ts b/packages/@aws-cdk/aws-eks-v2-alpha/lib/fargate-profile.ts index f04315214ce82..ce53b9b870299 100644 --- a/packages/@aws-cdk/aws-eks-v2-alpha/lib/fargate-profile.ts +++ b/packages/@aws-cdk/aws-eks-v2-alpha/lib/fargate-profile.ts @@ -11,7 +11,7 @@ import { Cluster } from './cluster'; export interface FargateProfileOptions { /** * The name of the Fargate profile. - * @default - generated + * @default generated */ readonly fargateProfileName?: string; diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts b/packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts index 93d63e22bcad5..9489541d5d193 100644 --- a/packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts +++ b/packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts @@ -253,7 +253,7 @@ export interface NodegroupOptions { /** * The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default. * - * @default - desiredSize + * @default desiredSize */ readonly maxSize?: number; /** @@ -318,7 +318,7 @@ export interface NodegroupOptions { * specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, * then port 22 on the worker nodes is opened to the internet (0.0.0.0/0) * - * @default - disabled + * @default disabled */ readonly remoteAccess?: NodegroupRemoteAccess; /** @@ -326,7 +326,7 @@ export interface NodegroupOptions { * a key and an optional value, both of which you define. Node group tags do not propagate to any other resources * associated with the node group, such as the Amazon EC2 instances or subnets. * - * @default - None + * @default None */ readonly tags?: { [name: string]: string }; /** @@ -338,7 +338,7 @@ export interface NodegroupOptions { /** * The capacity type of the nodegroup. * - * @default - ON_DEMAND + * @default ON_DEMAND */ readonly capacityType?: CapacityType; @@ -368,7 +368,7 @@ export interface NodegroupOptions { * Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default. * * @see https://docs.aws.amazon.com/eks/latest/userguide/node-health.html#node-auto-repair - * @default - disabled + * @default disabled */ readonly enableNodeAutoRepair?: boolean; } diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts index 62fbe06e2bb0c..2c8c6cbfbafe9 100644 --- a/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts +++ b/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts @@ -170,7 +170,7 @@ export interface BuildProps { * * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html * - * @default - 4.0.2 + * @default 4.0.2 */ readonly serverSdkVersion?: string; } diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts index 2f5348c30b11b..f87f7b8c2e039 100644 --- a/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts +++ b/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts @@ -17,21 +17,21 @@ export interface LocationCapacity { * The number of Amazon EC2 instances you want to maintain in the specified fleet location. * This value must fall between the minimum and maximum size limits. * - * @default the default value is 0 + * @default 0 */ readonly desiredCapacity?: number; /** * The maximum number of instances that are allowed in the specified fleet location. * - * @default the default value is 1 + * @default 1 */ readonly maxSize?: number; /** * The minimum number of instances that are allowed in the specified fleet location. * - * @default the default value is 0 + * @default 0 */ readonly minSize?: number; } @@ -49,7 +49,7 @@ export interface Location { * Current resource capacity settings in a specified fleet or location. * The location value might refer to a fleet's remote location or its home Region. * - * @default no capacity settings on the specified location + * @default - no capacity settings on the specified location */ readonly capacity?: LocationCapacity; } @@ -76,7 +76,7 @@ export interface ServerProcess { /** * An optional list of parameters to pass to the server executable or Realtime script on launch. * - * @default no parameters + * @default - no parameters */ readonly parameters?: string; } @@ -99,7 +99,7 @@ export interface RuntimeConfiguration { * * If the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED`. * - * @default by default game session activation timeout is 300 seconds + * @default - by default game session activation timeout is 300 seconds */ readonly gameSessionActivationTimeout?: cdk.Duration; @@ -108,7 +108,7 @@ export interface RuntimeConfiguration { * * This setting limits the instance resources that can be used for new game activations at any one time. * - * @default no limit + * @default - no limit */ readonly maxConcurrentGameSessionActivations?: number; @@ -131,14 +131,14 @@ export interface ResourceCreationLimitPolicy { /** * The maximum number of game sessions that an individual can create during the policy period. * - * @default no limit on the number of game sessions that an individual can create during the policy period + * @default - no limit on the number of game sessions that an individual can create during the policy period */ readonly newGameSessionsPerCreator?: number; /** * The time span used in evaluating the resource creation limit policy. * - * @default no policy period + * @default - no policy period */ readonly policyPeriod?: cdk.Duration; } @@ -233,7 +233,7 @@ export interface FleetProps { /** * A human-readable description of the fleet. * - * @default no description is provided + * @default - no description is provided */ readonly description?: string; @@ -245,7 +245,7 @@ export interface FleetProps { * * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot * - * @default Gamelift fleet use on demand capacity + * @default - Gamelift fleet use on demand capacity */ readonly useSpot?: boolean; @@ -260,7 +260,7 @@ export interface FleetProps { * 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. * - * @default TLS/SSL certificate are generated for the fleet + * @default - TLS/SSL certificate are generated for the fleet */ readonly useCertificate?: boolean; @@ -289,7 +289,7 @@ export interface FleetProps { * * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html * - * @default no vpc peering + * @default - no vpc peering */ readonly peerVpc?: ec2.IVpc; @@ -299,7 +299,7 @@ export interface FleetProps { * You can specify an existing metric group name or set a new name to create a new metric group. * A fleet can be included in only one metric group at a time. * - * @default Fleet metrics are aggregated with other fleets in the default metric group + * @default - Fleet metrics are aggregated with other fleets in the default metric group */ readonly metricGroup?: string; @@ -316,21 +316,21 @@ export interface FleetProps { * When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. * Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet. * - * @default Default capacity is 0 + * @default - Default capacity is 0 */ readonly desiredCapacity?: number; /** * The minimum number of instances that are allowed in the specified fleet location. * - * @default the default is 0 + * @default 0 */ readonly minSize?: number; /** * The maximum number of instances that are allowed in the specified fleet location. * - * @default the default is 1 + * @default 1 */ readonly maxSize?: number; @@ -361,14 +361,14 @@ export interface FleetProps { * You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as `us-west-2`. * To create a fleet with instances in the home region only, omit this parameter. * - * @default Create a fleet with instances in the home region only + * @default - Create a fleet with instances in the home region only */ readonly locations?: Location[]; /** * A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. * - * @default No resource creation limit policy + * @default - No resource creation limit policy */ readonly resourceCreationLimitPolicy?: ResourceCreationLimitPolicy; } @@ -382,7 +382,7 @@ export interface FleetAttributes { * * At least one of `fleetArn` and `fleetId` must be provided. * - * @default derived from `fleetId`. + * @default - derived from `fleetId`. */ readonly fleetArn?: string; @@ -391,14 +391,14 @@ export interface FleetAttributes { * * At least one of `fleetId` and `fleetArn` must be provided. * - * @default derived from `fleetArn`. + * @default - derived from `fleetArn`. */ readonly fleetId?: string; /** * The IAM role assumed by GameLift fleet instances to access AWS ressources. * - * @default the imported fleet cannot be granted access to other resources as an `iam.IGrantable`. + * @default - the imported fleet cannot be granted access to other resources as an `iam.IGrantable`. */ readonly role?: iam.IRole; }