Hierarchy

  • Mixin<typeof DatabaseInstance, this> & DatabaseInstance<this>
    • GuDatabaseInstance

Constructors

Properties

connections: Connections
dbInstanceEndpointAddress: string
dbInstanceEndpointPort: string
enableIamAuthentication?: boolean
engine?: IInstanceEngine
env: ResourceEnvironment
idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

instanceEndpoint: Endpoint
instanceIdentifier: string
instanceType: InstanceType
newCfnProps: CfnDBInstanceProps
node: Node

The tree node.

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.
secret?: ISecret
sourceCfnProps: CfnDBInstanceProps
stack: Stack
vpc: IVpc

The VPC where this database instance is deployed.

vpcPlacement?: SubnetSelection

Accessors

  • get instanceArn(): string
  • The instance arn.

    Returns string

Methods

  • _enableCrossEnvironment(): void
  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through it's absolute name/arn.

    Returns void

  • addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy
  • Add a new db proxy to this instance.

    Parameters

    • id: string
    • options: DatabaseProxyOptions

    Returns DatabaseProxy

  • addRotationMultiUser(id: string, options: RotationMultiUserOptions): SecretRotation
  • Adds the multi user rotation to this instance.

    Parameters

    • id: string
    • options: RotationMultiUserOptions

    Returns SecretRotation

  • addRotationSingleUser(options?: RotationSingleUserOptions): SecretRotation
  • Adds the single user rotation of the master password to this instance.

    Parameters

    • Optional options: RotationSingleUserOptions

      the options for the rotation, if you want to override the defaults

    Returns SecretRotation

  • applyRemovalPolicy(policy: RemovalPolicy): void
  • Apply the given removal policy to this resource

    The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

    The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

    Parameters

    • policy: RemovalPolicy

    Returns void

  • asSecretAttachmentTarget(): SecretAttachmentTargetProps
  • Renders the secret attachment target specifications.

    Returns SecretAttachmentTargetProps

  • generatePhysicalName(): string
  • Returns string

  • getResourceArnAttribute(arnAttr: string, arnComponents: ArnComponents): string
  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

  • getResourceNameAttribute(nameAttr: string): string
  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

  • grantConnect(grantee: IGrantable): Grant
  • Parameters

    • grantee: IGrantable

    Returns Grant

  • metric(metricName: string, props?: MetricOptions): Metric
  • Return the given named metric for this DBInstance

    Parameters

    • metricName: string
    • Optional props: MetricOptions

    Returns Metric

  • metricCPUUtilization(props?: MetricOptions): Metric
  • The percentage of CPU utilization.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • metricDatabaseConnections(props?: MetricOptions): Metric
  • The number of database connections in use.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • metricFreeStorageSpace(props?: MetricOptions): Metric
  • The amount of available storage space.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • metricFreeableMemory(props?: MetricOptions): Metric
  • The amount of available random access memory.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • metricReadIOPS(props?: MetricOptions): Metric
  • The average number of disk write I/O operations per second.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • metricWriteIOPS(props?: MetricOptions): Metric
  • The average number of disk read I/O operations per second.

    Average over 5 minutes

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • onEvent(id: string, options?: OnEventOptions): Rule
  • Defines a CloudWatch event rule which triggers for instance events. Use rule.addEventPattern(pattern) to specify a filter.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • setLogRetention(): void
  • Returns void

  • toString(): string
  • Returns a string representation of an object.

    Returns string

  • fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance
  • Import an existing database instance.

    Parameters

    • scope: Construct
    • id: string
    • attrs: DatabaseInstanceAttributes

    Returns IDatabaseInstance

  • isConstruct(x: any): x is Construct
  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Returns

    true if x is an object created from a class which extends Construct.

    Parameters

    • x: any

      Any object

    Returns x is Construct

  • isResource(construct: IConstruct): construct is CfnResource
  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is CfnResource

Generated using TypeDoc