Skip to content

Database

This class encapsulates and extends the ROS resource type ALIYUN::GPDB::Database.

Initializers

import { Database } from '@alicloud/ros-cdk-gpdb'
new 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 { Database } from '@alicloud/ros-cdk-gpdb'
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.
attrAccessPrivilege string | @alicloud/ros-cdk-core.IResolvable Attribute AccessPrivilege: Permission Control Information.
attrCharacterSetName string | @alicloud/ros-cdk-core.IResolvable Attribute CharacterSetName: Character set, default value is UTF8.
attrCollate string | @alicloud/ros-cdk-core.IResolvable Attribute Collate: Database locale parameters, specifying string comparison/collation.
attrConnLimit string | @alicloud/ros-cdk-core.IResolvable Attribute ConnLimit: Maximum connection limit,-1 means unrestricted.
attrCtype string | @alicloud/ros-cdk-core.IResolvable Attribute Ctype: Database locale parameters, specifying character classification/case conversion rules.
attrDatabaseName string | @alicloud/ros-cdk-core.IResolvable Attribute DatabaseName: Database Name.
attrDbInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceId: Instance ID.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: Database Description.
attrOwner string | @alicloud/ros-cdk-core.IResolvable Attribute Owner: Data Sheet owner.
attrSize string | @alicloud/ros-cdk-core.IResolvable Attribute Size: Database size.
attrTableSpace string | @alicloud/ros-cdk-core.IResolvable Attribute TableSpace: Database table space.
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

attrAccessPrivilegeRequired

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

Attribute AccessPrivilege: Permission Control Information.


attrCharacterSetNameRequired

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

Attribute CharacterSetName: Character set, default value is UTF8.


attrCollateRequired

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

Attribute Collate: Database locale parameters, specifying string comparison/collation.


attrConnLimitRequired

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

Attribute ConnLimit: Maximum connection limit,-1 means unrestricted.


attrCtypeRequired

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

Attribute Ctype: Database locale parameters, specifying character classification/case conversion rules.


attrDatabaseNameRequired

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

Attribute DatabaseName: Database Name.


attrDbInstanceIdRequired

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

Attribute DBInstanceId: Instance ID.


attrDescriptionRequired

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

Attribute Description: Database Description.


attrOwnerRequired

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

Attribute Owner: Data Sheet owner.


attrSizeRequired

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

Attribute Size: Database size.


attrTableSpaceRequired

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

Attribute TableSpace: Database table space.


propsRequired

public readonly props: DatabaseProps;