|
| 1 | +import * as cloudwatch from '@aws-cdk/aws-cloudwatch'; |
1 | 2 | import * as ec2 from '@aws-cdk/aws-ec2';
|
2 | 3 | import * as cdk from '@aws-cdk/core';
|
3 | 4 | import { Construct } from 'constructs';
|
@@ -165,6 +166,14 @@ export interface IDatabaseInstance extends cdk.IResource {
|
165 | 166 | * @attribute Port
|
166 | 167 | */
|
167 | 168 | readonly dbInstanceEndpointPort: string;
|
| 169 | + |
| 170 | + /** |
| 171 | + * Return the given named metric associated with this database instance |
| 172 | + * |
| 173 | + * @see https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html |
| 174 | + * @see https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html |
| 175 | + */ |
| 176 | + metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric; |
168 | 177 | }
|
169 | 178 |
|
170 | 179 | /**
|
@@ -233,27 +242,64 @@ export interface DatabaseInstanceProps {
|
233 | 242 | }
|
234 | 243 |
|
235 | 244 | /**
|
236 |
| - * A database instance |
237 |
| - * |
238 |
| - * @resource AWS::Neptune::DBInstance |
| 245 | + * A new or imported database instance. |
239 | 246 | */
|
240 |
| -export class DatabaseInstance extends cdk.Resource implements IDatabaseInstance { |
241 |
| - |
| 247 | +export abstract class DatabaseInstanceBase extends cdk.Resource implements IDatabaseInstance { |
242 | 248 | /**
|
243 | 249 | * Import an existing database instance.
|
244 | 250 | */
|
245 | 251 | public static fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance {
|
246 |
| - class Import extends cdk.Resource implements IDatabaseInstance { |
| 252 | + class Import extends DatabaseInstanceBase implements IDatabaseInstance { |
247 | 253 | public readonly defaultPort = ec2.Port.tcp(attrs.port);
|
248 | 254 | public readonly instanceIdentifier = attrs.instanceIdentifier;
|
249 | 255 | public readonly dbInstanceEndpointAddress = attrs.instanceEndpointAddress;
|
250 | 256 | public readonly dbInstanceEndpointPort = attrs.port.toString();
|
251 | 257 | public readonly instanceEndpoint = new Endpoint(attrs.instanceEndpointAddress, attrs.port);
|
252 | 258 | }
|
253 |
| - |
254 | 259 | return new Import(scope, id);
|
255 | 260 | }
|
256 | 261 |
|
| 262 | + /** |
| 263 | + * @inheritdoc |
| 264 | + */ |
| 265 | + public abstract readonly dbInstanceEndpointAddress: string; |
| 266 | + |
| 267 | + /** |
| 268 | + * @inheritdoc |
| 269 | + */ |
| 270 | + public abstract readonly dbInstanceEndpointPort: string; |
| 271 | + |
| 272 | + /** |
| 273 | + * @inheritdoc |
| 274 | + */ |
| 275 | + public abstract readonly instanceEndpoint: Endpoint; |
| 276 | + |
| 277 | + /** |
| 278 | + * @inheritdoc |
| 279 | + */ |
| 280 | + public abstract readonly instanceIdentifier: string; |
| 281 | + |
| 282 | + /** |
| 283 | + * @inheritdoc |
| 284 | + */ |
| 285 | + public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric { |
| 286 | + return new cloudwatch.Metric({ |
| 287 | + namespace: 'AWS/Neptune', |
| 288 | + dimensionsMap: { |
| 289 | + DBInstanceIdentifier: this.instanceIdentifier, |
| 290 | + }, |
| 291 | + metricName, |
| 292 | + ...props, |
| 293 | + }); |
| 294 | + } |
| 295 | +} |
| 296 | + |
| 297 | +/** |
| 298 | + * A database instance |
| 299 | + * |
| 300 | + * @resource AWS::Neptune::DBInstance |
| 301 | + */ |
| 302 | +export class DatabaseInstance extends DatabaseInstanceBase implements IDatabaseInstance { |
257 | 303 |
|
258 | 304 | /**
|
259 | 305 | * The instance's database cluster
|
|
0 commit comments