@aws-cdk/aws-iot-alpha 2.163.1-alpha.0 → 2.164.1-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +773 -16
- package/.jsii.tabl.json.gz +0 -0
- package/.warnings.jsii.js +37 -1
- package/README.md +37 -0
- package/lib/audit-configuration.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/iot-sql.js +1 -1
- package/lib/logging.js +1 -1
- package/lib/scheduled-audit.d.ts +255 -0
- package/lib/scheduled-audit.js +285 -0
- package/lib/topic-rule.js +1 -1
- package/package.json +7 -7
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.164.1",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -3882,7 +3882,7 @@
|
|
|
3882
3882
|
},
|
|
3883
3883
|
"name": "@aws-cdk/aws-iot-alpha",
|
|
3884
3884
|
"readme": {
|
|
3885
|
-
"markdown": "# AWS IoT Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAWS IoT Core lets you connect billions of IoT devices and route trillions of\nmessages to AWS services without managing infrastructure.\n\n## `TopicRule`\n\nCreate a topic rule that give your devices the ability to interact with AWS services.\nYou can create a topic rule with an action that invoke the Lambda action as following:\n\n```ts\nconst func = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_LATEST,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`\n exports.handler = (event) => {\n console.log(\"It is test for lambda action of AWS IoT Rule.\", event);\n };`\n ),\n});\n\nnew iot.TopicRule(this, 'TopicRule', {\n topicRuleName: 'MyTopicRule', // optional\n description: 'invokes the lambda function', // optional\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n actions: [new actions.LambdaFunctionAction(func)],\n});\n```\n\nOr, you can add an action after constructing the `TopicRule` instance as following:\n\n```ts\ndeclare const func: lambda.Function;\n\nconst topicRule = new iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n});\ntopicRule.addAction(new actions.LambdaFunctionAction(func));\n```\n\nYou can also supply `errorAction` as following,\nand the IoT Rule will trigger it if a rule's action is unable to perform:\n\n```ts\nimport * as logs from 'aws-cdk-lib/aws-logs';\n\nconst logGroup = new logs.LogGroup(this, 'MyLogGroup');\n\nnew iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n errorAction: new actions.CloudWatchLogsAction(logGroup),\n});\n```\n\nIf you wanna make the topic rule disable, add property `enabled: false` as following:\n\n```ts\nnew iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n enabled: false,\n});\n```\n\nSee also [@aws-cdk/aws-iot-actions-alpha](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-iot-actions-alpha-readme.html) for other actions.\n\n## Logging\n\nAWS IoT provides a [logging feature](https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html) that allows you to monitor and log AWS IoT activity.\n\nYou can enable IoT logging with the following code:\n\n```ts\nnew iot.Logging(this, 'Logging', {\n logLevel: iot.LogLevel.INFO,\n});\n```\n\n**Note**: All logs are forwarded to the `AWSIotLogsV2` log group in CloudWatch.\n\n## Audit\n\nAn [AWS IoT Device Defender audit looks](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-audit.html) at account- and device-related settings and policies to ensure security measures are in place.\nAn audit can help you detect any drifts from security best practices or access policies.\n\n### Account Audit Configuration\n\nThe IoT audit includes [various audit checks](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-audit-checks.html), and it is necessary to configure settings to enable those checks.\n\nYou can enable an account audit configuration with the following code:\n\n```ts\n// Audit notification are sent to the SNS topic\ndeclare const targetTopic: sns.ITopic;\n\nnew iot.AccountAuditConfiguration(this, 'AuditConfiguration', {\n targetTopic,\n});\n```\n\nBy default, all audit checks are enabled, but it is also possible to enable only specific audit checks.\n\n```ts\nnew iot.AccountAuditConfiguration(this, 'AuditConfiguration', {\n checkConfiguration: {\n // enabled\n authenticatedCognitoRoleOverlyPermissiveCheck: true,\n // enabled by default\n caCertificateExpiringCheck: undefined,\n // disabled\n caCertificateKeyQualityCheck: false,\n conflictingClientIdsCheck: false,\n deviceCertificateExpiringCheck: false,\n deviceCertificateKeyQualityCheck: false,\n deviceCertificateSharedCheck: false,\n intermediateCaRevokedForActiveDeviceCertificatesCheck: false,\n ioTPolicyPotentialMisConfigurationCheck: false,\n iotPolicyOverlyPermissiveCheck: false,\n iotRoleAliasAllowsAccessToUnusedServicesCheck: false,\n iotRoleAliasOverlyPermissiveCheck: false,\n loggingDisabledCheck: false,\n revokedCaCertificateStillActiveCheck: false,\n revokedDeviceCertificateStillActiveCheck: false,\n unauthenticatedCognitoRoleOverlyPermissiveCheck: false,\n },\n});\n```\n"
|
|
3885
|
+
"markdown": "# AWS IoT Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAWS IoT Core lets you connect billions of IoT devices and route trillions of\nmessages to AWS services without managing infrastructure.\n\n## `TopicRule`\n\nCreate a topic rule that give your devices the ability to interact with AWS services.\nYou can create a topic rule with an action that invoke the Lambda action as following:\n\n```ts\nconst func = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_LATEST,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`\n exports.handler = (event) => {\n console.log(\"It is test for lambda action of AWS IoT Rule.\", event);\n };`\n ),\n});\n\nnew iot.TopicRule(this, 'TopicRule', {\n topicRuleName: 'MyTopicRule', // optional\n description: 'invokes the lambda function', // optional\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n actions: [new actions.LambdaFunctionAction(func)],\n});\n```\n\nOr, you can add an action after constructing the `TopicRule` instance as following:\n\n```ts\ndeclare const func: lambda.Function;\n\nconst topicRule = new iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n});\ntopicRule.addAction(new actions.LambdaFunctionAction(func));\n```\n\nYou can also supply `errorAction` as following,\nand the IoT Rule will trigger it if a rule's action is unable to perform:\n\n```ts\nimport * as logs from 'aws-cdk-lib/aws-logs';\n\nconst logGroup = new logs.LogGroup(this, 'MyLogGroup');\n\nnew iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n errorAction: new actions.CloudWatchLogsAction(logGroup),\n});\n```\n\nIf you wanna make the topic rule disable, add property `enabled: false` as following:\n\n```ts\nnew iot.TopicRule(this, 'TopicRule', {\n sql: iot.IotSql.fromStringAsVer20160323(\"SELECT topic(2) as device_id, timestamp() as timestamp FROM 'device/+/data'\"),\n enabled: false,\n});\n```\n\nSee also [@aws-cdk/aws-iot-actions-alpha](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-iot-actions-alpha-readme.html) for other actions.\n\n## Logging\n\nAWS IoT provides a [logging feature](https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html) that allows you to monitor and log AWS IoT activity.\n\nYou can enable IoT logging with the following code:\n\n```ts\nnew iot.Logging(this, 'Logging', {\n logLevel: iot.LogLevel.INFO,\n});\n```\n\n**Note**: All logs are forwarded to the `AWSIotLogsV2` log group in CloudWatch.\n\n## Audit\n\nAn [AWS IoT Device Defender audit looks](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-audit.html) at account- and device-related settings and policies to ensure security measures are in place.\nAn audit can help you detect any drifts from security best practices or access policies.\n\n### Account Audit Configuration\n\nThe IoT audit includes [various audit checks](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-audit-checks.html), and it is necessary to configure settings to enable those checks.\n\nYou can enable an account audit configuration with the following code:\n\n```ts\n// Audit notification are sent to the SNS topic\ndeclare const targetTopic: sns.ITopic;\n\nnew iot.AccountAuditConfiguration(this, 'AuditConfiguration', {\n targetTopic,\n});\n```\n\nBy default, all audit checks are enabled, but it is also possible to enable only specific audit checks.\n\n```ts\nnew iot.AccountAuditConfiguration(this, 'AuditConfiguration', {\n checkConfiguration: {\n // enabled\n authenticatedCognitoRoleOverlyPermissiveCheck: true,\n // enabled by default\n caCertificateExpiringCheck: undefined,\n // disabled\n caCertificateKeyQualityCheck: false,\n conflictingClientIdsCheck: false,\n deviceCertificateExpiringCheck: false,\n deviceCertificateKeyQualityCheck: false,\n deviceCertificateSharedCheck: false,\n intermediateCaRevokedForActiveDeviceCertificatesCheck: false,\n ioTPolicyPotentialMisConfigurationCheck: false,\n iotPolicyOverlyPermissiveCheck: false,\n iotRoleAliasAllowsAccessToUnusedServicesCheck: false,\n iotRoleAliasOverlyPermissiveCheck: false,\n loggingDisabledCheck: false,\n revokedCaCertificateStillActiveCheck: false,\n revokedDeviceCertificateStillActiveCheck: false,\n unauthenticatedCognitoRoleOverlyPermissiveCheck: false,\n },\n});\n```\n\n### Scheduled Audit\n\nYou can create a [scheduled audit](https://docs.aws.amazon.com/iot-device-defender/latest/devguide/AuditCommands.html#device-defender-AuditCommandsManageSchedules) that is run at a specified time interval. Checks must be enabled for your account by creating `AccountAuditConfiguration`.\n\n```ts\ndeclare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});\n```\n"
|
|
3886
3886
|
},
|
|
3887
3887
|
"repository": {
|
|
3888
3888
|
"directory": "packages/@aws-cdk/aws-iot-alpha",
|
|
@@ -4138,6 +4138,131 @@
|
|
|
4138
4138
|
],
|
|
4139
4139
|
"symbolId": "lib/action:ActionConfig"
|
|
4140
4140
|
},
|
|
4141
|
+
"@aws-cdk/aws-iot-alpha.AuditCheck": {
|
|
4142
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4143
|
+
"docs": {
|
|
4144
|
+
"see": "https://docs.aws.amazon.com/iot-device-defender/latest/devguide/device-defender-audit-checks.html",
|
|
4145
|
+
"stability": "experimental",
|
|
4146
|
+
"summary": "The AWS IoT Device Defender audit checks.",
|
|
4147
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
4148
|
+
"custom": {
|
|
4149
|
+
"exampleMetadata": "infused"
|
|
4150
|
+
}
|
|
4151
|
+
},
|
|
4152
|
+
"fqn": "@aws-cdk/aws-iot-alpha.AuditCheck",
|
|
4153
|
+
"kind": "enum",
|
|
4154
|
+
"locationInModule": {
|
|
4155
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4156
|
+
"line": 43
|
|
4157
|
+
},
|
|
4158
|
+
"members": [
|
|
4159
|
+
{
|
|
4160
|
+
"docs": {
|
|
4161
|
+
"remarks": "For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker\nduring the 31 days before the audit is performed.",
|
|
4162
|
+
"stability": "experimental",
|
|
4163
|
+
"summary": "Checks the permissiveness of an authenticated Amazon Cognito identity pool role."
|
|
4164
|
+
},
|
|
4165
|
+
"name": "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK"
|
|
4166
|
+
},
|
|
4167
|
+
{
|
|
4168
|
+
"docs": {
|
|
4169
|
+
"remarks": "This check applies to CA certificates expiring within 30 days or that have expired.",
|
|
4170
|
+
"stability": "experimental",
|
|
4171
|
+
"summary": "Checks if a CA certificate is expiring."
|
|
4172
|
+
},
|
|
4173
|
+
"name": "CA_CERTIFICATE_EXPIRING_CHECK"
|
|
4174
|
+
},
|
|
4175
|
+
{
|
|
4176
|
+
"docs": {
|
|
4177
|
+
"remarks": "The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size.\n\nThis check applies to CA certificates that are ACTIVE or PENDING_TRANSFER.",
|
|
4178
|
+
"stability": "experimental",
|
|
4179
|
+
"summary": "Checks the quality of the CA certificate key."
|
|
4180
|
+
},
|
|
4181
|
+
"name": "CA_CERTIFICATE_KEY_QUALITY_CHECK"
|
|
4182
|
+
},
|
|
4183
|
+
{
|
|
4184
|
+
"docs": {
|
|
4185
|
+
"stability": "experimental",
|
|
4186
|
+
"summary": "Checks if multiple devices connect using the same client ID."
|
|
4187
|
+
},
|
|
4188
|
+
"name": "CONFLICTING_CLIENT_IDS_CHECK"
|
|
4189
|
+
},
|
|
4190
|
+
{
|
|
4191
|
+
"docs": {
|
|
4192
|
+
"remarks": "This check applies to device certificates expiring within 30 days or that have expired.",
|
|
4193
|
+
"stability": "experimental",
|
|
4194
|
+
"summary": "Checks if a device certificate is expiring."
|
|
4195
|
+
},
|
|
4196
|
+
"name": "DEVICE_CERTIFICATE_EXPIRING_CHECK"
|
|
4197
|
+
},
|
|
4198
|
+
{
|
|
4199
|
+
"docs": {
|
|
4200
|
+
"remarks": "The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority,\nand if the key meets a minimum required size.",
|
|
4201
|
+
"stability": "experimental",
|
|
4202
|
+
"summary": "Checks the quality of the device certificate key."
|
|
4203
|
+
},
|
|
4204
|
+
"name": "DEVICE_CERTIFICATE_KEY_QUALITY_CHECK"
|
|
4205
|
+
},
|
|
4206
|
+
{
|
|
4207
|
+
"docs": {
|
|
4208
|
+
"stability": "experimental",
|
|
4209
|
+
"summary": "Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT."
|
|
4210
|
+
},
|
|
4211
|
+
"name": "DEVICE_CERTIFICATE_SHARED_CHECK"
|
|
4212
|
+
},
|
|
4213
|
+
{
|
|
4214
|
+
"docs": {
|
|
4215
|
+
"stability": "experimental",
|
|
4216
|
+
"summary": "Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role."
|
|
4217
|
+
},
|
|
4218
|
+
"name": "IOT_POLICY_OVERLY_PERMISSIVE_CHECK"
|
|
4219
|
+
},
|
|
4220
|
+
{
|
|
4221
|
+
"docs": {
|
|
4222
|
+
"stability": "experimental",
|
|
4223
|
+
"summary": "Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year."
|
|
4224
|
+
},
|
|
4225
|
+
"name": "IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK"
|
|
4226
|
+
},
|
|
4227
|
+
{
|
|
4228
|
+
"docs": {
|
|
4229
|
+
"stability": "experimental",
|
|
4230
|
+
"summary": "Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive."
|
|
4231
|
+
},
|
|
4232
|
+
"name": "IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK"
|
|
4233
|
+
},
|
|
4234
|
+
{
|
|
4235
|
+
"docs": {
|
|
4236
|
+
"stability": "experimental",
|
|
4237
|
+
"summary": "Checks if AWS IoT logs are disabled."
|
|
4238
|
+
},
|
|
4239
|
+
"name": "LOGGING_DISABLED_CHECK"
|
|
4240
|
+
},
|
|
4241
|
+
{
|
|
4242
|
+
"docs": {
|
|
4243
|
+
"stability": "experimental",
|
|
4244
|
+
"summary": "Checks if a revoked CA certificate is still active."
|
|
4245
|
+
},
|
|
4246
|
+
"name": "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK"
|
|
4247
|
+
},
|
|
4248
|
+
{
|
|
4249
|
+
"docs": {
|
|
4250
|
+
"stability": "experimental",
|
|
4251
|
+
"summary": "Checks if a revoked device certificate is still active."
|
|
4252
|
+
},
|
|
4253
|
+
"name": "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK"
|
|
4254
|
+
},
|
|
4255
|
+
{
|
|
4256
|
+
"docs": {
|
|
4257
|
+
"stability": "experimental",
|
|
4258
|
+
"summary": "Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive."
|
|
4259
|
+
},
|
|
4260
|
+
"name": "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK"
|
|
4261
|
+
}
|
|
4262
|
+
],
|
|
4263
|
+
"name": "AuditCheck",
|
|
4264
|
+
"symbolId": "lib/scheduled-audit:AuditCheck"
|
|
4265
|
+
},
|
|
4141
4266
|
"@aws-cdk/aws-iot-alpha.CheckConfiguration": {
|
|
4142
4267
|
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4143
4268
|
"datatype": true,
|
|
@@ -4455,6 +4580,208 @@
|
|
|
4455
4580
|
],
|
|
4456
4581
|
"symbolId": "lib/audit-configuration:CheckConfiguration"
|
|
4457
4582
|
},
|
|
4583
|
+
"@aws-cdk/aws-iot-alpha.DayOfMonth": {
|
|
4584
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4585
|
+
"docs": {
|
|
4586
|
+
"stability": "experimental",
|
|
4587
|
+
"summary": "The day of the month on which the scheduled audit takes place.",
|
|
4588
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
4589
|
+
"custom": {
|
|
4590
|
+
"exampleMetadata": "infused"
|
|
4591
|
+
}
|
|
4592
|
+
},
|
|
4593
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfMonth",
|
|
4594
|
+
"kind": "class",
|
|
4595
|
+
"locationInModule": {
|
|
4596
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4597
|
+
"line": 172
|
|
4598
|
+
},
|
|
4599
|
+
"methods": [
|
|
4600
|
+
{
|
|
4601
|
+
"docs": {
|
|
4602
|
+
"stability": "experimental",
|
|
4603
|
+
"summary": "Custom day of the month."
|
|
4604
|
+
},
|
|
4605
|
+
"locationInModule": {
|
|
4606
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4607
|
+
"line": 182
|
|
4608
|
+
},
|
|
4609
|
+
"name": "of",
|
|
4610
|
+
"parameters": [
|
|
4611
|
+
{
|
|
4612
|
+
"docs": {
|
|
4613
|
+
"summary": "the day of the month."
|
|
4614
|
+
},
|
|
4615
|
+
"name": "day",
|
|
4616
|
+
"type": {
|
|
4617
|
+
"primitive": "number"
|
|
4618
|
+
}
|
|
4619
|
+
}
|
|
4620
|
+
],
|
|
4621
|
+
"returns": {
|
|
4622
|
+
"type": {
|
|
4623
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfMonth"
|
|
4624
|
+
}
|
|
4625
|
+
},
|
|
4626
|
+
"static": true
|
|
4627
|
+
}
|
|
4628
|
+
],
|
|
4629
|
+
"name": "DayOfMonth",
|
|
4630
|
+
"properties": [
|
|
4631
|
+
{
|
|
4632
|
+
"const": true,
|
|
4633
|
+
"docs": {
|
|
4634
|
+
"stability": "experimental",
|
|
4635
|
+
"summary": "The last day of the month."
|
|
4636
|
+
},
|
|
4637
|
+
"immutable": true,
|
|
4638
|
+
"locationInModule": {
|
|
4639
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4640
|
+
"line": 176
|
|
4641
|
+
},
|
|
4642
|
+
"name": "LAST_DAY",
|
|
4643
|
+
"static": true,
|
|
4644
|
+
"type": {
|
|
4645
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfMonth"
|
|
4646
|
+
}
|
|
4647
|
+
},
|
|
4648
|
+
{
|
|
4649
|
+
"docs": {
|
|
4650
|
+
"stability": "experimental",
|
|
4651
|
+
"summary": "The day of the month."
|
|
4652
|
+
},
|
|
4653
|
+
"immutable": true,
|
|
4654
|
+
"locationInModule": {
|
|
4655
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4656
|
+
"line": 196
|
|
4657
|
+
},
|
|
4658
|
+
"name": "day",
|
|
4659
|
+
"type": {
|
|
4660
|
+
"primitive": "string"
|
|
4661
|
+
}
|
|
4662
|
+
}
|
|
4663
|
+
],
|
|
4664
|
+
"symbolId": "lib/scheduled-audit:DayOfMonth"
|
|
4665
|
+
},
|
|
4666
|
+
"@aws-cdk/aws-iot-alpha.DayOfWeek": {
|
|
4667
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4668
|
+
"docs": {
|
|
4669
|
+
"stability": "experimental",
|
|
4670
|
+
"summary": "The day of the week on which the scheduled audit takes place.",
|
|
4671
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
4672
|
+
"custom": {
|
|
4673
|
+
"exampleMetadata": "infused"
|
|
4674
|
+
}
|
|
4675
|
+
},
|
|
4676
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfWeek",
|
|
4677
|
+
"kind": "enum",
|
|
4678
|
+
"locationInModule": {
|
|
4679
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4680
|
+
"line": 132
|
|
4681
|
+
},
|
|
4682
|
+
"members": [
|
|
4683
|
+
{
|
|
4684
|
+
"docs": {
|
|
4685
|
+
"stability": "experimental",
|
|
4686
|
+
"summary": "Sunday."
|
|
4687
|
+
},
|
|
4688
|
+
"name": "SUNDAY"
|
|
4689
|
+
},
|
|
4690
|
+
{
|
|
4691
|
+
"docs": {
|
|
4692
|
+
"stability": "experimental",
|
|
4693
|
+
"summary": "Monday."
|
|
4694
|
+
},
|
|
4695
|
+
"name": "MONDAY"
|
|
4696
|
+
},
|
|
4697
|
+
{
|
|
4698
|
+
"docs": {
|
|
4699
|
+
"stability": "experimental",
|
|
4700
|
+
"summary": "Tuesday."
|
|
4701
|
+
},
|
|
4702
|
+
"name": "TUESDAY"
|
|
4703
|
+
},
|
|
4704
|
+
{
|
|
4705
|
+
"docs": {
|
|
4706
|
+
"stability": "experimental",
|
|
4707
|
+
"summary": "Wednesday."
|
|
4708
|
+
},
|
|
4709
|
+
"name": "WEDNESDAY"
|
|
4710
|
+
},
|
|
4711
|
+
{
|
|
4712
|
+
"docs": {
|
|
4713
|
+
"stability": "experimental",
|
|
4714
|
+
"summary": "Thursday."
|
|
4715
|
+
},
|
|
4716
|
+
"name": "THURSDAY"
|
|
4717
|
+
},
|
|
4718
|
+
{
|
|
4719
|
+
"docs": {
|
|
4720
|
+
"stability": "experimental",
|
|
4721
|
+
"summary": "Friday."
|
|
4722
|
+
},
|
|
4723
|
+
"name": "FRIDAY"
|
|
4724
|
+
},
|
|
4725
|
+
{
|
|
4726
|
+
"docs": {
|
|
4727
|
+
"stability": "experimental",
|
|
4728
|
+
"summary": "Saturday."
|
|
4729
|
+
},
|
|
4730
|
+
"name": "SATURDAY"
|
|
4731
|
+
}
|
|
4732
|
+
],
|
|
4733
|
+
"name": "DayOfWeek",
|
|
4734
|
+
"symbolId": "lib/scheduled-audit:DayOfWeek"
|
|
4735
|
+
},
|
|
4736
|
+
"@aws-cdk/aws-iot-alpha.Frequency": {
|
|
4737
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4738
|
+
"docs": {
|
|
4739
|
+
"stability": "experimental",
|
|
4740
|
+
"summary": "The frequency at which the scheduled audit takes place.",
|
|
4741
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
4742
|
+
"custom": {
|
|
4743
|
+
"exampleMetadata": "infused"
|
|
4744
|
+
}
|
|
4745
|
+
},
|
|
4746
|
+
"fqn": "@aws-cdk/aws-iot-alpha.Frequency",
|
|
4747
|
+
"kind": "enum",
|
|
4748
|
+
"locationInModule": {
|
|
4749
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4750
|
+
"line": 202
|
|
4751
|
+
},
|
|
4752
|
+
"members": [
|
|
4753
|
+
{
|
|
4754
|
+
"docs": {
|
|
4755
|
+
"stability": "experimental",
|
|
4756
|
+
"summary": "Daily."
|
|
4757
|
+
},
|
|
4758
|
+
"name": "DAILY"
|
|
4759
|
+
},
|
|
4760
|
+
{
|
|
4761
|
+
"docs": {
|
|
4762
|
+
"stability": "experimental",
|
|
4763
|
+
"summary": "Weekly."
|
|
4764
|
+
},
|
|
4765
|
+
"name": "WEEKLY"
|
|
4766
|
+
},
|
|
4767
|
+
{
|
|
4768
|
+
"docs": {
|
|
4769
|
+
"stability": "experimental",
|
|
4770
|
+
"summary": "Bi-weekly."
|
|
4771
|
+
},
|
|
4772
|
+
"name": "BI_WEEKLY"
|
|
4773
|
+
},
|
|
4774
|
+
{
|
|
4775
|
+
"docs": {
|
|
4776
|
+
"stability": "experimental",
|
|
4777
|
+
"summary": "Monthly."
|
|
4778
|
+
},
|
|
4779
|
+
"name": "MONTHLY"
|
|
4780
|
+
}
|
|
4781
|
+
],
|
|
4782
|
+
"name": "Frequency",
|
|
4783
|
+
"symbolId": "lib/scheduled-audit:Frequency"
|
|
4784
|
+
},
|
|
4458
4785
|
"@aws-cdk/aws-iot-alpha.IAccountAuditConfiguration": {
|
|
4459
4786
|
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4460
4787
|
"docs": {
|
|
@@ -4548,22 +4875,22 @@
|
|
|
4548
4875
|
],
|
|
4549
4876
|
"symbolId": "lib/logging:ILogging"
|
|
4550
4877
|
},
|
|
4551
|
-
"@aws-cdk/aws-iot-alpha.
|
|
4878
|
+
"@aws-cdk/aws-iot-alpha.IScheduledAudit": {
|
|
4552
4879
|
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4553
4880
|
"docs": {
|
|
4554
4881
|
"stability": "experimental",
|
|
4555
|
-
"summary": "Represents
|
|
4882
|
+
"summary": "Represents AWS IoT Scheduled Audit."
|
|
4556
4883
|
},
|
|
4557
|
-
"fqn": "@aws-cdk/aws-iot-alpha.
|
|
4884
|
+
"fqn": "@aws-cdk/aws-iot-alpha.IScheduledAudit",
|
|
4558
4885
|
"interfaces": [
|
|
4559
4886
|
"aws-cdk-lib.IResource"
|
|
4560
4887
|
],
|
|
4561
4888
|
"kind": "interface",
|
|
4562
4889
|
"locationInModule": {
|
|
4563
|
-
"filename": "lib/
|
|
4564
|
-
"line":
|
|
4890
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4891
|
+
"line": 9
|
|
4565
4892
|
},
|
|
4566
|
-
"name": "
|
|
4893
|
+
"name": "IScheduledAudit",
|
|
4567
4894
|
"properties": [
|
|
4568
4895
|
{
|
|
4569
4896
|
"abstract": true,
|
|
@@ -4572,14 +4899,14 @@
|
|
|
4572
4899
|
"attribute": "true"
|
|
4573
4900
|
},
|
|
4574
4901
|
"stability": "experimental",
|
|
4575
|
-
"summary": "The
|
|
4902
|
+
"summary": "The ARN of the scheduled audit."
|
|
4576
4903
|
},
|
|
4577
4904
|
"immutable": true,
|
|
4578
4905
|
"locationInModule": {
|
|
4579
|
-
"filename": "lib/
|
|
4580
|
-
"line":
|
|
4906
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4907
|
+
"line": 20
|
|
4581
4908
|
},
|
|
4582
|
-
"name": "
|
|
4909
|
+
"name": "scheduledAuditArn",
|
|
4583
4910
|
"type": {
|
|
4584
4911
|
"primitive": "string"
|
|
4585
4912
|
}
|
|
@@ -4591,12 +4918,70 @@
|
|
|
4591
4918
|
"attribute": "true"
|
|
4592
4919
|
},
|
|
4593
4920
|
"stability": "experimental",
|
|
4594
|
-
"summary": "The
|
|
4921
|
+
"summary": "The scheduled audit name."
|
|
4595
4922
|
},
|
|
4596
4923
|
"immutable": true,
|
|
4597
4924
|
"locationInModule": {
|
|
4598
|
-
"filename": "lib/
|
|
4599
|
-
"line":
|
|
4925
|
+
"filename": "lib/scheduled-audit.ts",
|
|
4926
|
+
"line": 14
|
|
4927
|
+
},
|
|
4928
|
+
"name": "scheduledAuditName",
|
|
4929
|
+
"type": {
|
|
4930
|
+
"primitive": "string"
|
|
4931
|
+
}
|
|
4932
|
+
}
|
|
4933
|
+
],
|
|
4934
|
+
"symbolId": "lib/scheduled-audit:IScheduledAudit"
|
|
4935
|
+
},
|
|
4936
|
+
"@aws-cdk/aws-iot-alpha.ITopicRule": {
|
|
4937
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
4938
|
+
"docs": {
|
|
4939
|
+
"stability": "experimental",
|
|
4940
|
+
"summary": "Represents an AWS IoT Rule."
|
|
4941
|
+
},
|
|
4942
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ITopicRule",
|
|
4943
|
+
"interfaces": [
|
|
4944
|
+
"aws-cdk-lib.IResource"
|
|
4945
|
+
],
|
|
4946
|
+
"kind": "interface",
|
|
4947
|
+
"locationInModule": {
|
|
4948
|
+
"filename": "lib/topic-rule.ts",
|
|
4949
|
+
"line": 10
|
|
4950
|
+
},
|
|
4951
|
+
"name": "ITopicRule",
|
|
4952
|
+
"properties": [
|
|
4953
|
+
{
|
|
4954
|
+
"abstract": true,
|
|
4955
|
+
"docs": {
|
|
4956
|
+
"custom": {
|
|
4957
|
+
"attribute": "true"
|
|
4958
|
+
},
|
|
4959
|
+
"stability": "experimental",
|
|
4960
|
+
"summary": "The value of the topic rule Amazon Resource Name (ARN), such as arn:aws:iot:us-east-2:123456789012:rule/rule_name."
|
|
4961
|
+
},
|
|
4962
|
+
"immutable": true,
|
|
4963
|
+
"locationInModule": {
|
|
4964
|
+
"filename": "lib/topic-rule.ts",
|
|
4965
|
+
"line": 17
|
|
4966
|
+
},
|
|
4967
|
+
"name": "topicRuleArn",
|
|
4968
|
+
"type": {
|
|
4969
|
+
"primitive": "string"
|
|
4970
|
+
}
|
|
4971
|
+
},
|
|
4972
|
+
{
|
|
4973
|
+
"abstract": true,
|
|
4974
|
+
"docs": {
|
|
4975
|
+
"custom": {
|
|
4976
|
+
"attribute": "true"
|
|
4977
|
+
},
|
|
4978
|
+
"stability": "experimental",
|
|
4979
|
+
"summary": "The name topic rule."
|
|
4980
|
+
},
|
|
4981
|
+
"immutable": true,
|
|
4982
|
+
"locationInModule": {
|
|
4983
|
+
"filename": "lib/topic-rule.ts",
|
|
4984
|
+
"line": 24
|
|
4600
4985
|
},
|
|
4601
4986
|
"name": "topicRuleName",
|
|
4602
4987
|
"type": {
|
|
@@ -5022,6 +5407,378 @@
|
|
|
5022
5407
|
],
|
|
5023
5408
|
"symbolId": "lib/logging:LoggingProps"
|
|
5024
5409
|
},
|
|
5410
|
+
"@aws-cdk/aws-iot-alpha.ScheduledAudit": {
|
|
5411
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
5412
|
+
"base": "aws-cdk-lib.Resource",
|
|
5413
|
+
"docs": {
|
|
5414
|
+
"stability": "experimental",
|
|
5415
|
+
"summary": "Defines AWS IoT Scheduled Audit.",
|
|
5416
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
5417
|
+
"custom": {
|
|
5418
|
+
"exampleMetadata": "infused"
|
|
5419
|
+
}
|
|
5420
|
+
},
|
|
5421
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ScheduledAudit",
|
|
5422
|
+
"initializer": {
|
|
5423
|
+
"docs": {
|
|
5424
|
+
"stability": "experimental"
|
|
5425
|
+
},
|
|
5426
|
+
"locationInModule": {
|
|
5427
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5428
|
+
"line": 318
|
|
5429
|
+
},
|
|
5430
|
+
"parameters": [
|
|
5431
|
+
{
|
|
5432
|
+
"name": "scope",
|
|
5433
|
+
"type": {
|
|
5434
|
+
"fqn": "constructs.Construct"
|
|
5435
|
+
}
|
|
5436
|
+
},
|
|
5437
|
+
{
|
|
5438
|
+
"name": "id",
|
|
5439
|
+
"type": {
|
|
5440
|
+
"primitive": "string"
|
|
5441
|
+
}
|
|
5442
|
+
},
|
|
5443
|
+
{
|
|
5444
|
+
"name": "props",
|
|
5445
|
+
"type": {
|
|
5446
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ScheduledAuditProps"
|
|
5447
|
+
}
|
|
5448
|
+
}
|
|
5449
|
+
]
|
|
5450
|
+
},
|
|
5451
|
+
"interfaces": [
|
|
5452
|
+
"@aws-cdk/aws-iot-alpha.IScheduledAudit"
|
|
5453
|
+
],
|
|
5454
|
+
"kind": "class",
|
|
5455
|
+
"locationInModule": {
|
|
5456
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5457
|
+
"line": 274
|
|
5458
|
+
},
|
|
5459
|
+
"methods": [
|
|
5460
|
+
{
|
|
5461
|
+
"docs": {
|
|
5462
|
+
"stability": "experimental",
|
|
5463
|
+
"summary": "Import an existing AWS IoT Scheduled Audit from its ARN."
|
|
5464
|
+
},
|
|
5465
|
+
"locationInModule": {
|
|
5466
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5467
|
+
"line": 282
|
|
5468
|
+
},
|
|
5469
|
+
"name": "fromScheduledAuditArn",
|
|
5470
|
+
"parameters": [
|
|
5471
|
+
{
|
|
5472
|
+
"docs": {
|
|
5473
|
+
"summary": "The parent creating construct (usually `this`)."
|
|
5474
|
+
},
|
|
5475
|
+
"name": "scope",
|
|
5476
|
+
"type": {
|
|
5477
|
+
"fqn": "constructs.Construct"
|
|
5478
|
+
}
|
|
5479
|
+
},
|
|
5480
|
+
{
|
|
5481
|
+
"docs": {
|
|
5482
|
+
"summary": "The construct's name."
|
|
5483
|
+
},
|
|
5484
|
+
"name": "id",
|
|
5485
|
+
"type": {
|
|
5486
|
+
"primitive": "string"
|
|
5487
|
+
}
|
|
5488
|
+
},
|
|
5489
|
+
{
|
|
5490
|
+
"docs": {
|
|
5491
|
+
"summary": "The ARN of the scheduled audit."
|
|
5492
|
+
},
|
|
5493
|
+
"name": "scheduledAuditArn",
|
|
5494
|
+
"type": {
|
|
5495
|
+
"primitive": "string"
|
|
5496
|
+
}
|
|
5497
|
+
}
|
|
5498
|
+
],
|
|
5499
|
+
"returns": {
|
|
5500
|
+
"type": {
|
|
5501
|
+
"fqn": "@aws-cdk/aws-iot-alpha.IScheduledAudit"
|
|
5502
|
+
}
|
|
5503
|
+
},
|
|
5504
|
+
"static": true
|
|
5505
|
+
},
|
|
5506
|
+
{
|
|
5507
|
+
"docs": {
|
|
5508
|
+
"stability": "experimental",
|
|
5509
|
+
"summary": "Import an existing AWS IoT Scheduled Audit from its attributes."
|
|
5510
|
+
},
|
|
5511
|
+
"locationInModule": {
|
|
5512
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5513
|
+
"line": 298
|
|
5514
|
+
},
|
|
5515
|
+
"name": "fromScheduledAuditAttributes",
|
|
5516
|
+
"parameters": [
|
|
5517
|
+
{
|
|
5518
|
+
"docs": {
|
|
5519
|
+
"summary": "The parent creating construct (usually `this`)."
|
|
5520
|
+
},
|
|
5521
|
+
"name": "scope",
|
|
5522
|
+
"type": {
|
|
5523
|
+
"fqn": "constructs.Construct"
|
|
5524
|
+
}
|
|
5525
|
+
},
|
|
5526
|
+
{
|
|
5527
|
+
"docs": {
|
|
5528
|
+
"summary": "The construct's name."
|
|
5529
|
+
},
|
|
5530
|
+
"name": "id",
|
|
5531
|
+
"type": {
|
|
5532
|
+
"primitive": "string"
|
|
5533
|
+
}
|
|
5534
|
+
},
|
|
5535
|
+
{
|
|
5536
|
+
"docs": {
|
|
5537
|
+
"summary": "The scheduled audit attributes."
|
|
5538
|
+
},
|
|
5539
|
+
"name": "attrs",
|
|
5540
|
+
"type": {
|
|
5541
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ScheduledAuditAttributes"
|
|
5542
|
+
}
|
|
5543
|
+
}
|
|
5544
|
+
],
|
|
5545
|
+
"returns": {
|
|
5546
|
+
"type": {
|
|
5547
|
+
"fqn": "@aws-cdk/aws-iot-alpha.IScheduledAudit"
|
|
5548
|
+
}
|
|
5549
|
+
},
|
|
5550
|
+
"static": true
|
|
5551
|
+
}
|
|
5552
|
+
],
|
|
5553
|
+
"name": "ScheduledAudit",
|
|
5554
|
+
"properties": [
|
|
5555
|
+
{
|
|
5556
|
+
"docs": {
|
|
5557
|
+
"custom": {
|
|
5558
|
+
"attribute": "true"
|
|
5559
|
+
},
|
|
5560
|
+
"stability": "experimental",
|
|
5561
|
+
"summary": "The ARN of the scheduled audit."
|
|
5562
|
+
},
|
|
5563
|
+
"immutable": true,
|
|
5564
|
+
"locationInModule": {
|
|
5565
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5566
|
+
"line": 316
|
|
5567
|
+
},
|
|
5568
|
+
"name": "scheduledAuditArn",
|
|
5569
|
+
"overrides": "@aws-cdk/aws-iot-alpha.IScheduledAudit",
|
|
5570
|
+
"type": {
|
|
5571
|
+
"primitive": "string"
|
|
5572
|
+
}
|
|
5573
|
+
},
|
|
5574
|
+
{
|
|
5575
|
+
"docs": {
|
|
5576
|
+
"custom": {
|
|
5577
|
+
"attribute": "true"
|
|
5578
|
+
},
|
|
5579
|
+
"stability": "experimental",
|
|
5580
|
+
"summary": "The scheduled audit name."
|
|
5581
|
+
},
|
|
5582
|
+
"immutable": true,
|
|
5583
|
+
"locationInModule": {
|
|
5584
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5585
|
+
"line": 310
|
|
5586
|
+
},
|
|
5587
|
+
"name": "scheduledAuditName",
|
|
5588
|
+
"overrides": "@aws-cdk/aws-iot-alpha.IScheduledAudit",
|
|
5589
|
+
"type": {
|
|
5590
|
+
"primitive": "string"
|
|
5591
|
+
}
|
|
5592
|
+
}
|
|
5593
|
+
],
|
|
5594
|
+
"symbolId": "lib/scheduled-audit:ScheduledAudit"
|
|
5595
|
+
},
|
|
5596
|
+
"@aws-cdk/aws-iot-alpha.ScheduledAuditAttributes": {
|
|
5597
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
5598
|
+
"datatype": true,
|
|
5599
|
+
"docs": {
|
|
5600
|
+
"stability": "experimental",
|
|
5601
|
+
"summary": "Construction properties for a Scheduled Audit.",
|
|
5602
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iot_alpha from '@aws-cdk/aws-iot-alpha';\nconst scheduledAuditAttributes: iot_alpha.ScheduledAuditAttributes = {\n scheduledAuditArn: 'scheduledAuditArn',\n scheduledAuditName: 'scheduledAuditName',\n};",
|
|
5603
|
+
"custom": {
|
|
5604
|
+
"exampleMetadata": "fixture=_generated"
|
|
5605
|
+
}
|
|
5606
|
+
},
|
|
5607
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ScheduledAuditAttributes",
|
|
5608
|
+
"kind": "interface",
|
|
5609
|
+
"locationInModule": {
|
|
5610
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5611
|
+
"line": 26
|
|
5612
|
+
},
|
|
5613
|
+
"name": "ScheduledAuditAttributes",
|
|
5614
|
+
"properties": [
|
|
5615
|
+
{
|
|
5616
|
+
"abstract": true,
|
|
5617
|
+
"docs": {
|
|
5618
|
+
"stability": "experimental",
|
|
5619
|
+
"summary": "The ARN of the scheduled audit."
|
|
5620
|
+
},
|
|
5621
|
+
"immutable": true,
|
|
5622
|
+
"locationInModule": {
|
|
5623
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5624
|
+
"line": 35
|
|
5625
|
+
},
|
|
5626
|
+
"name": "scheduledAuditArn",
|
|
5627
|
+
"type": {
|
|
5628
|
+
"primitive": "string"
|
|
5629
|
+
}
|
|
5630
|
+
},
|
|
5631
|
+
{
|
|
5632
|
+
"abstract": true,
|
|
5633
|
+
"docs": {
|
|
5634
|
+
"stability": "experimental",
|
|
5635
|
+
"summary": "The scheduled audit name."
|
|
5636
|
+
},
|
|
5637
|
+
"immutable": true,
|
|
5638
|
+
"locationInModule": {
|
|
5639
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5640
|
+
"line": 30
|
|
5641
|
+
},
|
|
5642
|
+
"name": "scheduledAuditName",
|
|
5643
|
+
"type": {
|
|
5644
|
+
"primitive": "string"
|
|
5645
|
+
}
|
|
5646
|
+
}
|
|
5647
|
+
],
|
|
5648
|
+
"symbolId": "lib/scheduled-audit:ScheduledAuditAttributes"
|
|
5649
|
+
},
|
|
5650
|
+
"@aws-cdk/aws-iot-alpha.ScheduledAuditProps": {
|
|
5651
|
+
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
5652
|
+
"datatype": true,
|
|
5653
|
+
"docs": {
|
|
5654
|
+
"stability": "experimental",
|
|
5655
|
+
"summary": "Properties for defining AWS IoT Scheduled Audit.",
|
|
5656
|
+
"example": "declare const config: iot.AccountAuditConfiguration;\n\n// Daily audit\nconst dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.DAILY,\n auditChecks: [\n iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,\n ],\n})\n\n// Weekly audit\nconst weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.WEEKLY,\n dayOfWeek: iot.DayOfWeek.SUNDAY,\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,\n ],\n});\n\n// Monthly audit\nconst monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {\n accountAuditConfiguration: config,\n frequency: iot.Frequency.MONTHLY,\n dayOfMonth: iot.DayOfMonth.of(1),\n auditChecks: [\n iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,\n ],\n});",
|
|
5657
|
+
"custom": {
|
|
5658
|
+
"exampleMetadata": "infused"
|
|
5659
|
+
}
|
|
5660
|
+
},
|
|
5661
|
+
"fqn": "@aws-cdk/aws-iot-alpha.ScheduledAuditProps",
|
|
5662
|
+
"kind": "interface",
|
|
5663
|
+
"locationInModule": {
|
|
5664
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5665
|
+
"line": 227
|
|
5666
|
+
},
|
|
5667
|
+
"name": "ScheduledAuditProps",
|
|
5668
|
+
"properties": [
|
|
5669
|
+
{
|
|
5670
|
+
"abstract": true,
|
|
5671
|
+
"docs": {
|
|
5672
|
+
"remarks": "The audit checks specified in `auditChecks` must be enabled in this configuration.",
|
|
5673
|
+
"stability": "experimental",
|
|
5674
|
+
"summary": "Account audit configuration."
|
|
5675
|
+
},
|
|
5676
|
+
"immutable": true,
|
|
5677
|
+
"locationInModule": {
|
|
5678
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5679
|
+
"line": 240
|
|
5680
|
+
},
|
|
5681
|
+
"name": "accountAuditConfiguration",
|
|
5682
|
+
"type": {
|
|
5683
|
+
"fqn": "@aws-cdk/aws-iot-alpha.IAccountAuditConfiguration"
|
|
5684
|
+
}
|
|
5685
|
+
},
|
|
5686
|
+
{
|
|
5687
|
+
"abstract": true,
|
|
5688
|
+
"docs": {
|
|
5689
|
+
"remarks": "Checks must be enabled for your account.",
|
|
5690
|
+
"stability": "experimental",
|
|
5691
|
+
"summary": "Which checks are performed during the scheduled audit."
|
|
5692
|
+
},
|
|
5693
|
+
"immutable": true,
|
|
5694
|
+
"locationInModule": {
|
|
5695
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5696
|
+
"line": 233
|
|
5697
|
+
},
|
|
5698
|
+
"name": "auditChecks",
|
|
5699
|
+
"type": {
|
|
5700
|
+
"collection": {
|
|
5701
|
+
"elementtype": {
|
|
5702
|
+
"fqn": "@aws-cdk/aws-iot-alpha.AuditCheck"
|
|
5703
|
+
},
|
|
5704
|
+
"kind": "array"
|
|
5705
|
+
}
|
|
5706
|
+
}
|
|
5707
|
+
},
|
|
5708
|
+
{
|
|
5709
|
+
"abstract": true,
|
|
5710
|
+
"docs": {
|
|
5711
|
+
"stability": "experimental",
|
|
5712
|
+
"summary": "How often the scheduled audit occurs."
|
|
5713
|
+
},
|
|
5714
|
+
"immutable": true,
|
|
5715
|
+
"locationInModule": {
|
|
5716
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5717
|
+
"line": 261
|
|
5718
|
+
},
|
|
5719
|
+
"name": "frequency",
|
|
5720
|
+
"type": {
|
|
5721
|
+
"fqn": "@aws-cdk/aws-iot-alpha.Frequency"
|
|
5722
|
+
}
|
|
5723
|
+
},
|
|
5724
|
+
{
|
|
5725
|
+
"abstract": true,
|
|
5726
|
+
"docs": {
|
|
5727
|
+
"default": "- required if frequency is \"MONTHLY\", not allowed otherwise",
|
|
5728
|
+
"remarks": "If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.",
|
|
5729
|
+
"stability": "experimental",
|
|
5730
|
+
"summary": "The day of the month on which the scheduled audit is run (if the frequency is \"MONTHLY\")."
|
|
5731
|
+
},
|
|
5732
|
+
"immutable": true,
|
|
5733
|
+
"locationInModule": {
|
|
5734
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5735
|
+
"line": 256
|
|
5736
|
+
},
|
|
5737
|
+
"name": "dayOfMonth",
|
|
5738
|
+
"optional": true,
|
|
5739
|
+
"type": {
|
|
5740
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfMonth"
|
|
5741
|
+
}
|
|
5742
|
+
},
|
|
5743
|
+
{
|
|
5744
|
+
"abstract": true,
|
|
5745
|
+
"docs": {
|
|
5746
|
+
"default": "- required if frequency is \"WEEKLY\" or \"BIWEEKLY\", not allowed otherwise",
|
|
5747
|
+
"stability": "experimental",
|
|
5748
|
+
"summary": "The day of the week on which the scheduled audit is run (if the frequency is \"WEEKLY\" or \"BIWEEKLY\")."
|
|
5749
|
+
},
|
|
5750
|
+
"immutable": true,
|
|
5751
|
+
"locationInModule": {
|
|
5752
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5753
|
+
"line": 247
|
|
5754
|
+
},
|
|
5755
|
+
"name": "dayOfWeek",
|
|
5756
|
+
"optional": true,
|
|
5757
|
+
"type": {
|
|
5758
|
+
"fqn": "@aws-cdk/aws-iot-alpha.DayOfWeek"
|
|
5759
|
+
}
|
|
5760
|
+
},
|
|
5761
|
+
{
|
|
5762
|
+
"abstract": true,
|
|
5763
|
+
"docs": {
|
|
5764
|
+
"default": "- auto generated name",
|
|
5765
|
+
"stability": "experimental",
|
|
5766
|
+
"summary": "The name of the scheduled audit."
|
|
5767
|
+
},
|
|
5768
|
+
"immutable": true,
|
|
5769
|
+
"locationInModule": {
|
|
5770
|
+
"filename": "lib/scheduled-audit.ts",
|
|
5771
|
+
"line": 268
|
|
5772
|
+
},
|
|
5773
|
+
"name": "scheduledAuditName",
|
|
5774
|
+
"optional": true,
|
|
5775
|
+
"type": {
|
|
5776
|
+
"primitive": "string"
|
|
5777
|
+
}
|
|
5778
|
+
}
|
|
5779
|
+
],
|
|
5780
|
+
"symbolId": "lib/scheduled-audit:ScheduledAuditProps"
|
|
5781
|
+
},
|
|
5025
5782
|
"@aws-cdk/aws-iot-alpha.TopicRule": {
|
|
5026
5783
|
"assembly": "@aws-cdk/aws-iot-alpha",
|
|
5027
5784
|
"base": "aws-cdk-lib.Resource",
|
|
@@ -5319,6 +6076,6 @@
|
|
|
5319
6076
|
"symbolId": "lib/topic-rule:TopicRuleProps"
|
|
5320
6077
|
}
|
|
5321
6078
|
},
|
|
5322
|
-
"version": "2.
|
|
6079
|
+
"version": "2.164.1-alpha.0",
|
|
5323
6080
|
"fingerprint": "**********"
|
|
5324
6081
|
}
|