@guardian/cdk
    Preparing search index...

    Class GuDatabaseInstance

    Hierarchy

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

    Constructors

    Properties

    cloudwatchLogGroups: { [engine: string]: ILogGroup }

    The log group is created when cloudwatchLogsExports is set.

    Each export value will create a separate log group.

    connections: Connections

    Access to network connections.

    dbInstanceEndpointAddress: string
    dbInstanceEndpointPort: string
    enableIamAuthentication?: boolean
    engine?: IInstanceEngine
    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

    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
    instanceResourceId?: 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

    The AWS Secrets Manager secret attached to the instance.

    sourceCfnProps: CfnDBInstanceProps
    stack: Stack

    The stack in which this resource is defined.

    vpc: IVpc

    The VPC where this database instance is deployed.

    vpcPlacement?: SubnetSelection
    PROPERTY_INJECTION_ID: string

    Uniquely identifies this class.

    Accessors

    • get instanceArn(): string

      The instance arn.

      Returns string

    Methods

    • 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 its absolute name/arn.

      Returns void

    • Add a new db proxy to this instance.

      Parameters

      • id: string
      • options: DatabaseProxyOptions

      Returns DatabaseProxy

    • Adds the multi user rotation to this instance.

      Parameters

      • id: string
      • options: RotationMultiUserOptions

      Returns SecretRotation

    • Adds the single user rotation of the master password to this instance.

      Parameters

      • Optionaloptions: RotationSingleUserOptions

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

      Returns SecretRotation

    • 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

    • Renders the secret attachment target specifications.

      Returns SecretAttachmentTargetProps

    • Returns 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

    • 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

    • Grant the given identity connection access to the database.

      Parameters

      • grantee: IGrantable

        the Principal to grant the permissions to

      • OptionaldbUser: string

        the name of the database user to allow connecting as to the db instance, or the default database user, obtained from the Secret, if not specified

      Returns Grant

    • Return the given named metric for this DBInstance

      Parameters

      • metricName: string
      • Optionalprops: MetricOptions

      Returns Metric

    • The percentage of CPU utilization.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • The number of database connections in use.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • The amount of available random access memory.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • The amount of available storage space.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • The average number of disk write I/O operations per second.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • The average number of disk read I/O operations per second.

      Average over 5 minutes

      Parameters

      • Optionalprops: MetricOptions

      Returns Metric

    • Defines a CloudWatch event rule which triggers for instance events. Use rule.addEventPattern(pattern) to specify a filter.

      Parameters

      • id: string
      • Optionaloptions: OnEventOptions

      Returns Rule

    • Returns void

    • Returns a string representation of an object.

      Returns string

    • Import an existing database instance.

      Parameters

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

      Returns IDatabaseInstance

    • Lookup an existing DatabaseInstance using instanceIdentifier.

      Parameters

      • scope: Construct
      • id: string
      • options: DatabaseInstanceLookupOptions

      Returns IDatabaseInstance

    • 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.

      Parameters

      • x: any

        Any object

      Returns x is Construct

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

    • Returns true if the construct was created by CDK, and false otherwise

      Parameters

      • construct: IConstruct

      Returns boolean

    • Check whether the given construct is a Resource

      Parameters

      • construct: IConstruct

      Returns construct is Resource