Skip to content

Database

  • Implements: @alicloud/ros-cdk-dms.datasource.IDatabase

This class encapsulates and extends the ROS resource type DATASOURCE::DMS::Database.

Initializers

import { datasource } from '@alicloud/ros-cdk-dms'
new datasource.Database(scope: Construct, id: string, props: DatabaseProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DatabaseProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { datasource } from '@alicloud/ros-cdk-dms'
datasource.Database.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCatalogName string | @alicloud/ros-cdk-core.IResolvable Attribute CatalogName: Database catalog name.
attrDatabaseId string | @alicloud/ros-cdk-core.IResolvable Attribute DatabaseId: Database ID.
attrDbaId string | @alicloud/ros-cdk-core.IResolvable Attribute DbaId: Database administrator ID.
attrDbaName string | @alicloud/ros-cdk-core.IResolvable Attribute DbaName: Database administrator name.
attrDbType string | @alicloud/ros-cdk-core.IResolvable Attribute DbType: Database type.
attrEncoding string | @alicloud/ros-cdk-core.IResolvable Attribute Encoding: Database encoding.
attrEnvType string | @alicloud/ros-cdk-core.IResolvable Attribute EnvType: Database environment type.
attrHost string | @alicloud/ros-cdk-core.IResolvable Attribute Host: Database connection address.
attrInstanceAlias string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceAlias: Database instance alias.
attrInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: Database instance ID.
attrOwnerIdList string | @alicloud/ros-cdk-core.IResolvable Attribute OwnerIdList: Database owner ID list.
attrOwnerNameList string | @alicloud/ros-cdk-core.IResolvable Attribute OwnerNameList: Database owner name list.
attrPort string | @alicloud/ros-cdk-core.IResolvable Attribute Port: Database connection port.
attrSchemaName string | @alicloud/ros-cdk-core.IResolvable Attribute SchemaName: Database schema name.
attrSearchName string | @alicloud/ros-cdk-core.IResolvable Attribute SearchName: Database search name.
attrSid string | @alicloud/ros-cdk-core.IResolvable Attribute Sid: Database SID.
attrState string | @alicloud/ros-cdk-core.IResolvable Attribute State: Database state.
props DatabaseProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/ros-cdk-core.IResourceEnvironment

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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCatalogNameRequired

public readonly attrCatalogName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CatalogName: Database catalog name.


attrDatabaseIdRequired

public readonly attrDatabaseId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DatabaseId: Database ID.


attrDbaIdRequired

public readonly attrDbaId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DbaId: Database administrator ID.


attrDbaNameRequired

public readonly attrDbaName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DbaName: Database administrator name.


attrDbTypeRequired

public readonly attrDbType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DbType: Database type.


attrEncodingRequired

public readonly attrEncoding: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Encoding: Database encoding.


attrEnvTypeRequired

public readonly attrEnvType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvType: Database environment type.


attrHostRequired

public readonly attrHost: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Host: Database connection address.


attrInstanceAliasRequired

public readonly attrInstanceAlias: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstanceAlias: Database instance alias.


attrInstanceIdRequired

public readonly attrInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: Database instance ID.


attrOwnerIdListRequired

public readonly attrOwnerIdList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OwnerIdList: Database owner ID list.


attrOwnerNameListRequired

public readonly attrOwnerNameList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OwnerNameList: Database owner name list.


attrPortRequired

public readonly attrPort: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Port: Database connection port.


attrSchemaNameRequired

public readonly attrSchemaName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SchemaName: Database schema name.


attrSearchNameRequired

public readonly attrSearchName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SearchName: Database search name.


attrSidRequired

public readonly attrSid: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Sid: Database SID.


attrStateRequired

public readonly attrState: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute State: Database state.


propsRequired

public readonly props: DatabaseProps;