You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(appconfig): turn on awslint and fix linter errors (#27893)
Most issues center around doc strings. I know nothing about appconfig, but I feel like there's massive value added to this module by providing even the cloudformation docs within cdk, so that they are accessible within the IDE. Some other linter rules I've added as exceptions, because I don't have the capacity to audit them, but they should be audited. Issue to track that work: #27894.
Labeled as a fix because technically, some public facing code has changed and also I want to make sure this ends up on the changelog.
BREAKING CHANGE: `Environment.fromEnvironmentAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users.
- **appconfig**: `Extension.fromExtensionAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy file name to clipboardExpand all lines: packages/@aws-cdk/aws-appconfig-alpha/README.md
+37-14
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,10 @@ Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and q
22
22
23
23
## Application
24
24
25
-
In AWS AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users. Configurations and environments are associated with the application.
25
+
In AWS AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a
26
+
relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and
27
+
manage configuration data for a mobile application installed by your users. Configurations and environments are associated with
28
+
the application.
26
29
27
30
The name and description of an application are optional.
28
31
@@ -43,7 +46,8 @@ new appconfig.Application(this, 'MyApplication', {
43
46
44
47
## Deployment Strategy
45
48
46
-
A deployment strategy defines how a configuration will roll out. The roll out is defined by four parameters: deployment type, step percentage, deployment time, and bake time.
49
+
A deployment strategy defines how a configuration will roll out. The roll out is defined by four parameters: deployment type,
@@ -68,11 +72,15 @@ new appconfig.DeploymentStrategy(this, 'MyDeploymentStrategy', {
68
72
69
73
## Configuration
70
74
71
-
A configuration is a higher-level construct that can either be a `HostedConfiguration` (stored internally through AWS AppConfig) or a `SourcedConfiguration` (stored in an Amazon S3 bucket, AWS Secrets Manager secrets, Systems Manager (SSM) Parameter Store parameters, SSM documents, or AWS CodePipeline). This construct manages deployments on creation.
75
+
A configuration is a higher-level construct that can either be a `HostedConfiguration` (stored internally through AWS
76
+
AppConfig) or a `SourcedConfiguration` (stored in an Amazon S3 bucket, AWS Secrets Manager secrets, Systems Manager (SSM)
77
+
Parameter Store parameters, SSM documents, or AWS CodePipeline). This construct manages deployments on creation.
72
78
73
79
### HostedConfiguration
74
80
75
-
A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store. A hosted configuration takes in the configuration content and associated AWS AppConfig application. On construction of a hosted configuration, the configuration is deployed.
81
+
A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store. A hosted configuration
82
+
takes in the configuration content and associated AWS AppConfig application. On construction of a hosted configuration, the
83
+
configuration is deployed.
76
84
77
85
```ts
78
86
declareconst application:appconfig.Application;
@@ -108,7 +116,9 @@ new appconfig.HostedConfiguration(this, 'MyHostedConfiguration', {
108
116
});
109
117
```
110
118
111
-
When you create a configuration and configuration profile, you can specify up to two validators. A validator ensures that your configuration data is syntactically and semantically correct. You can create validators in either JSON Schema or as an AWS Lambda function.
119
+
When you create a configuration and configuration profile, you can specify up to two validators. A validator ensures that your
120
+
configuration data is syntactically and semantically correct. You can create validators in either JSON Schema or as an AWS
121
+
Lambda function.
112
122
See [About validators](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-validators) for more information.
113
123
114
124
A hosted configuration with validators:
@@ -127,7 +137,8 @@ new appconfig.HostedConfiguration(this, 'MyHostedConfiguration', {
127
137
});
128
138
```
129
139
130
-
You can attach a deployment strategy (as described in the previous section) to your configuration to specify how you want your configuration to roll out.
140
+
You can attach a deployment strategy (as described in the previous section) to your configuration to specify how you want your
141
+
configuration to roll out.
131
142
132
143
A hosted configuration with a deployment strategy:
133
144
@@ -147,7 +158,8 @@ new appconfig.HostedConfiguration(this, 'MyHostedConfiguration', {
147
158
});
148
159
```
149
160
150
-
The `deployTo` parameter is used to specify which environments to deploy the configuration to. If this parameter is not specified, there will not be a deployment.
161
+
The `deployTo` parameter is used to specify which environments to deploy the configuration to. If this parameter is not
162
+
specified, there will not be a deployment.
151
163
152
164
A hosted configuration with `deployTo`:
153
165
@@ -164,7 +176,10 @@ new appconfig.HostedConfiguration(this, 'MyHostedConfiguration', {
164
176
165
177
### SourcedConfiguration
166
178
167
-
A sourced configuration represents configuration stored in an Amazon S3 bucket, AWS Secrets Manager secret, Systems Manager (SSM) Parameter Store parameter, SSM document, or AWS CodePipeline. A sourced configuration takes in the location source construct and optionally a version number to deploy. On construction of a sourced configuration, the configuration is deployed only if a version number is specified.
179
+
A sourced configuration represents configuration stored in an Amazon S3 bucket, AWS Secrets Manager secret, Systems Manager
180
+
(SSM) Parameter Store parameter, SSM document, or AWS CodePipeline. A sourced configuration takes in the location source
181
+
construct and optionally a version number to deploy. On construction of a sourced configuration, the configuration is deployed
182
+
only if a version number is specified.
168
183
169
184
### S3
170
185
@@ -309,7 +324,8 @@ new appconfig.SourcedConfiguration(this, 'MySourcedConfiguration', {
309
324
});
310
325
```
311
326
312
-
The `deployTo` parameter is used to specify which environments to deploy the configuration to. If this parameter is not specified, there will not be a deployment.
327
+
The `deployTo` parameter is used to specify which environments to deploy the configuration to. If this parameter is not
328
+
specified, there will not be a deployment.
313
329
314
330
A sourced configuration with `deployTo`:
315
331
@@ -327,7 +343,11 @@ new appconfig.SourcedConfiguration(this, 'MySourcedConfiguration', {
327
343
328
344
## Environment
329
345
330
-
For each AWS AppConfig application, you define one or more environments. An environment is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile, and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
346
+
For each AWS AppConfig application, you define one or more environments. An environment is a logical deployment group of AWS
347
+
AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application
348
+
subcomponents such as the Web, Mobile, and Back-end components for your application. You can configure Amazon CloudWatch alarms
349
+
for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls
350
+
back the configuration.
331
351
332
352
Basic environment with monitors:
333
353
@@ -343,11 +363,13 @@ new appconfig.Environment(this, 'MyEnvironment', {
343
363
});
344
364
```
345
365
346
-
Environment monitors also support L1 CfnEnvironment.MonitorsProperty constructs. However, this is not the recommended approach for CloudWatch alarms because a role will not be auto-generated if not provided.
366
+
Environment monitors also support L1 CfnEnvironment.MonitorsProperty constructs. However, this is not the recommended approach
367
+
for CloudWatch alarms because a role will not be auto-generated if not provided.
347
368
348
369
## Extension
349
370
350
-
An extension augments your ability to inject logic or behavior at different points during the AWS AppConfig workflow of creating or deploying a configuration.
371
+
An extension augments your ability to inject logic or behavior at different points during the AWS AppConfig workflow of
@@ -438,7 +460,9 @@ new appconfig.Extension(this, 'MyExtension', {
438
460
});
439
461
```
440
462
441
-
You can also add extensions and their associations directly by calling `onDeploymentComplete()` or any other action point method on the AWS AppConfig application, configuration, or environment resource. To add an association to an existing extension, you can call `addExtension()` on the resource.
463
+
You can also add extensions and their associations directly by calling `onDeploymentComplete()` or any other action point
464
+
method on the AWS AppConfig application, configuration, or environment resource. To add an association to an existing
465
+
extension, you can call `addExtension()` on the resource.
442
466
443
467
Adding an association to an AWS AppConfig application:
0 commit comments