Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
1 change: 0 additions & 1 deletion packages/@aws-cdk/aws-ec2-alpha/lib/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,6 @@ export class CidrBlockIpv6 {
}

/**
* @param ipv6Address
* @returns Converts given ipv6 address range to big int number
*/
private ipv6ToNumber(ipv6Address: string): bigint {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ export class PySparkStreamingJob extends Job {
/**
* Set the executable arguments with best practices enabled by default
*
* @param props
* @returns An array of arguments for Glue to use on execution
*/
private executableArguments(props: PySparkStreamingJobProps) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ export abstract class ScheduleTargetBase {

/**
* Create a return a Schedule Target Configuration for the given schedule
* @param schedule
* @returns a Schedule Target Configuration
*/
bind(schedule: ISchedule): ScheduleTargetConfig {
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/cloudformation-diff/lib/diff/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,6 @@ export class DifferenceCollection<V, T extends IDifference<V>> {
* - Updated
* - Others
*
* @param cb
*/
public forEachDifference(cb: (logicalId: string, change: T) => any): void {
const removed = new Array<{ logicalId: string; change: T }>();
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/cloudformation-diff/lib/format.ts
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,6 @@ export class Formatter {
/**
* Path is supposed to start with "/stack-name". If this is the case (i.e. path has more than
* two components, we remove the first part. Otherwise, we just use the full path.
* @param p
*/
function normalizePath(p: string) {
if (p.startsWith('/')) {
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/integ-runner/lib/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,6 @@ export function cli(args: string[] = process.argv.slice(2)) {
/**
* Read CLI options from a config file if provided.
*
* @param fileName
* @returns parsed CLI config options
*/
function configFromFile(fileName?: string): Record<string, any> {
Expand Down
9 changes: 0 additions & 9 deletions packages/aws-cdk-lib/aws-apigateway/lib/access-log.ts
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,6 @@ export class AccessLogField {
* The request header override.
* If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane.
* @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
*
* @param headerName
*/
public static contextRequestOverrideHeader(headerName: string) {
return `$context.requestOverride.header.${headerName}`;
Expand All @@ -386,8 +384,6 @@ export class AccessLogField {
* The request path override. If this parameter is defined,
* it contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane.
* @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
*
* @param pathName
*/
public static contextRequestOverridePath(pathName: string) {
return `$context.requestOverride.path.${pathName}`;
Expand All @@ -397,8 +393,6 @@ export class AccessLogField {
* The request query string override.
* If this parameter is defined, it contains the request query strings to be used instead
* of the URL Query String Parameters that are defined in the Integration Request pane.
*
* @param querystringName
*/
public static contextRequestOverrideQuerystring(querystringName: string) {
return `$context.requestOverride.querystring.${querystringName}`;
Expand All @@ -409,8 +403,6 @@ export class AccessLogField {
* If this parameter is defined, it contains the header to be returned instead of the Response header
* that is defined as the Default mapping in the Integration Response pane.
* @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
*
* @param headerName
*/
public static contextResponseOverrideHeader(headerName: string) {
return `$context.responseOverride.header.${headerName}`;
Expand Down Expand Up @@ -697,7 +689,6 @@ export class AccessLogFormat {
/**
* Custom log format.
* You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.
* @param format
* @example
*
* apigateway.AccessLogFormat.custom(JSON.stringify({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,6 @@ function integrationResponse() {

/**
* Defines the request template that will be used for the integration
* @param stateMachine
* @param options
* @returns requestTemplate
*/
function requestTemplates(stateMachine: sfn.IStateMachine, options: StepFunctionsExecutionIntegrationOptions) {
const templateStr = templateString(stateMachine, options);
Expand All @@ -265,11 +262,6 @@ function requestTemplates(stateMachine: sfn.IStateMachine, options: StepFunction
/**
* Reads the VTL template and returns the template string to be used
* for the request template.
*
* @param stateMachine
* @param includeRequestContext
* @param options
* @reutrns templateString
*/
function templateString(
stateMachine: sfn.IStateMachine,
Expand Down
5 changes: 0 additions & 5 deletions packages/aws-cdk-lib/aws-apigateway/lib/usage-plan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,16 +261,11 @@ export class UsagePlan extends UsagePlanBase {

/**
* Adds an apiStage.
* @param apiStage
*/
public addApiStage(apiStage: UsagePlanPerApiStage) {
this.apiStages.push(apiStage);
}

/**
*
* @param props
*/
private renderApiStages(apiStages: UsagePlanPerApiStage[] | undefined): CfnUsagePlan.ApiStageProperty[] | undefined {
if (apiStages && apiStages.length > 0) {
const stages: CfnUsagePlan.ApiStageProperty[] = [];
Expand Down
4 changes: 0 additions & 4 deletions packages/aws-cdk-lib/aws-apigatewayv2/lib/http/vpc-link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,17 +108,13 @@ export class VpcLink extends Resource implements IVpcLink {

/**
* Adds the provided subnets to the vpc link
*
* @param subnets
*/
public addSubnets(...subnets: ec2.ISubnet[]) {
this.subnets.push(...subnets);
}

/**
* Adds the provided security groups to the vpc link
*
* @param groups
*/
public addSecurityGroups(...groups: ec2.ISecurityGroup[]) {
this.securityGroups.push(...groups);
Expand Down
1 change: 0 additions & 1 deletion packages/aws-cdk-lib/aws-appconfig/lib/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -947,7 +947,6 @@ export abstract class ConfigurationSource {
* Defines configuration content from AWS CodePipeline.
*
* @param pipeline The pipeline where the configuration is stored
* @returns
*/
public static fromPipeline(pipeline: cp.IPipeline): ConfigurationSource {
return {
Expand Down
1 change: 0 additions & 1 deletion packages/aws-cdk-lib/aws-appmesh/lib/service-discovery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ export abstract class ServiceDiscovery {
/**
* Returns DNS based service discovery
*
* @param hostname
* @param responseType Specifies the DNS response type for the virtual node.
* The default is `DnsResponseType.LOAD_BALANCER`.
* @param ipPreference No IP preference is applied to the Virtual Node.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ abstract class SlackChannelConfigurationBase extends cdk.Resource implements ISl

/**
* Adds extra permission to iam-role of Slack channel configuration
* @param statement
*/
public addToRolePolicy(statement: iam.PolicyStatement): void {
if (!this.role) {
Expand Down Expand Up @@ -326,7 +325,6 @@ export class SlackChannelConfiguration extends SlackChannelConfigurationBase {

/**
* Adds a SNS topic that deliver notifications to AWS Chatbot.
* @param notificationTopic
*/
public addNotificationTopic(notificationTopic: sns.ITopic): void {
this.notificationTopics.push(notificationTopic);
Expand Down
2 changes: 0 additions & 2 deletions packages/aws-cdk-lib/aws-ecs/lib/environment-file.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export abstract class EnvironmentFile {
* Loads the environment file from a local disk path.
*
* @param path Local disk path
* @param options
*/
public static fromAsset(path: string, options?: AssetOptions): AssetEnvironmentFile {
return new AssetEnvironmentFile(path, options);
Expand Down Expand Up @@ -45,7 +44,6 @@ export class AssetEnvironmentFile extends EnvironmentFile {

/**
* @param path The path to the asset file or directory.
* @param options
*/
constructor(public readonly path: string, private readonly options: AssetOptions = { }) {
super();
Expand Down
4 changes: 0 additions & 4 deletions packages/aws-cdk-lib/aws-sns/lib/subscription.ts
Original file line number Diff line number Diff line change
Expand Up @@ -365,17 +365,13 @@ export enum FilterOrPolicyType {
export abstract class FilterOrPolicy {
/**
* Filter of MessageBody
* @param filter
* @returns
*/
public static filter(filter: SubscriptionFilter) {
return new Filter(filter);
}

/**
* Policy of MessageBody
* @param policy
* @returns
*/
public static policy(policy: { [attribute: string]: FilterOrPolicy }) {
return new Policy(policy);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { EmrModifyInstanceGroupByName } from '../emr-modify-instance-group-by-na

/**
* Render the KerberosAttributesProperty as JSON
*
* @param property
*/
export function KerberosAttributesPropertyToJson(property: EmrCreateCluster.KerberosAttributesProperty) {
return {
Expand All @@ -19,8 +17,6 @@ export function KerberosAttributesPropertyToJson(property: EmrCreateCluster.Kerb

/**
* Render the InstancesConfigProperty to JSON
*
* @param property
*/
export function InstancesConfigPropertyToJson(property: EmrCreateCluster.InstancesConfigProperty) {
return {
Expand All @@ -46,8 +42,6 @@ export function InstancesConfigPropertyToJson(property: EmrCreateCluster.Instanc

/**
* Render the ApplicationConfigProperty as JSON
*
* @param property
*/
export function ApplicationConfigPropertyToJson(property: EmrCreateCluster.ApplicationConfigProperty) {
return {
Expand All @@ -60,8 +54,6 @@ export function ApplicationConfigPropertyToJson(property: EmrCreateCluster.Appli

/**
* Render the ConfigurationProperty as JSON
*
* @param property
*/
export function ConfigurationPropertyToJson(property: EmrCreateCluster.ConfigurationProperty) {
return {
Expand All @@ -73,8 +65,6 @@ export function ConfigurationPropertyToJson(property: EmrCreateCluster.Configura

/**
* Render the EbsBlockDeviceConfigProperty as JSON
*
* @param property
*/
export function EbsBlockDeviceConfigPropertyToJson(property: EmrCreateCluster.EbsBlockDeviceConfigProperty) {
return {
Expand All @@ -89,8 +79,6 @@ export function EbsBlockDeviceConfigPropertyToJson(property: EmrCreateCluster.Eb

/**
* Render the EbsConfigurationProperty to JSON
*
* @param property
*/
export function EbsConfigurationPropertyToJson(property: EmrCreateCluster.EbsConfigurationProperty) {
return {
Expand All @@ -101,8 +89,6 @@ export function EbsConfigurationPropertyToJson(property: EmrCreateCluster.EbsCon

/**
* Render the InstanceTypeConfigProperty to JSON]
*
* @param property
*/
export function InstanceTypeConfigPropertyToJson(property: EmrCreateCluster.InstanceTypeConfigProperty) {
if (property.bidPrice && property.bidPriceAsPercentageOfOnDemandPrice) {
Expand All @@ -121,8 +107,6 @@ export function InstanceTypeConfigPropertyToJson(property: EmrCreateCluster.Inst

/**
* Render the InstanceFleetProvisioningSpecificationsProperty to JSON
*
* @param property
*/
export function InstanceFleetProvisioningSpecificationsPropertyToJson(property: EmrCreateCluster.InstanceFleetProvisioningSpecificationsProperty) {
return {
Expand Down Expand Up @@ -169,8 +153,6 @@ function SpotProvisioningSpecificationPropertyToJson(property?: EmrCreateCluster

/**
* Render the InstanceFleetConfigProperty as JSON
*
* @param property
*/
export function InstanceFleetConfigPropertyToJson(property: EmrCreateCluster.InstanceFleetConfigProperty) {
if (!property.targetSpotCapacity && !property.targetOnDemandCapacity) {
Expand Down Expand Up @@ -202,8 +184,6 @@ export function InstanceFleetConfigPropertyToJson(property: EmrCreateCluster.Ins

/**
* Render the MetricDimensionProperty as JSON
*
* @param property
*/
export function MetricDimensionPropertyToJson(property: EmrCreateCluster.MetricDimensionProperty) {
return {
Expand All @@ -214,8 +194,6 @@ export function MetricDimensionPropertyToJson(property: EmrCreateCluster.MetricD

/**
* Render the ScalingTriggerProperty to JSON
*
* @param property
*/
export function ScalingTriggerPropertyToJson(property: EmrCreateCluster.ScalingTriggerProperty) {
return {
Expand All @@ -235,8 +213,6 @@ export function ScalingTriggerPropertyToJson(property: EmrCreateCluster.ScalingT

/**
* Render the ScalingActionProperty to JSON
*
* @param property
*/
export function ScalingActionPropertyToJson(property: EmrCreateCluster.ScalingActionProperty) {
return {
Expand All @@ -251,8 +227,6 @@ export function ScalingActionPropertyToJson(property: EmrCreateCluster.ScalingAc

/**
* Render the ScalingRuleProperty to JSON
*
* @param property
*/
export function ScalingRulePropertyToJson(property: EmrCreateCluster.ScalingRuleProperty) {
return {
Expand All @@ -265,8 +239,6 @@ export function ScalingRulePropertyToJson(property: EmrCreateCluster.ScalingRule

/**
* Render the AutoScalingPolicyProperty to JSON
*
* @param property
*/
export function AutoScalingPolicyPropertyToJson(property: EmrCreateCluster.AutoScalingPolicyProperty) {
return {
Expand All @@ -280,8 +252,6 @@ export function AutoScalingPolicyPropertyToJson(property: EmrCreateCluster.AutoS

/**
* Render the InstanceGroupConfigProperty to JSON
*
* @param property
*/
export function InstanceGroupConfigPropertyToJson(property: EmrCreateCluster.InstanceGroupConfigProperty) {
return {
Expand All @@ -300,8 +270,6 @@ export function InstanceGroupConfigPropertyToJson(property: EmrCreateCluster.Ins

/**
* Render the PlacementTypeProperty to JSON
*
* @param property
*/
export function PlacementTypePropertyToJson(property: EmrCreateCluster.PlacementTypeProperty) {
return {
Expand All @@ -312,8 +280,6 @@ export function PlacementTypePropertyToJson(property: EmrCreateCluster.Placement

/**
* Render the BootstrapActionProperty as JSON
*
* @param property
*/
export function BootstrapActionConfigToJson(property: EmrCreateCluster.BootstrapActionConfigProperty) {
return {
Expand All @@ -327,8 +293,6 @@ export function BootstrapActionConfigToJson(property: EmrCreateCluster.Bootstrap

/**
* Render the InstanceGroupModifyConfigProperty to JSON
*
* @param property
*/
export function InstanceGroupModifyConfigPropertyToJson(property: EmrModifyInstanceGroupByName.InstanceGroupModifyConfigProperty) {
return {
Expand All @@ -341,8 +305,6 @@ export function InstanceGroupModifyConfigPropertyToJson(property: EmrModifyInsta

/**
* Render the ShrinkPolicyProperty to JSON
*
* @param property
*/
function ShrinkPolicyPropertyToJson(property: EmrModifyInstanceGroupByName.ShrinkPolicyProperty) {
return {
Expand All @@ -353,8 +315,6 @@ function ShrinkPolicyPropertyToJson(property: EmrModifyInstanceGroupByName.Shrin

/**
* Render the InstanceResizePolicyProperty to JSON
*
* @param property
*/
function InstanceResizePolicyPropertyToJson(property: EmrModifyInstanceGroupByName.InstanceResizePolicyProperty) {
return {
Expand Down
Loading
Loading