@rio-cloud/cdk-v2-constructs 8.3.0 → 8.4.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 +629 -54
- package/README.md +1 -0
- package/docs/AGENTS_DOCUMENTATION.md +64 -0
- package/docs/AGENTS_RIO_INFRASTRUCTURE_GUIDE.md +56 -0
- package/lib/backup/backup-policy.d.ts +7 -0
- package/lib/backup/backup-policy.js +8 -1
- package/lib/contributions/team-shipper-inbound-blue/pipeline/code-build-project.d.ts +64 -0
- package/lib/contributions/team-shipper-inbound-blue/pipeline/code-build-project.js +88 -0
- package/lib/contributions/team-shipper-inbound-blue/pipeline/index.d.ts +2 -0
- package/lib/contributions/team-shipper-inbound-blue/pipeline/index.js +19 -0
- package/lib/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.d.ts +81 -0
- package/lib/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.js +57 -0
- package/lib/datadogv2/datadog-slo.d.ts +7 -0
- package/lib/datadogv2/datadog-slo.js +8 -1
- package/lib/fargate/rio-fargate-service.d.ts +45 -0
- package/lib/fargate/rio-fargate-service.js +46 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/kafka/kafka-topic.d.ts +22 -1
- package/lib/kafka/kafka-topic.js +23 -2
- package/lib/pipeline/rio-pipeline-type.d.ts +5 -0
- package/lib/pipeline/rio-pipeline-type.js +6 -1
- package/lib/rio-landing-zone.d.ts +12 -1
- package/lib/rio-landing-zone.js +13 -2
- package/package.json +7 -7
- package/version.json +1 -1
package/.jsii
CHANGED
|
@@ -9106,7 +9106,7 @@
|
|
|
9106
9106
|
},
|
|
9107
9107
|
"name": "@rio-cloud/cdk-v2-constructs",
|
|
9108
9108
|
"readme": {
|
|
9109
|
-
"markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribute](./docs/contribution.md)\n * [Changelog](./docs/changelog.md)\n * [brief API description](./docs/API.md)\n\n## Internal documentation for library devs\n[Documentation](./docs/developers-readme.md)\n\n## Constructs overview (Under construction...)\n\n### Watchful\n\nWatchful constructs help generate some default monitors based on the resources defined in your stack. E.g. - If your stack contains a lambda function, and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever-growing list of resources that watchful creates monitors for as of today are:\n\n- Application load balancer\n- Cloudfront\n- Documentdb\n- Dynamodb\n- Fargate\n- Lambda\n- RDS\n\nSimply add the following to your CDK stack to get started.\n```\n import * as rio from '@rio-cloud/cdk-v2-constructs';\n ...\n const dw = new rio.watchfulv2.Watchful(this, 'Watchful', {\n serviceName,\n });\n dw.watchScope(this); // Generates alarms for all supported resources\n ...\n```\n\nThere are options to override some defaults too. Please be aware that the library is very opinionated and is written with the most general use cases in mind. It is necessary to keep the use of the library simple enough, which means that there is only limited flexibility regarding the configuration options. Having said that, feel free to reach out to team CLAID over slack #rio-platform-support in case of feature requests.\n\nThe broad classification of the monitors created by watchful are\n- Log error monitors\n- Metrics Query monitors: Basically everything other than log error monitors\n\nFor Metrics query monitors, you can configure the priority (defaults as 3). For log error monitors, you can configure priority, renotification interval and can configure if the auto close of the monitor is disabled.\n```\n ...\n const dw = new Watchful(stack, 'Watchful2', {\n logErrorMonitorConfig: {\n disableAutoClose: true,\n renotifyInterval: 150,\n priority: 4,\n },\n queryErrorMonitorConfig: {\n priority: 4\n }\n });\n dw.watchScope(stack);\n```\n\nThere is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make sure to use the method before the `watchscope` function.\nE.g. -\n```\n...\nconst dw = new Watchful(stack, 'Watchful', {});\ndw.overrideAlarmThreshold({\n monitoredResourceScope: lambdaA,\n monitorType: MonitorType.ERRORS,\n threshold: 5,\n});\ndw.watchScope(stack);\n```\n\n### ClassifyPipelineType\n\nThe pipelines can be tagged with key 'pipeline_type' to the following values:\n\n* deploy: To tag the production pipeline releasing the application\n* branch: The branch pipeline. Mostly used to test contributions / renovate updates\n* vulnerability: The vulnerability pipeline\n\nThe construct `ClassifyPipelineType` can be used to tag the pipeline accordingly. This tag is also picked up by the Datadog pipeline metric used to monitor the pipelines. It is added as a tag to the metric. This gives you more flexibility with managing the monitors also. E.g. some teams don't want to get alerted for branch pipelines. You can then leverage this metric tag to filter the pipelines.\n\nExample:\n\n```typescript\nconst pipeline = new pipelines.CodePipeline(this, 'Pipeline', {\n ...\n });\nrio.ClassifyPipelineType.apply(pipeline, rio.RioPipelineType.DEPLOY);\n```\n"
|
|
9109
|
+
"markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribute](./docs/contribution.md)\n * [Changelog](./docs/changelog.md)\n * [brief API description](./docs/API.md)\n * [Agent documentation](./docs/AGENTS_DOCUMENTATION.md)\n\n## Internal documentation for library devs\n[Documentation](./docs/developers-readme.md)\n\n## Constructs overview (Under construction...)\n\n### Watchful\n\nWatchful constructs help generate some default monitors based on the resources defined in your stack. E.g. - If your stack contains a lambda function, and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever-growing list of resources that watchful creates monitors for as of today are:\n\n- Application load balancer\n- Cloudfront\n- Documentdb\n- Dynamodb\n- Fargate\n- Lambda\n- RDS\n\nSimply add the following to your CDK stack to get started.\n```\n import * as rio from '@rio-cloud/cdk-v2-constructs';\n ...\n const dw = new rio.watchfulv2.Watchful(this, 'Watchful', {\n serviceName,\n });\n dw.watchScope(this); // Generates alarms for all supported resources\n ...\n```\n\nThere are options to override some defaults too. Please be aware that the library is very opinionated and is written with the most general use cases in mind. It is necessary to keep the use of the library simple enough, which means that there is only limited flexibility regarding the configuration options. Having said that, feel free to reach out to team CLAID over slack #rio-platform-support in case of feature requests.\n\nThe broad classification of the monitors created by watchful are\n- Log error monitors\n- Metrics Query monitors: Basically everything other than log error monitors\n\nFor Metrics query monitors, you can configure the priority (defaults as 3). For log error monitors, you can configure priority, renotification interval and can configure if the auto close of the monitor is disabled.\n```\n ...\n const dw = new Watchful(stack, 'Watchful2', {\n logErrorMonitorConfig: {\n disableAutoClose: true,\n renotifyInterval: 150,\n priority: 4,\n },\n queryErrorMonitorConfig: {\n priority: 4\n }\n });\n dw.watchScope(stack);\n```\n\nThere is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make sure to use the method before the `watchscope` function.\nE.g. -\n```\n...\nconst dw = new Watchful(stack, 'Watchful', {});\ndw.overrideAlarmThreshold({\n monitoredResourceScope: lambdaA,\n monitorType: MonitorType.ERRORS,\n threshold: 5,\n});\ndw.watchScope(stack);\n```\n\n### ClassifyPipelineType\n\nThe pipelines can be tagged with key 'pipeline_type' to the following values:\n\n* deploy: To tag the production pipeline releasing the application\n* branch: The branch pipeline. Mostly used to test contributions / renovate updates\n* vulnerability: The vulnerability pipeline\n\nThe construct `ClassifyPipelineType` can be used to tag the pipeline accordingly. This tag is also picked up by the Datadog pipeline metric used to monitor the pipelines. It is added as a tag to the metric. This gives you more flexibility with managing the monitors also. E.g. some teams don't want to get alerted for branch pipelines. You can then leverage this metric tag to filter the pipelines.\n\nExample:\n\n```typescript\nconst pipeline = new pipelines.CodePipeline(this, 'Pipeline', {\n ...\n });\nrio.ClassifyPipelineType.apply(pipeline, rio.RioPipelineType.DEPLOY);\n```\n"
|
|
9110
9110
|
},
|
|
9111
9111
|
"repository": {
|
|
9112
9112
|
"type": "git",
|
|
@@ -9124,49 +9124,49 @@
|
|
|
9124
9124
|
"@rio-cloud/cdk-v2-constructs.datadog": {
|
|
9125
9125
|
"locationInModule": {
|
|
9126
9126
|
"filename": "src/index.ts",
|
|
9127
|
-
"line":
|
|
9127
|
+
"line": 12
|
|
9128
9128
|
},
|
|
9129
9129
|
"symbolId": "src/datadog/index:"
|
|
9130
9130
|
},
|
|
9131
9131
|
"@rio-cloud/cdk-v2-constructs.datadogv2": {
|
|
9132
9132
|
"locationInModule": {
|
|
9133
9133
|
"filename": "src/index.ts",
|
|
9134
|
-
"line":
|
|
9134
|
+
"line": 13
|
|
9135
9135
|
},
|
|
9136
9136
|
"symbolId": "src/datadogv2/index:"
|
|
9137
9137
|
},
|
|
9138
9138
|
"@rio-cloud/cdk-v2-constructs.ecr": {
|
|
9139
9139
|
"locationInModule": {
|
|
9140
9140
|
"filename": "src/index.ts",
|
|
9141
|
-
"line":
|
|
9141
|
+
"line": 14
|
|
9142
9142
|
},
|
|
9143
9143
|
"symbolId": "src/ecr/index:"
|
|
9144
9144
|
},
|
|
9145
9145
|
"@rio-cloud/cdk-v2-constructs.fargate": {
|
|
9146
9146
|
"locationInModule": {
|
|
9147
9147
|
"filename": "src/index.ts",
|
|
9148
|
-
"line":
|
|
9148
|
+
"line": 15
|
|
9149
9149
|
},
|
|
9150
9150
|
"symbolId": "src/fargate/index:"
|
|
9151
9151
|
},
|
|
9152
9152
|
"@rio-cloud/cdk-v2-constructs.kafka": {
|
|
9153
9153
|
"locationInModule": {
|
|
9154
9154
|
"filename": "src/index.ts",
|
|
9155
|
-
"line":
|
|
9155
|
+
"line": 20
|
|
9156
9156
|
},
|
|
9157
9157
|
"symbolId": "src/kafka/index:"
|
|
9158
9158
|
},
|
|
9159
9159
|
"@rio-cloud/cdk-v2-constructs.ses": {
|
|
9160
9160
|
"locationInModule": {
|
|
9161
9161
|
"filename": "src/index.ts",
|
|
9162
|
-
"line":
|
|
9162
|
+
"line": 26
|
|
9163
9163
|
},
|
|
9164
9164
|
"symbolId": "src/ses/index:"
|
|
9165
9165
|
},
|
|
9166
9166
|
"@rio-cloud/cdk-v2-constructs.watchfulv2": {
|
|
9167
9167
|
"locationInModule": {
|
|
9168
9168
|
"filename": "src/index.ts",
|
|
9169
|
-
"line":
|
|
9169
|
+
"line": 29
|
|
9170
9170
|
},
|
|
9171
9171
|
"symbolId": "src/watchfulv2/index:"
|
|
9172
9172
|
}
|
|
@@ -9866,6 +9866,7 @@
|
|
|
9866
9866
|
"@rio-cloud/cdk-v2-constructs.BackupPolicy": {
|
|
9867
9867
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
9868
9868
|
"docs": {
|
|
9869
|
+
"remarks": "Apply this to stateful resources that must be discovered by the RIO landing-zone backup solution.\n\nExample:\n```ts\nBackupPolicy.apply(table, Criticality.HIGH);\n```",
|
|
9869
9870
|
"stability": "stable",
|
|
9870
9871
|
"summary": "Helper function to tag constructs with correct backup values to be picked up by the rio landing zone backup solution."
|
|
9871
9872
|
},
|
|
@@ -9878,7 +9879,7 @@
|
|
|
9878
9879
|
"kind": "class",
|
|
9879
9880
|
"locationInModule": {
|
|
9880
9881
|
"filename": "src/backup/backup-policy.ts",
|
|
9881
|
-
"line":
|
|
9882
|
+
"line": 24
|
|
9882
9883
|
},
|
|
9883
9884
|
"methods": [
|
|
9884
9885
|
{
|
|
@@ -9887,7 +9888,7 @@
|
|
|
9887
9888
|
},
|
|
9888
9889
|
"locationInModule": {
|
|
9889
9890
|
"filename": "src/backup/backup-policy.ts",
|
|
9890
|
-
"line":
|
|
9891
|
+
"line": 25
|
|
9891
9892
|
},
|
|
9892
9893
|
"name": "apply",
|
|
9893
9894
|
"parameters": [
|
|
@@ -10216,7 +10217,7 @@
|
|
|
10216
10217
|
"@rio-cloud/cdk-v2-constructs.ClassifyPipelineType": {
|
|
10217
10218
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
10218
10219
|
"docs": {
|
|
10219
|
-
"remarks": "These tags are eventually used in datadog pipeline metrics to filter specific pipeline types\nEg - you can decide to not monitor branch pipelines",
|
|
10220
|
+
"remarks": "These tags are eventually used in datadog pipeline metrics to filter specific pipeline types\nEg - you can decide to not monitor branch pipelines\n\nExample:\n```ts\nClassifyPipelineType.apply(pipeline, RioPipelineType.DEPLOY);\n```",
|
|
10220
10221
|
"stability": "stable",
|
|
10221
10222
|
"summary": "Helper function to tag the pipeline with correct pipeline type."
|
|
10222
10223
|
},
|
|
@@ -10229,7 +10230,7 @@
|
|
|
10229
10230
|
"kind": "class",
|
|
10230
10231
|
"locationInModule": {
|
|
10231
10232
|
"filename": "src/pipeline/rio-pipeline-type.ts",
|
|
10232
|
-
"line":
|
|
10233
|
+
"line": 34
|
|
10233
10234
|
},
|
|
10234
10235
|
"methods": [
|
|
10235
10236
|
{
|
|
@@ -10238,7 +10239,7 @@
|
|
|
10238
10239
|
},
|
|
10239
10240
|
"locationInModule": {
|
|
10240
10241
|
"filename": "src/pipeline/rio-pipeline-type.ts",
|
|
10241
|
-
"line":
|
|
10242
|
+
"line": 35
|
|
10242
10243
|
},
|
|
10243
10244
|
"name": "apply",
|
|
10244
10245
|
"parameters": [
|
|
@@ -14069,8 +14070,9 @@
|
|
|
14069
14070
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
14070
14071
|
"base": "constructs.Construct",
|
|
14071
14072
|
"docs": {
|
|
14073
|
+
"remarks": "Prefer this construct for new topics. Keep the default retention and partition count unless there is a concrete\noperational requirement to change them. Partition increases are permanent and may require coordination with CLAID\nwhen service limits are exceeded.\n\nExample:\n```ts\nnew KafkaTopicV4(this, 'EventsTopic', {\n name: 'billing-view.events',\n metadata: {\n description: 'Domain events emitted by Billing View.',\n audience: 'company-internal',\n recoveryPolicy: 'recoverable',\n },\n acl: {\n write: ['billing-view'],\n read: ['billing-consumer'],\n },\n isLogCompacted: false,\n});\n```",
|
|
14072
14074
|
"stability": "stable",
|
|
14073
|
-
"summary": "Construct to create a
|
|
14075
|
+
"summary": "Construct to create a version 4 RIO Kafka topic."
|
|
14074
14076
|
},
|
|
14075
14077
|
"fqn": "@rio-cloud/cdk-v2-constructs.KafkaTopicV4",
|
|
14076
14078
|
"initializer": {
|
|
@@ -14079,7 +14081,7 @@
|
|
|
14079
14081
|
},
|
|
14080
14082
|
"locationInModule": {
|
|
14081
14083
|
"filename": "src/kafka/kafka-topic.ts",
|
|
14082
|
-
"line":
|
|
14084
|
+
"line": 302
|
|
14083
14085
|
},
|
|
14084
14086
|
"parameters": [
|
|
14085
14087
|
{
|
|
@@ -14105,7 +14107,7 @@
|
|
|
14105
14107
|
"kind": "class",
|
|
14106
14108
|
"locationInModule": {
|
|
14107
14109
|
"filename": "src/kafka/kafka-topic.ts",
|
|
14108
|
-
"line":
|
|
14110
|
+
"line": 301
|
|
14109
14111
|
},
|
|
14110
14112
|
"name": "KafkaTopicV4",
|
|
14111
14113
|
"symbolId": "src/kafka/kafka-topic:KafkaTopicV4"
|
|
@@ -15123,6 +15125,572 @@
|
|
|
15123
15125
|
],
|
|
15124
15126
|
"symbolId": "src/watchful/watchful:OverrideAlarmThresholdProps"
|
|
15125
15127
|
},
|
|
15128
|
+
"@rio-cloud/cdk-v2-constructs.ParallelBuildProject": {
|
|
15129
|
+
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15130
|
+
"base": "aws-cdk-lib.aws_codebuild.PipelineProject",
|
|
15131
|
+
"docs": {
|
|
15132
|
+
"stability": "stable",
|
|
15133
|
+
"summary": "CodeBuild project for parallel pipeline build work."
|
|
15134
|
+
},
|
|
15135
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.ParallelBuildProject",
|
|
15136
|
+
"initializer": {
|
|
15137
|
+
"docs": {
|
|
15138
|
+
"stability": "stable"
|
|
15139
|
+
},
|
|
15140
|
+
"locationInModule": {
|
|
15141
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15142
|
+
"line": 142
|
|
15143
|
+
},
|
|
15144
|
+
"parameters": [
|
|
15145
|
+
{
|
|
15146
|
+
"name": "scope",
|
|
15147
|
+
"type": {
|
|
15148
|
+
"fqn": "constructs.Construct"
|
|
15149
|
+
}
|
|
15150
|
+
},
|
|
15151
|
+
{
|
|
15152
|
+
"name": "id",
|
|
15153
|
+
"type": {
|
|
15154
|
+
"primitive": "string"
|
|
15155
|
+
}
|
|
15156
|
+
},
|
|
15157
|
+
{
|
|
15158
|
+
"name": "props",
|
|
15159
|
+
"type": {
|
|
15160
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.ParallelBuildProjectProps"
|
|
15161
|
+
}
|
|
15162
|
+
}
|
|
15163
|
+
]
|
|
15164
|
+
},
|
|
15165
|
+
"kind": "class",
|
|
15166
|
+
"locationInModule": {
|
|
15167
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15168
|
+
"line": 136
|
|
15169
|
+
},
|
|
15170
|
+
"name": "ParallelBuildProject",
|
|
15171
|
+
"properties": [
|
|
15172
|
+
{
|
|
15173
|
+
"docs": {
|
|
15174
|
+
"stability": "stable",
|
|
15175
|
+
"summary": "Hash of buildspec, project environment, and action-level environment inputs."
|
|
15176
|
+
},
|
|
15177
|
+
"immutable": true,
|
|
15178
|
+
"locationInModule": {
|
|
15179
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15180
|
+
"line": 140
|
|
15181
|
+
},
|
|
15182
|
+
"name": "projectConfigHash",
|
|
15183
|
+
"type": {
|
|
15184
|
+
"primitive": "string"
|
|
15185
|
+
}
|
|
15186
|
+
}
|
|
15187
|
+
],
|
|
15188
|
+
"symbolId": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project:ParallelBuildProject"
|
|
15189
|
+
},
|
|
15190
|
+
"@rio-cloud/cdk-v2-constructs.ParallelBuildProjectProps": {
|
|
15191
|
+
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15192
|
+
"datatype": true,
|
|
15193
|
+
"docs": {
|
|
15194
|
+
"stability": "stable",
|
|
15195
|
+
"summary": "Properties for a CodeBuild project that is injected as a parallel CodePipeline action."
|
|
15196
|
+
},
|
|
15197
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.ParallelBuildProjectProps",
|
|
15198
|
+
"kind": "interface",
|
|
15199
|
+
"locationInModule": {
|
|
15200
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15201
|
+
"line": 17
|
|
15202
|
+
},
|
|
15203
|
+
"name": "ParallelBuildProjectProps",
|
|
15204
|
+
"properties": [
|
|
15205
|
+
{
|
|
15206
|
+
"abstract": true,
|
|
15207
|
+
"docs": {
|
|
15208
|
+
"stability": "stable",
|
|
15209
|
+
"summary": "Path to the buildspec yaml file, resolved from the consuming CDK app's current working directory."
|
|
15210
|
+
},
|
|
15211
|
+
"immutable": true,
|
|
15212
|
+
"locationInModule": {
|
|
15213
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15214
|
+
"line": 21
|
|
15215
|
+
},
|
|
15216
|
+
"name": "buildSpecPath",
|
|
15217
|
+
"type": {
|
|
15218
|
+
"primitive": "string"
|
|
15219
|
+
}
|
|
15220
|
+
},
|
|
15221
|
+
{
|
|
15222
|
+
"abstract": true,
|
|
15223
|
+
"docs": {
|
|
15224
|
+
"stability": "stable",
|
|
15225
|
+
"summary": "Name of the hosted zone."
|
|
15226
|
+
},
|
|
15227
|
+
"immutable": true,
|
|
15228
|
+
"locationInModule": {
|
|
15229
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15230
|
+
"line": 31
|
|
15231
|
+
},
|
|
15232
|
+
"name": "hostedZoneName",
|
|
15233
|
+
"type": {
|
|
15234
|
+
"primitive": "string"
|
|
15235
|
+
}
|
|
15236
|
+
},
|
|
15237
|
+
{
|
|
15238
|
+
"abstract": true,
|
|
15239
|
+
"docs": {
|
|
15240
|
+
"stability": "stable",
|
|
15241
|
+
"summary": "Name of the service."
|
|
15242
|
+
},
|
|
15243
|
+
"immutable": true,
|
|
15244
|
+
"locationInModule": {
|
|
15245
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15246
|
+
"line": 26
|
|
15247
|
+
},
|
|
15248
|
+
"name": "serviceName",
|
|
15249
|
+
"type": {
|
|
15250
|
+
"primitive": "string"
|
|
15251
|
+
}
|
|
15252
|
+
},
|
|
15253
|
+
{
|
|
15254
|
+
"abstract": true,
|
|
15255
|
+
"docs": {
|
|
15256
|
+
"stability": "stable",
|
|
15257
|
+
"summary": "Additional project-level environment variables."
|
|
15258
|
+
},
|
|
15259
|
+
"immutable": true,
|
|
15260
|
+
"locationInModule": {
|
|
15261
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15262
|
+
"line": 67
|
|
15263
|
+
},
|
|
15264
|
+
"name": "additionalEnvironmentVariables",
|
|
15265
|
+
"optional": true,
|
|
15266
|
+
"type": {
|
|
15267
|
+
"collection": {
|
|
15268
|
+
"elementtype": {
|
|
15269
|
+
"fqn": "aws-cdk-lib.aws_codebuild.BuildEnvironmentVariable"
|
|
15270
|
+
},
|
|
15271
|
+
"kind": "map"
|
|
15272
|
+
}
|
|
15273
|
+
}
|
|
15274
|
+
},
|
|
15275
|
+
{
|
|
15276
|
+
"abstract": true,
|
|
15277
|
+
"docs": {
|
|
15278
|
+
"remarks": "Defaults to the ARM Amazon Linux 2023 standard image used by WebEDI-style services.",
|
|
15279
|
+
"stability": "stable",
|
|
15280
|
+
"summary": "Build image for the project."
|
|
15281
|
+
},
|
|
15282
|
+
"immutable": true,
|
|
15283
|
+
"locationInModule": {
|
|
15284
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15285
|
+
"line": 55
|
|
15286
|
+
},
|
|
15287
|
+
"name": "buildImage",
|
|
15288
|
+
"optional": true,
|
|
15289
|
+
"type": {
|
|
15290
|
+
"fqn": "aws-cdk-lib.aws_codebuild.IBuildImage"
|
|
15291
|
+
}
|
|
15292
|
+
},
|
|
15293
|
+
{
|
|
15294
|
+
"abstract": true,
|
|
15295
|
+
"docs": {
|
|
15296
|
+
"stability": "stable",
|
|
15297
|
+
"summary": "Caching strategy to use."
|
|
15298
|
+
},
|
|
15299
|
+
"immutable": true,
|
|
15300
|
+
"locationInModule": {
|
|
15301
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15302
|
+
"line": 48
|
|
15303
|
+
},
|
|
15304
|
+
"name": "cache",
|
|
15305
|
+
"optional": true,
|
|
15306
|
+
"type": {
|
|
15307
|
+
"fqn": "aws-cdk-lib.aws_codebuild.Cache"
|
|
15308
|
+
}
|
|
15309
|
+
},
|
|
15310
|
+
{
|
|
15311
|
+
"abstract": true,
|
|
15312
|
+
"docs": {
|
|
15313
|
+
"remarks": "Defaults to `BUILD_GENERAL1_LARGE`.",
|
|
15314
|
+
"stability": "stable",
|
|
15315
|
+
"summary": "Compute type for the project."
|
|
15316
|
+
},
|
|
15317
|
+
"immutable": true,
|
|
15318
|
+
"locationInModule": {
|
|
15319
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15320
|
+
"line": 62
|
|
15321
|
+
},
|
|
15322
|
+
"name": "computeType",
|
|
15323
|
+
"optional": true,
|
|
15324
|
+
"type": {
|
|
15325
|
+
"fqn": "aws-cdk-lib.aws_codebuild.ComputeType"
|
|
15326
|
+
}
|
|
15327
|
+
},
|
|
15328
|
+
{
|
|
15329
|
+
"abstract": true,
|
|
15330
|
+
"docs": {
|
|
15331
|
+
"stability": "stable",
|
|
15332
|
+
"summary": "Action-level environment values used when calculating `projectConfigHash`."
|
|
15333
|
+
},
|
|
15334
|
+
"immutable": true,
|
|
15335
|
+
"locationInModule": {
|
|
15336
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15337
|
+
"line": 43
|
|
15338
|
+
},
|
|
15339
|
+
"name": "env",
|
|
15340
|
+
"optional": true,
|
|
15341
|
+
"type": {
|
|
15342
|
+
"collection": {
|
|
15343
|
+
"elementtype": {
|
|
15344
|
+
"primitive": "string"
|
|
15345
|
+
},
|
|
15346
|
+
"kind": "map"
|
|
15347
|
+
}
|
|
15348
|
+
}
|
|
15349
|
+
},
|
|
15350
|
+
{
|
|
15351
|
+
"abstract": true,
|
|
15352
|
+
"docs": {
|
|
15353
|
+
"remarks": "When provided, its URI is exposed as `REPO_URI`.",
|
|
15354
|
+
"stability": "stable",
|
|
15355
|
+
"summary": "Repository used by image build steps."
|
|
15356
|
+
},
|
|
15357
|
+
"immutable": true,
|
|
15358
|
+
"locationInModule": {
|
|
15359
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project.ts",
|
|
15360
|
+
"line": 38
|
|
15361
|
+
},
|
|
15362
|
+
"name": "repo",
|
|
15363
|
+
"optional": true,
|
|
15364
|
+
"type": {
|
|
15365
|
+
"fqn": "aws-cdk-lib.aws_ecr.IRepository"
|
|
15366
|
+
}
|
|
15367
|
+
}
|
|
15368
|
+
],
|
|
15369
|
+
"symbolId": "src/contributions/team-shipper-inbound-blue/pipeline/code-build-project:ParallelBuildProjectProps"
|
|
15370
|
+
},
|
|
15371
|
+
"@rio-cloud/cdk-v2-constructs.PipelineBuildActionProps": {
|
|
15372
|
+
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15373
|
+
"datatype": true,
|
|
15374
|
+
"docs": {
|
|
15375
|
+
"stability": "stable",
|
|
15376
|
+
"summary": "Properties for a CodeBuild action added by `PipelineBuildStageActions`."
|
|
15377
|
+
},
|
|
15378
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.PipelineBuildActionProps",
|
|
15379
|
+
"interfaces": [
|
|
15380
|
+
"aws-cdk-lib.aws_codepipeline.CommonAwsActionProps"
|
|
15381
|
+
],
|
|
15382
|
+
"kind": "interface",
|
|
15383
|
+
"locationInModule": {
|
|
15384
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15385
|
+
"line": 25
|
|
15386
|
+
},
|
|
15387
|
+
"name": "PipelineBuildActionProps",
|
|
15388
|
+
"properties": [
|
|
15389
|
+
{
|
|
15390
|
+
"abstract": true,
|
|
15391
|
+
"docs": {
|
|
15392
|
+
"stability": "stable",
|
|
15393
|
+
"summary": "The action's CodeBuild project."
|
|
15394
|
+
},
|
|
15395
|
+
"immutable": true,
|
|
15396
|
+
"locationInModule": {
|
|
15397
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15398
|
+
"line": 39
|
|
15399
|
+
},
|
|
15400
|
+
"name": "project",
|
|
15401
|
+
"type": {
|
|
15402
|
+
"fqn": "aws-cdk-lib.aws_codebuild.IProject"
|
|
15403
|
+
}
|
|
15404
|
+
},
|
|
15405
|
+
{
|
|
15406
|
+
"abstract": true,
|
|
15407
|
+
"docs": {
|
|
15408
|
+
"default": "CodeBuildActionType.BUILD",
|
|
15409
|
+
"stability": "stable",
|
|
15410
|
+
"summary": "The type of CodeBuild action."
|
|
15411
|
+
},
|
|
15412
|
+
"immutable": true,
|
|
15413
|
+
"locationInModule": {
|
|
15414
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15415
|
+
"line": 46
|
|
15416
|
+
},
|
|
15417
|
+
"name": "actionType",
|
|
15418
|
+
"optional": true,
|
|
15419
|
+
"type": {
|
|
15420
|
+
"fqn": "aws-cdk-lib.aws_codepipeline_actions.CodeBuildActionType"
|
|
15421
|
+
}
|
|
15422
|
+
},
|
|
15423
|
+
{
|
|
15424
|
+
"abstract": true,
|
|
15425
|
+
"docs": {
|
|
15426
|
+
"default": "true",
|
|
15427
|
+
"stability": "stable",
|
|
15428
|
+
"summary": "Whether to check for secrets in plaintext environment variables."
|
|
15429
|
+
},
|
|
15430
|
+
"immutable": true,
|
|
15431
|
+
"locationInModule": {
|
|
15432
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15433
|
+
"line": 58
|
|
15434
|
+
},
|
|
15435
|
+
"name": "checkSecretsInPlainTextEnvVariables",
|
|
15436
|
+
"optional": true,
|
|
15437
|
+
"type": {
|
|
15438
|
+
"primitive": "boolean"
|
|
15439
|
+
}
|
|
15440
|
+
},
|
|
15441
|
+
{
|
|
15442
|
+
"abstract": true,
|
|
15443
|
+
"docs": {
|
|
15444
|
+
"default": "false",
|
|
15445
|
+
"stability": "stable",
|
|
15446
|
+
"summary": "Combine build artifacts for batch builds."
|
|
15447
|
+
},
|
|
15448
|
+
"immutable": true,
|
|
15449
|
+
"locationInModule": {
|
|
15450
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15451
|
+
"line": 72
|
|
15452
|
+
},
|
|
15453
|
+
"name": "combineBatchBuildArtifacts",
|
|
15454
|
+
"optional": true,
|
|
15455
|
+
"type": {
|
|
15456
|
+
"primitive": "boolean"
|
|
15457
|
+
}
|
|
15458
|
+
},
|
|
15459
|
+
{
|
|
15460
|
+
"abstract": true,
|
|
15461
|
+
"docs": {
|
|
15462
|
+
"stability": "stable",
|
|
15463
|
+
"summary": "Environment variables to pass to the CodeBuild project when this action executes."
|
|
15464
|
+
},
|
|
15465
|
+
"immutable": true,
|
|
15466
|
+
"locationInModule": {
|
|
15467
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15468
|
+
"line": 51
|
|
15469
|
+
},
|
|
15470
|
+
"name": "environmentVariables",
|
|
15471
|
+
"optional": true,
|
|
15472
|
+
"type": {
|
|
15473
|
+
"collection": {
|
|
15474
|
+
"elementtype": {
|
|
15475
|
+
"fqn": "aws-cdk-lib.aws_codebuild.BuildEnvironmentVariable"
|
|
15476
|
+
},
|
|
15477
|
+
"kind": "map"
|
|
15478
|
+
}
|
|
15479
|
+
}
|
|
15480
|
+
},
|
|
15481
|
+
{
|
|
15482
|
+
"abstract": true,
|
|
15483
|
+
"docs": {
|
|
15484
|
+
"default": "false",
|
|
15485
|
+
"stability": "stable",
|
|
15486
|
+
"summary": "Trigger a batch build."
|
|
15487
|
+
},
|
|
15488
|
+
"immutable": true,
|
|
15489
|
+
"locationInModule": {
|
|
15490
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15491
|
+
"line": 65
|
|
15492
|
+
},
|
|
15493
|
+
"name": "executeBatchBuild",
|
|
15494
|
+
"optional": true,
|
|
15495
|
+
"type": {
|
|
15496
|
+
"primitive": "boolean"
|
|
15497
|
+
}
|
|
15498
|
+
},
|
|
15499
|
+
{
|
|
15500
|
+
"abstract": true,
|
|
15501
|
+
"docs": {
|
|
15502
|
+
"stability": "stable",
|
|
15503
|
+
"summary": "The list of additional input artifacts for this action."
|
|
15504
|
+
},
|
|
15505
|
+
"immutable": true,
|
|
15506
|
+
"locationInModule": {
|
|
15507
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15508
|
+
"line": 29
|
|
15509
|
+
},
|
|
15510
|
+
"name": "extraInputs",
|
|
15511
|
+
"optional": true,
|
|
15512
|
+
"type": {
|
|
15513
|
+
"collection": {
|
|
15514
|
+
"elementtype": {
|
|
15515
|
+
"fqn": "aws-cdk-lib.aws_codepipeline.Artifact"
|
|
15516
|
+
},
|
|
15517
|
+
"kind": "array"
|
|
15518
|
+
}
|
|
15519
|
+
}
|
|
15520
|
+
},
|
|
15521
|
+
{
|
|
15522
|
+
"abstract": true,
|
|
15523
|
+
"docs": {
|
|
15524
|
+
"stability": "stable",
|
|
15525
|
+
"summary": "The list of output artifacts for this action."
|
|
15526
|
+
},
|
|
15527
|
+
"immutable": true,
|
|
15528
|
+
"locationInModule": {
|
|
15529
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15530
|
+
"line": 34
|
|
15531
|
+
},
|
|
15532
|
+
"name": "outputs",
|
|
15533
|
+
"optional": true,
|
|
15534
|
+
"type": {
|
|
15535
|
+
"collection": {
|
|
15536
|
+
"elementtype": {
|
|
15537
|
+
"fqn": "aws-cdk-lib.aws_codepipeline.Artifact"
|
|
15538
|
+
},
|
|
15539
|
+
"kind": "array"
|
|
15540
|
+
}
|
|
15541
|
+
}
|
|
15542
|
+
}
|
|
15543
|
+
],
|
|
15544
|
+
"symbolId": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions:PipelineBuildActionProps"
|
|
15545
|
+
},
|
|
15546
|
+
"@rio-cloud/cdk-v2-constructs.PipelineBuildStageActions": {
|
|
15547
|
+
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15548
|
+
"base": "constructs.Construct",
|
|
15549
|
+
"docs": {
|
|
15550
|
+
"stability": "stable",
|
|
15551
|
+
"summary": "Adds CodeBuild actions next to an existing action in the same pipeline stage."
|
|
15552
|
+
},
|
|
15553
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.PipelineBuildStageActions",
|
|
15554
|
+
"initializer": {
|
|
15555
|
+
"docs": {
|
|
15556
|
+
"stability": "stable"
|
|
15557
|
+
},
|
|
15558
|
+
"locationInModule": {
|
|
15559
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15560
|
+
"line": 89
|
|
15561
|
+
},
|
|
15562
|
+
"parameters": [
|
|
15563
|
+
{
|
|
15564
|
+
"name": "scope",
|
|
15565
|
+
"type": {
|
|
15566
|
+
"fqn": "constructs.Construct"
|
|
15567
|
+
}
|
|
15568
|
+
},
|
|
15569
|
+
{
|
|
15570
|
+
"name": "id",
|
|
15571
|
+
"type": {
|
|
15572
|
+
"primitive": "string"
|
|
15573
|
+
}
|
|
15574
|
+
},
|
|
15575
|
+
{
|
|
15576
|
+
"name": "props",
|
|
15577
|
+
"type": {
|
|
15578
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.PipelineBuildStageActionsProps"
|
|
15579
|
+
}
|
|
15580
|
+
}
|
|
15581
|
+
]
|
|
15582
|
+
},
|
|
15583
|
+
"kind": "class",
|
|
15584
|
+
"locationInModule": {
|
|
15585
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15586
|
+
"line": 78
|
|
15587
|
+
},
|
|
15588
|
+
"methods": [
|
|
15589
|
+
{
|
|
15590
|
+
"docs": {
|
|
15591
|
+
"stability": "stable",
|
|
15592
|
+
"summary": "Adds a CodeBuild action using the located action's first input artifact."
|
|
15593
|
+
},
|
|
15594
|
+
"locationInModule": {
|
|
15595
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15596
|
+
"line": 107
|
|
15597
|
+
},
|
|
15598
|
+
"name": "addBuildAction",
|
|
15599
|
+
"parameters": [
|
|
15600
|
+
{
|
|
15601
|
+
"name": "props",
|
|
15602
|
+
"type": {
|
|
15603
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.PipelineBuildActionProps"
|
|
15604
|
+
}
|
|
15605
|
+
}
|
|
15606
|
+
]
|
|
15607
|
+
}
|
|
15608
|
+
],
|
|
15609
|
+
"name": "PipelineBuildStageActions",
|
|
15610
|
+
"properties": [
|
|
15611
|
+
{
|
|
15612
|
+
"docs": {
|
|
15613
|
+
"stability": "stable",
|
|
15614
|
+
"summary": "First input artifact of the located action."
|
|
15615
|
+
},
|
|
15616
|
+
"immutable": true,
|
|
15617
|
+
"locationInModule": {
|
|
15618
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15619
|
+
"line": 87
|
|
15620
|
+
},
|
|
15621
|
+
"name": "sourceArtifact",
|
|
15622
|
+
"type": {
|
|
15623
|
+
"fqn": "aws-cdk-lib.aws_codepipeline.Artifact"
|
|
15624
|
+
}
|
|
15625
|
+
},
|
|
15626
|
+
{
|
|
15627
|
+
"docs": {
|
|
15628
|
+
"stability": "stable",
|
|
15629
|
+
"summary": "Stage that contains the located action."
|
|
15630
|
+
},
|
|
15631
|
+
"immutable": true,
|
|
15632
|
+
"locationInModule": {
|
|
15633
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15634
|
+
"line": 82
|
|
15635
|
+
},
|
|
15636
|
+
"name": "stage",
|
|
15637
|
+
"type": {
|
|
15638
|
+
"fqn": "aws-cdk-lib.aws_codepipeline.IStage"
|
|
15639
|
+
}
|
|
15640
|
+
}
|
|
15641
|
+
],
|
|
15642
|
+
"symbolId": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions:PipelineBuildStageActions"
|
|
15643
|
+
},
|
|
15644
|
+
"@rio-cloud/cdk-v2-constructs.PipelineBuildStageActionsProps": {
|
|
15645
|
+
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15646
|
+
"datatype": true,
|
|
15647
|
+
"docs": {
|
|
15648
|
+
"stability": "stable",
|
|
15649
|
+
"summary": "Properties for locating an existing generated CodePipeline action."
|
|
15650
|
+
},
|
|
15651
|
+
"fqn": "@rio-cloud/cdk-v2-constructs.PipelineBuildStageActionsProps",
|
|
15652
|
+
"kind": "interface",
|
|
15653
|
+
"locationInModule": {
|
|
15654
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15655
|
+
"line": 10
|
|
15656
|
+
},
|
|
15657
|
+
"name": "PipelineBuildStageActionsProps",
|
|
15658
|
+
"properties": [
|
|
15659
|
+
{
|
|
15660
|
+
"abstract": true,
|
|
15661
|
+
"docs": {
|
|
15662
|
+
"stability": "stable",
|
|
15663
|
+
"summary": "Name of the action whose input artifact should be reused."
|
|
15664
|
+
},
|
|
15665
|
+
"immutable": true,
|
|
15666
|
+
"locationInModule": {
|
|
15667
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15668
|
+
"line": 19
|
|
15669
|
+
},
|
|
15670
|
+
"name": "actionName",
|
|
15671
|
+
"type": {
|
|
15672
|
+
"primitive": "string"
|
|
15673
|
+
}
|
|
15674
|
+
},
|
|
15675
|
+
{
|
|
15676
|
+
"abstract": true,
|
|
15677
|
+
"docs": {
|
|
15678
|
+
"stability": "stable",
|
|
15679
|
+
"summary": "The underlying CodePipeline generated by `aws-cdk-lib/pipelines.CodePipeline`."
|
|
15680
|
+
},
|
|
15681
|
+
"immutable": true,
|
|
15682
|
+
"locationInModule": {
|
|
15683
|
+
"filename": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions.ts",
|
|
15684
|
+
"line": 14
|
|
15685
|
+
},
|
|
15686
|
+
"name": "pipeline",
|
|
15687
|
+
"type": {
|
|
15688
|
+
"fqn": "aws-cdk-lib.aws_codepipeline.Pipeline"
|
|
15689
|
+
}
|
|
15690
|
+
}
|
|
15691
|
+
],
|
|
15692
|
+
"symbolId": "src/contributions/team-shipper-inbound-blue/pipeline/pipeline-build-stage-actions:PipelineBuildStageActionsProps"
|
|
15693
|
+
},
|
|
15126
15694
|
"@rio-cloud/cdk-v2-constructs.PipelineFeatures": {
|
|
15127
15695
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
15128
15696
|
"datatype": true,
|
|
@@ -16053,7 +16621,9 @@
|
|
|
16053
16621
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
16054
16622
|
"base": "constructs.Construct",
|
|
16055
16623
|
"docs": {
|
|
16056
|
-
"
|
|
16624
|
+
"remarks": "This construct bundles the pieces that most RIO backend services need:\nan ECS task definition, the application container, a Datadog sidecar,\noptional FireLens log routing, optional ALB target group wiring, and the\nECS Fargate service itself.\n\nIt also derives Datadog tags and environment variables from `stage`,\n`serviceName`, `version`, the AWS account, and the standard RIO landing-zone\nSSM parameters. Do not set `DD_ENV`, `DD_SERVICE`, `DD_VERSION`, `DD_TAGS`,\nor `DD_LOGS_INJECTION` manually in the application container environment.\n\nUse this construct when you want the RIO paved road for a web-facing or\nservice-style Fargate workload and you want the defaults for observability,\nDatadog service catalog registration, and common AWS wiring to be handled\nfor you.\nIf you need a fully custom ECS setup, or a different deployment strategy\nsuch as blue/green, use a lower-level construct or the blue/green variant\ninstead.\n\nTo use it, provide:\n- `stage`, `serviceName`, and `version` for service identity\n- `vpc` and optionally an existing `cluster`\n- `containerDefinitionOption.image` for the application image\n- `fargateOptions.cpu` and `fargateOptions.memoryLimitMiB` for task sizing\n- optional `datadogOptions`, `frameworks`, and `loadBalancerOptions`\n\nExample:\n```ts\nconst service = new RioFargateService(this, 'Service', {\n stage: 'prod',\n serviceName: 'billing-view',\n version: process.env.GIT_VERSION ?? 'local',\n vpc: RioLandingZone.getDefaultVpc(this),\n containerDefinitionOption: {\n image: ecs.ContainerImage.fromRegistry('example/billing-view:latest'),\n },\n fargateOptions: {\n cpu: 512,\n memoryLimitMiB: 1024,\n },\n});\n```",
|
|
16625
|
+
"stability": "stable",
|
|
16626
|
+
"summary": "Creates an opinionated ECS Fargate service for RIO applications."
|
|
16057
16627
|
},
|
|
16058
16628
|
"fqn": "@rio-cloud/cdk-v2-constructs.RioFargateService",
|
|
16059
16629
|
"initializer": {
|
|
@@ -16062,7 +16632,7 @@
|
|
|
16062
16632
|
},
|
|
16063
16633
|
"locationInModule": {
|
|
16064
16634
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16065
|
-
"line":
|
|
16635
|
+
"line": 451
|
|
16066
16636
|
},
|
|
16067
16637
|
"parameters": [
|
|
16068
16638
|
{
|
|
@@ -16091,7 +16661,7 @@
|
|
|
16091
16661
|
"kind": "class",
|
|
16092
16662
|
"locationInModule": {
|
|
16093
16663
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16094
|
-
"line":
|
|
16664
|
+
"line": 410
|
|
16095
16665
|
},
|
|
16096
16666
|
"name": "RioFargateService",
|
|
16097
16667
|
"properties": [
|
|
@@ -16103,7 +16673,7 @@
|
|
|
16103
16673
|
"immutable": true,
|
|
16104
16674
|
"locationInModule": {
|
|
16105
16675
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16106
|
-
"line":
|
|
16676
|
+
"line": 447
|
|
16107
16677
|
},
|
|
16108
16678
|
"name": "connections",
|
|
16109
16679
|
"overrides": "aws-cdk-lib.aws_ec2.IConnectable",
|
|
@@ -16118,7 +16688,7 @@
|
|
|
16118
16688
|
"immutable": true,
|
|
16119
16689
|
"locationInModule": {
|
|
16120
16690
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16121
|
-
"line":
|
|
16691
|
+
"line": 443
|
|
16122
16692
|
},
|
|
16123
16693
|
"name": "datadogSideCarContainerDefinition",
|
|
16124
16694
|
"type": {
|
|
@@ -16132,7 +16702,7 @@
|
|
|
16132
16702
|
"immutable": true,
|
|
16133
16703
|
"locationInModule": {
|
|
16134
16704
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16135
|
-
"line":
|
|
16705
|
+
"line": 448
|
|
16136
16706
|
},
|
|
16137
16707
|
"name": "service",
|
|
16138
16708
|
"type": {
|
|
@@ -16146,7 +16716,7 @@
|
|
|
16146
16716
|
"immutable": true,
|
|
16147
16717
|
"locationInModule": {
|
|
16148
16718
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16149
|
-
"line":
|
|
16719
|
+
"line": 442
|
|
16150
16720
|
},
|
|
16151
16721
|
"name": "serviceContainerDefinition",
|
|
16152
16722
|
"type": {
|
|
@@ -16160,7 +16730,7 @@
|
|
|
16160
16730
|
"immutable": true,
|
|
16161
16731
|
"locationInModule": {
|
|
16162
16732
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16163
|
-
"line":
|
|
16733
|
+
"line": 445
|
|
16164
16734
|
},
|
|
16165
16735
|
"name": "taskDefinition",
|
|
16166
16736
|
"type": {
|
|
@@ -16174,7 +16744,7 @@
|
|
|
16174
16744
|
"immutable": true,
|
|
16175
16745
|
"locationInModule": {
|
|
16176
16746
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16177
|
-
"line":
|
|
16747
|
+
"line": 444
|
|
16178
16748
|
},
|
|
16179
16749
|
"name": "logRouterContainerDefinition",
|
|
16180
16750
|
"optional": true,
|
|
@@ -16189,7 +16759,7 @@
|
|
|
16189
16759
|
"immutable": true,
|
|
16190
16760
|
"locationInModule": {
|
|
16191
16761
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
16192
|
-
"line":
|
|
16762
|
+
"line": 449
|
|
16193
16763
|
},
|
|
16194
16764
|
"name": "targetGroup",
|
|
16195
16765
|
"optional": true,
|
|
@@ -16898,8 +17468,9 @@
|
|
|
16898
17468
|
"@rio-cloud/cdk-v2-constructs.RioLandingZone": {
|
|
16899
17469
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
16900
17470
|
"docs": {
|
|
17471
|
+
"remarks": "Use these helpers instead of hard-coded VPC IDs, hosted-zone IDs, subnet IDs, or standard team/account SSM parameter\nnames.\n\nExample:\n```ts\nconst vpc = RioLandingZone.getDefaultVpc(this);\nconst hostedZone = RioLandingZone.getDefaultHostedZone(this);\nconst teamIdentifier = RioLandingZone.getTeamIdentifierParameter(this).stringValue;\n```",
|
|
16901
17472
|
"stability": "stable",
|
|
16902
|
-
"summary": "A wrapper to access infrastructure provided by RIO
|
|
17473
|
+
"summary": "A wrapper to access infrastructure provided by the RIO Landing Zone setup, such as VPC, HostedZone, and standard team/account SSM parameters."
|
|
16903
17474
|
},
|
|
16904
17475
|
"fqn": "@rio-cloud/cdk-v2-constructs.RioLandingZone",
|
|
16905
17476
|
"initializer": {
|
|
@@ -16910,7 +17481,7 @@
|
|
|
16910
17481
|
"kind": "class",
|
|
16911
17482
|
"locationInModule": {
|
|
16912
17483
|
"filename": "src/rio-landing-zone.ts",
|
|
16913
|
-
"line":
|
|
17484
|
+
"line": 21
|
|
16914
17485
|
},
|
|
16915
17486
|
"methods": [
|
|
16916
17487
|
{
|
|
@@ -16919,7 +17490,7 @@
|
|
|
16919
17490
|
},
|
|
16920
17491
|
"locationInModule": {
|
|
16921
17492
|
"filename": "src/rio-landing-zone.ts",
|
|
16922
|
-
"line":
|
|
17493
|
+
"line": 86
|
|
16923
17494
|
},
|
|
16924
17495
|
"name": "getAccountNameParameter",
|
|
16925
17496
|
"parameters": [
|
|
@@ -16944,7 +17515,7 @@
|
|
|
16944
17515
|
},
|
|
16945
17516
|
"locationInModule": {
|
|
16946
17517
|
"filename": "src/rio-landing-zone.ts",
|
|
16947
|
-
"line":
|
|
17518
|
+
"line": 63
|
|
16948
17519
|
},
|
|
16949
17520
|
"name": "getDefaultHostedZone",
|
|
16950
17521
|
"parameters": [
|
|
@@ -16969,7 +17540,7 @@
|
|
|
16969
17540
|
},
|
|
16970
17541
|
"locationInModule": {
|
|
16971
17542
|
"filename": "src/rio-landing-zone.ts",
|
|
16972
|
-
"line":
|
|
17543
|
+
"line": 25
|
|
16973
17544
|
},
|
|
16974
17545
|
"name": "getDefaultVpc",
|
|
16975
17546
|
"parameters": [
|
|
@@ -16993,7 +17564,7 @@
|
|
|
16993
17564
|
},
|
|
16994
17565
|
"locationInModule": {
|
|
16995
17566
|
"filename": "src/rio-landing-zone.ts",
|
|
16996
|
-
"line":
|
|
17567
|
+
"line": 82
|
|
16997
17568
|
},
|
|
16998
17569
|
"name": "getTeamAlertSlackChannelParameter",
|
|
16999
17570
|
"parameters": [
|
|
@@ -17017,7 +17588,7 @@
|
|
|
17017
17588
|
},
|
|
17018
17589
|
"locationInModule": {
|
|
17019
17590
|
"filename": "src/rio-landing-zone.ts",
|
|
17020
|
-
"line":
|
|
17591
|
+
"line": 78
|
|
17021
17592
|
},
|
|
17022
17593
|
"name": "getTeamEmailParameter",
|
|
17023
17594
|
"parameters": [
|
|
@@ -17041,7 +17612,7 @@
|
|
|
17041
17612
|
},
|
|
17042
17613
|
"locationInModule": {
|
|
17043
17614
|
"filename": "src/rio-landing-zone.ts",
|
|
17044
|
-
"line":
|
|
17615
|
+
"line": 74
|
|
17045
17616
|
},
|
|
17046
17617
|
"name": "getTeamIdentifierParameter",
|
|
17047
17618
|
"parameters": [
|
|
@@ -17065,7 +17636,7 @@
|
|
|
17065
17636
|
},
|
|
17066
17637
|
"locationInModule": {
|
|
17067
17638
|
"filename": "src/rio-landing-zone.ts",
|
|
17068
|
-
"line":
|
|
17639
|
+
"line": 70
|
|
17069
17640
|
},
|
|
17070
17641
|
"name": "getTeamNameParameter",
|
|
17071
17642
|
"parameters": [
|
|
@@ -20368,6 +20939,7 @@
|
|
|
20368
20939
|
"@rio-cloud/cdk-v2-constructs.backup.BackupPolicy": {
|
|
20369
20940
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
20370
20941
|
"docs": {
|
|
20942
|
+
"remarks": "Apply this to stateful resources that must be discovered by the RIO landing-zone backup solution.\n\nExample:\n```ts\nBackupPolicy.apply(table, Criticality.HIGH);\n```",
|
|
20371
20943
|
"stability": "stable",
|
|
20372
20944
|
"summary": "Helper function to tag constructs with correct backup values to be picked up by the rio landing zone backup solution."
|
|
20373
20945
|
},
|
|
@@ -20380,7 +20952,7 @@
|
|
|
20380
20952
|
"kind": "class",
|
|
20381
20953
|
"locationInModule": {
|
|
20382
20954
|
"filename": "src/backup/backup-policy.ts",
|
|
20383
|
-
"line":
|
|
20955
|
+
"line": 24
|
|
20384
20956
|
},
|
|
20385
20957
|
"methods": [
|
|
20386
20958
|
{
|
|
@@ -20389,7 +20961,7 @@
|
|
|
20389
20961
|
},
|
|
20390
20962
|
"locationInModule": {
|
|
20391
20963
|
"filename": "src/backup/backup-policy.ts",
|
|
20392
|
-
"line":
|
|
20964
|
+
"line": 25
|
|
20393
20965
|
},
|
|
20394
20966
|
"name": "apply",
|
|
20395
20967
|
"parameters": [
|
|
@@ -24186,7 +24758,7 @@
|
|
|
24186
24758
|
},
|
|
24187
24759
|
"locationInModule": {
|
|
24188
24760
|
"filename": "src/datadogv2/datadog-slo.ts",
|
|
24189
|
-
"line":
|
|
24761
|
+
"line": 110
|
|
24190
24762
|
},
|
|
24191
24763
|
"parameters": [
|
|
24192
24764
|
{
|
|
@@ -24212,7 +24784,7 @@
|
|
|
24212
24784
|
"kind": "class",
|
|
24213
24785
|
"locationInModule": {
|
|
24214
24786
|
"filename": "src/datadogv2/datadog-slo.ts",
|
|
24215
|
-
"line":
|
|
24787
|
+
"line": 107
|
|
24216
24788
|
},
|
|
24217
24789
|
"name": "DatadogSlo",
|
|
24218
24790
|
"namespace": "datadogv2",
|
|
@@ -24224,7 +24796,7 @@
|
|
|
24224
24796
|
"immutable": true,
|
|
24225
24797
|
"locationInModule": {
|
|
24226
24798
|
"filename": "src/datadogv2/datadog-slo.ts",
|
|
24227
|
-
"line":
|
|
24799
|
+
"line": 156
|
|
24228
24800
|
},
|
|
24229
24801
|
"name": "sloId",
|
|
24230
24802
|
"type": {
|
|
@@ -25875,7 +26447,9 @@
|
|
|
25875
26447
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
25876
26448
|
"base": "constructs.Construct",
|
|
25877
26449
|
"docs": {
|
|
25878
|
-
"
|
|
26450
|
+
"remarks": "This construct bundles the pieces that most RIO backend services need:\nan ECS task definition, the application container, a Datadog sidecar,\noptional FireLens log routing, optional ALB target group wiring, and the\nECS Fargate service itself.\n\nIt also derives Datadog tags and environment variables from `stage`,\n`serviceName`, `version`, the AWS account, and the standard RIO landing-zone\nSSM parameters. Do not set `DD_ENV`, `DD_SERVICE`, `DD_VERSION`, `DD_TAGS`,\nor `DD_LOGS_INJECTION` manually in the application container environment.\n\nUse this construct when you want the RIO paved road for a web-facing or\nservice-style Fargate workload and you want the defaults for observability,\nDatadog service catalog registration, and common AWS wiring to be handled\nfor you.\nIf you need a fully custom ECS setup, or a different deployment strategy\nsuch as blue/green, use a lower-level construct or the blue/green variant\ninstead.\n\nTo use it, provide:\n- `stage`, `serviceName`, and `version` for service identity\n- `vpc` and optionally an existing `cluster`\n- `containerDefinitionOption.image` for the application image\n- `fargateOptions.cpu` and `fargateOptions.memoryLimitMiB` for task sizing\n- optional `datadogOptions`, `frameworks`, and `loadBalancerOptions`\n\nExample:\n```ts\nconst service = new RioFargateService(this, 'Service', {\n stage: 'prod',\n serviceName: 'billing-view',\n version: process.env.GIT_VERSION ?? 'local',\n vpc: RioLandingZone.getDefaultVpc(this),\n containerDefinitionOption: {\n image: ecs.ContainerImage.fromRegistry('example/billing-view:latest'),\n },\n fargateOptions: {\n cpu: 512,\n memoryLimitMiB: 1024,\n },\n});\n```",
|
|
26451
|
+
"stability": "stable",
|
|
26452
|
+
"summary": "Creates an opinionated ECS Fargate service for RIO applications."
|
|
25879
26453
|
},
|
|
25880
26454
|
"fqn": "@rio-cloud/cdk-v2-constructs.fargate.RioFargateService",
|
|
25881
26455
|
"initializer": {
|
|
@@ -25884,7 +26458,7 @@
|
|
|
25884
26458
|
},
|
|
25885
26459
|
"locationInModule": {
|
|
25886
26460
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25887
|
-
"line":
|
|
26461
|
+
"line": 451
|
|
25888
26462
|
},
|
|
25889
26463
|
"parameters": [
|
|
25890
26464
|
{
|
|
@@ -25913,7 +26487,7 @@
|
|
|
25913
26487
|
"kind": "class",
|
|
25914
26488
|
"locationInModule": {
|
|
25915
26489
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25916
|
-
"line":
|
|
26490
|
+
"line": 410
|
|
25917
26491
|
},
|
|
25918
26492
|
"name": "RioFargateService",
|
|
25919
26493
|
"namespace": "fargate",
|
|
@@ -25926,7 +26500,7 @@
|
|
|
25926
26500
|
"immutable": true,
|
|
25927
26501
|
"locationInModule": {
|
|
25928
26502
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25929
|
-
"line":
|
|
26503
|
+
"line": 447
|
|
25930
26504
|
},
|
|
25931
26505
|
"name": "connections",
|
|
25932
26506
|
"overrides": "aws-cdk-lib.aws_ec2.IConnectable",
|
|
@@ -25941,7 +26515,7 @@
|
|
|
25941
26515
|
"immutable": true,
|
|
25942
26516
|
"locationInModule": {
|
|
25943
26517
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25944
|
-
"line":
|
|
26518
|
+
"line": 443
|
|
25945
26519
|
},
|
|
25946
26520
|
"name": "datadogSideCarContainerDefinition",
|
|
25947
26521
|
"type": {
|
|
@@ -25955,7 +26529,7 @@
|
|
|
25955
26529
|
"immutable": true,
|
|
25956
26530
|
"locationInModule": {
|
|
25957
26531
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25958
|
-
"line":
|
|
26532
|
+
"line": 448
|
|
25959
26533
|
},
|
|
25960
26534
|
"name": "service",
|
|
25961
26535
|
"type": {
|
|
@@ -25969,7 +26543,7 @@
|
|
|
25969
26543
|
"immutable": true,
|
|
25970
26544
|
"locationInModule": {
|
|
25971
26545
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25972
|
-
"line":
|
|
26546
|
+
"line": 442
|
|
25973
26547
|
},
|
|
25974
26548
|
"name": "serviceContainerDefinition",
|
|
25975
26549
|
"type": {
|
|
@@ -25983,7 +26557,7 @@
|
|
|
25983
26557
|
"immutable": true,
|
|
25984
26558
|
"locationInModule": {
|
|
25985
26559
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
25986
|
-
"line":
|
|
26560
|
+
"line": 445
|
|
25987
26561
|
},
|
|
25988
26562
|
"name": "taskDefinition",
|
|
25989
26563
|
"type": {
|
|
@@ -25997,7 +26571,7 @@
|
|
|
25997
26571
|
"immutable": true,
|
|
25998
26572
|
"locationInModule": {
|
|
25999
26573
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
26000
|
-
"line":
|
|
26574
|
+
"line": 444
|
|
26001
26575
|
},
|
|
26002
26576
|
"name": "logRouterContainerDefinition",
|
|
26003
26577
|
"optional": true,
|
|
@@ -26012,7 +26586,7 @@
|
|
|
26012
26586
|
"immutable": true,
|
|
26013
26587
|
"locationInModule": {
|
|
26014
26588
|
"filename": "src/fargate/rio-fargate-service.ts",
|
|
26015
|
-
"line":
|
|
26589
|
+
"line": 449
|
|
26016
26590
|
},
|
|
26017
26591
|
"name": "targetGroup",
|
|
26018
26592
|
"optional": true,
|
|
@@ -27232,8 +27806,9 @@
|
|
|
27232
27806
|
"assembly": "@rio-cloud/cdk-v2-constructs",
|
|
27233
27807
|
"base": "constructs.Construct",
|
|
27234
27808
|
"docs": {
|
|
27809
|
+
"remarks": "Prefer this construct for new topics. Keep the default retention and partition count unless there is a concrete\noperational requirement to change them. Partition increases are permanent and may require coordination with CLAID\nwhen service limits are exceeded.\n\nExample:\n```ts\nnew KafkaTopicV4(this, 'EventsTopic', {\n name: 'billing-view.events',\n metadata: {\n description: 'Domain events emitted by Billing View.',\n audience: 'company-internal',\n recoveryPolicy: 'recoverable',\n },\n acl: {\n write: ['billing-view'],\n read: ['billing-consumer'],\n },\n isLogCompacted: false,\n});\n```",
|
|
27235
27810
|
"stability": "stable",
|
|
27236
|
-
"summary": "Construct to create a
|
|
27811
|
+
"summary": "Construct to create a version 4 RIO Kafka topic."
|
|
27237
27812
|
},
|
|
27238
27813
|
"fqn": "@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4",
|
|
27239
27814
|
"initializer": {
|
|
@@ -27242,7 +27817,7 @@
|
|
|
27242
27817
|
},
|
|
27243
27818
|
"locationInModule": {
|
|
27244
27819
|
"filename": "src/kafka/kafka-topic.ts",
|
|
27245
|
-
"line":
|
|
27820
|
+
"line": 302
|
|
27246
27821
|
},
|
|
27247
27822
|
"parameters": [
|
|
27248
27823
|
{
|
|
@@ -27268,7 +27843,7 @@
|
|
|
27268
27843
|
"kind": "class",
|
|
27269
27844
|
"locationInModule": {
|
|
27270
27845
|
"filename": "src/kafka/kafka-topic.ts",
|
|
27271
|
-
"line":
|
|
27846
|
+
"line": 301
|
|
27272
27847
|
},
|
|
27273
27848
|
"name": "KafkaTopicV4",
|
|
27274
27849
|
"namespace": "kafka",
|
|
@@ -28360,5 +28935,5 @@
|
|
|
28360
28935
|
}
|
|
28361
28936
|
},
|
|
28362
28937
|
"version": "0.0.0",
|
|
28363
|
-
"fingerprint": "
|
|
28938
|
+
"fingerprint": "wcpR/g1VxxywWd5SoWGCaeAUBujlAZAJEHSBxLIp3+c="
|
|
28364
28939
|
}
|