Skip to content

Commit 2da2334

Browse files
authored
chore: use HTTPS for AWS documentation links in alpha packages (#37364)
### Reason for this change Several `@see` and `@link` annotations in alpha packages reference AWS documentation using `http://` instead of `https://`. ### Description of changes Replace `http://docs.aws.amazon.com` with `https://docs.aws.amazon.com` across 10 source files in the following alpha packages: - aws-bedrock-alpha - aws-ec2-alpha - aws-pipes-alpha - aws-pipes-sources-alpha - aws-pipes-targets-alpha - aws-s3tables-alpha ### Description of how you validated changes Comment/annotation-only changes. No functional impact. ### 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)
1 parent 7a0e9ed commit 2da2334

File tree

12 files changed

+26
-26
lines changed

12 files changed

+26
-26
lines changed

packages/@aws-cdk/app-staging-synthesizer-alpha/lib/staging-stack.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export interface IStagingResourcesFactory {
8282
/**
8383
* Return an object that will manage staging resources for the given stack
8484
*
85-
* This is called whenever the the `AppStagingSynthesizer` binds to a specific
85+
* This is called whenever the `AppStagingSynthesizer` binds to a specific
8686
* stack, and allows selecting where the staging resources go.
8787
*
8888
* This method can choose to either create a new construct (perhaps a stack)

packages/@aws-cdk/aws-bedrock-alpha/bedrock/inference-profiles/application-inference-profile.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface ApplicationInferenceProfileProps {
2323
* - Maximum length: 64 characters
2424
* - Pattern: `^([0-9a-zA-Z:.][ _-]?)+$`
2525
*
26-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-inferenceprofilename
26+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-inferenceprofilename
2727
*/
2828
readonly applicationInferenceProfileName: string;
2929

@@ -34,7 +34,7 @@ export interface ApplicationInferenceProfileProps {
3434
* - Maximum length: 200 characters when provided
3535
* - Pattern: `^([0-9a-zA-Z:.][ _-]?)+$`
3636
* @default - No description is provided
37-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-description
37+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-description
3838
*/
3939
readonly description?: string;
4040

packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export interface IpamProps {
6060
* The operating Regions for an IPAM.
6161
* Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs
6262
* For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
63-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions
63+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions
6464
*
6565
* @default - Stack.region if defined in the stack
6666
*/
@@ -113,7 +113,7 @@ export interface PoolOptions {
113113
* Only resources in the same Region as the locale of the pool can get IP address allocations from the pool.
114114
* You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region.
115115
* Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
116-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale
116+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale
117117
*
118118
* @default - Current operating region of IPAM
119119
*/
@@ -133,7 +133,7 @@ export interface PoolOptions {
133133
*
134134
* "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
135135
*
136-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice
136+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice
137137
*
138138
* @default - required in case of an IPv6, throws an error if not provided.
139139
*/

packages/@aws-cdk/aws-ec2-alpha/lib/vpc-v2-base.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ export interface InternetGatewayOptions{
114114
export interface VPNGatewayV2Options {
115115
/**
116116
* The type of VPN connection the virtual private gateway supports.
117-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type
117+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type
118118
*/
119119
readonly type: VpnConnectionType;
120120

@@ -135,7 +135,7 @@ export interface VPNGatewayV2Options {
135135
/**
136136
* Subnets where the route propagation should be added.
137137
*
138-
* @default - no propogation for routes
138+
* @default - no propagation for routes
139139
*/
140140
readonly vpnRoutePropagation?: SubnetSelection[];
141141
}
@@ -203,10 +203,10 @@ export interface IVpcV2 extends IVpc {
203203
addInternetGateway(options?: InternetGatewayOptions): InternetGateway;
204204

205205
/**
206-
* Adds VPN Gateway to VPC and set route propogation.
206+
* Adds VPN Gateway to VPC and set route propagation.
207207
* For more information, see the {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html}.
208208
*
209-
* @default - no route propogation
209+
* @default - no route propagation
210210
*/
211211
enableVpnGatewayV2(options: VPNGatewayV2Options): VPNGatewayV2;
212212

packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ export interface FleetProps {
308308
* The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
309309
* Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.
310310
*
311-
* @see http://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.
311+
* @see https://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.
312312
*/
313313
readonly instanceType: ec2.InstanceType;
314314

packages/@aws-cdk/aws-pipes-alpha/lib/enrichment.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { IPipe } from '.';
55
/**
66
* The parameters required to set up enrichment on your pipe.
77
*
8-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html
8+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html
99
*/
1010
export interface EnrichmentParametersConfig {
1111

packages/@aws-cdk/aws-pipes-alpha/lib/logs.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export interface LogDestinationParameters {
104104
/**
105105
* The logging configuration settings for the pipe.
106106
*
107-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination
107+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination
108108
*
109109
* @default - none
110110
*/
@@ -113,7 +113,7 @@ export interface LogDestinationParameters {
113113
/**
114114
* The Amazon Data Firehose logging configuration settings for the pipe.
115115
*
116-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination
116+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination
117117
*
118118
* @default - none
119119
*/
@@ -122,7 +122,7 @@ export interface LogDestinationParameters {
122122
/**
123123
* The Amazon S3 logging configuration settings for the pipe.
124124
*
125-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-s3logdestination
125+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-s3logdestination
126126
*
127127
* @default - none
128128
*/

packages/@aws-cdk/aws-pipes-alpha/lib/pipe.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface PipeProps {
9797
/**
9898
* Name of the pipe in the AWS console
9999
*
100-
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-name
100+
* @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-name
101101
*
102102
* @default - automatically generated name
103103
*/
@@ -138,15 +138,15 @@ export interface PipeProps {
138138
*
139139
* For more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) and the [message schema](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs-schema.html) in the *Amazon EventBridge User Guide* .
140140
*
141-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
141+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
142142
* @default - none
143143
*/
144144
readonly logIncludeExecutionData?: IncludeExecutionData[];
145145

146146
/**
147147
* A description of the pipe displayed in the AWS console
148148
*
149-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description
149+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description
150150
*
151151
* @default - no description
152152
*/
@@ -164,7 +164,7 @@ export interface PipeProps {
164164
/**
165165
* The list of key-value pairs to associate with the pipe.
166166
*
167-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags
167+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags
168168
*
169169
* @default - no tags
170170
*/

packages/@aws-cdk/aws-pipes-sources-alpha/lib/sqs.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ export interface SqsSourceParameters {
1010
/**
1111
* The maximum number of records to include in each batch.
1212
*
13-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize
13+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize
1414
* @default 10
1515
*/
1616
readonly batchSize?: number;
1717

1818
/**
1919
* The maximum length of a time to wait for events.
2020
*
21-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds
21+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds
2222
* @default 1
2323
*/
2424
readonly maximumBatchingWindow?: Duration;

packages/@aws-cdk/aws-pipes-targets-alpha/lib/sqs.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ export interface SqsTargetParameters {
1919
*
2020
* The token used for deduplication of sent messages.
2121
*
22-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid
22+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid
2323
* @default - none
2424
*/
2525
readonly messageDeduplicationId?: string;
2626

2727
/**
2828
* The FIFO message group ID to use as the target.
2929
*
30-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid
30+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid
3131
* @default - none
3232
*/
3333
readonly messageGroupId?: string;

0 commit comments

Comments
 (0)