Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-amplify-alpha/lib/domain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[];
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
8 changes: 4 additions & 4 deletions packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down Expand Up @@ -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;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-ec2-alpha/lib/route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-eks-v2-alpha/lib/cluster.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks-v2-alpha/lib/fargate-profile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Cluster } from './cluster';
export interface FargateProfileOptions {
/**
* The name of the Fargate profile.
* @default - generated
* @default generated
*/
readonly fargateProfileName?: string;

Expand Down
10 changes: 5 additions & 5 deletions packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down Expand Up @@ -318,15 +318,15 @@ 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;
/**
* The metadata to apply to the node group to assist with categorization and organization. Each tag consists of
* 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 };
/**
Expand All @@ -338,7 +338,7 @@ export interface NodegroupOptions {
/**
* The capacity type of the nodegroup.
*
* @default - ON_DEMAND
* @default ON_DEMAND
*/
readonly capacityType?: CapacityType;

Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
44 changes: 22 additions & 22 deletions packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand All @@ -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;
}
Expand All @@ -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;
}
Expand All @@ -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;

Expand All @@ -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;

Expand All @@ -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;
}
Expand Down Expand Up @@ -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;

Expand All @@ -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;

Expand All @@ -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;

Expand Down Expand Up @@ -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;

Expand All @@ -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;

Expand All @@ -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;

Expand Down Expand Up @@ -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;
}
Expand All @@ -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;

Expand All @@ -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;
}
Expand Down
Loading