import { GlobalAuroraRDSMaster } from 'cdk-aurora-globaldatabase'
new GlobalAuroraRDSMaster(scope: Construct, id: string, props?: GlobalAuroraRDSMasterProps)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
GlobalAuroraRDSMasterProps |
No description. |
- Type: constructs.Construct
- Type: string
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
addRegionalCluster |
No description. |
public toString(): string
Returns a string representation of this construct.
public addRegionalCluster(scope: Construct, id: string, options: RegionalOptions): void
- Type: constructs.Construct
- Type: string
- Type: RegionalOptions
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { GlobalAuroraRDSMaster } from 'cdk-aurora-globaldatabase'
GlobalAuroraRDSMaster.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
clusterEngineVersion |
string |
return RDS Cluster DB Engine Version. |
dbClusterpPG |
aws-cdk-lib.aws_rds.IParameterGroup |
return RDS Cluster ParameterGroup. |
engine |
string |
return RDS Cluster DB Engine . |
engineVersion |
aws-cdk-lib.aws_rds.IClusterEngine |
return RDS Cluster DB Engine Version. |
globalClusterArn |
string |
return Global RDS Cluster Resource ARN . |
globalClusterIdentifier |
string |
return Global RDS Cluster Identifier . |
rdsCluster |
aws-cdk-lib.aws_rds.DatabaseCluster |
return RDS Cluster. |
rdsClusterarn |
string |
return RDS Cluster Resource ARN . |
rdsInstanceType |
InstanceTypeEnum |
return Global RDS Cluster instance Type . |
rdsIsPublic |
aws-cdk-lib.aws_ec2.SubnetType |
return RDS Cluster is Public ? |
rdsPassword |
string |
return RDS Cluster password. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly clusterEngineVersion: string;
- Type: string
return RDS Cluster DB Engine Version.
public readonly dbClusterpPG: IParameterGroup;
- Type: aws-cdk-lib.aws_rds.IParameterGroup
return RDS Cluster ParameterGroup.
public readonly engine: string;
- Type: string
return RDS Cluster DB Engine .
public readonly engineVersion: IClusterEngine;
- Type: aws-cdk-lib.aws_rds.IClusterEngine
return RDS Cluster DB Engine Version.
public readonly globalClusterArn: string;
- Type: string
return Global RDS Cluster Resource ARN .
public readonly globalClusterIdentifier: string;
- Type: string
return Global RDS Cluster Identifier .
public readonly rdsCluster: DatabaseCluster;
- Type: aws-cdk-lib.aws_rds.DatabaseCluster
return RDS Cluster.
public readonly rdsClusterarn: string;
- Type: string
return RDS Cluster Resource ARN .
public readonly rdsInstanceType: InstanceTypeEnum;
- Type: InstanceTypeEnum
return Global RDS Cluster instance Type .
public readonly rdsIsPublic: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
return RDS Cluster is Public ?
public readonly rdsPassword: string;
- Type: string
return RDS Cluster password.
if not define props.rdsPassword , password will stored in Secret Manager Please use this command get password back , "aws secretsmanager get-secret-value --secret-id secret name"
import { GlobalAuroraRDSSlaveInfra } from 'cdk-aurora-globaldatabase'
new GlobalAuroraRDSSlaveInfra(scope: Construct, id: string, props?: GlobalAuroraRDSSlaveInfraProps)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
GlobalAuroraRDSSlaveInfraProps |
No description. |
- Type: constructs.Construct
- Type: string
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { GlobalAuroraRDSSlaveInfra } from 'cdk-aurora-globaldatabase'
GlobalAuroraRDSSlaveInfra.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
dbSubnetGroup |
aws-cdk-lib.aws_rds.CfnDBSubnetGroup |
GlobalAuroraRDSSlaveInfra subnet group . |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly dbSubnetGroup: CfnDBSubnetGroup;
- Type: aws-cdk-lib.aws_rds.CfnDBSubnetGroup
- Default: true
GlobalAuroraRDSSlaveInfra subnet group .
import { GlobalAuroraRDSMasterProps } from 'cdk-aurora-globaldatabase'
const globalAuroraRDSMasterProps: GlobalAuroraRDSMasterProps = { ... }
Name | Type | Description |
---|---|---|
credentials |
aws-cdk-lib.aws_rds.Credentials |
Credentials to use for the RDS database. |
dbClusterpPG |
aws-cdk-lib.aws_rds.IParameterGroup |
RDS ParameterGroup. |
dbUserName |
string |
RDS default Super User Name. |
defaultDatabaseName |
string |
RDS default Database Name. |
deletionProtection |
boolean |
Global RDS Database Cluster Engine Deletion Protection Option . |
engineVersion |
aws-cdk-lib.aws_rds.IClusterEngine |
RDS Database Cluster Engine . |
instanceType |
InstanceTypeEnum |
RDS Instance Type only can use r4 or r5 type see more https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations. |
monitoringInterval |
aws-cdk-lib.Duration |
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances. |
monitoringRole |
aws-cdk-lib.aws_iam.IRole |
Role that will be used to manage DB instances monitoring. |
parameters |
{[ key: string ]: string} |
RDS Parameters. |
rdsPassword |
string |
return RDS Cluster password. |
securityGroups |
aws-cdk-lib.aws_ec2.ISecurityGroup[] |
Credentials to use for the RDS database. |
storageEncrypted |
boolean |
Global RDS Database Cluster Engine Storage Encrypted Option . |
timeZone |
MySQLtimeZone |
RDS time zone. |
vpc |
aws-cdk-lib.aws_ec2.IVpc |
RDS default VPC. |
public readonly credentials: Credentials;
- Type: aws-cdk-lib.aws_rds.Credentials
- Default: creates new credentials
Credentials to use for the RDS database.
public readonly dbClusterpPG: IParameterGroup;
- Type: aws-cdk-lib.aws_rds.IParameterGroup
- Default: Aurora MySQL ParameterGroup
RDS ParameterGroup.
public readonly dbUserName: string;
- Type: string
- Default: sysadmin
RDS default Super User Name.
public readonly defaultDatabaseName: string;
- Type: string
- Default: globaldatabase
RDS default Database Name.
public readonly deletionProtection: boolean;
- Type: boolean
- Default: false
Global RDS Database Cluster Engine Deletion Protection Option .
public readonly engineVersion: IClusterEngine;
- Type: aws-cdk-lib.aws_rds.IClusterEngine
- Default: rds.DatabaseClusterEngine.auroraMysql({version: rds.AuroraMysqlEngineVersion.VER_2_07_1,})
RDS Database Cluster Engine .
public readonly instanceType: InstanceTypeEnum;
- Type: InstanceTypeEnum
- Default: r5.large
RDS Instance Type only can use r4 or r5 type see more https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations.
public readonly monitoringInterval: Duration;
- Type: aws-cdk-lib.Duration
- Default: no enhanced monitoring
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
public readonly monitoringRole: IRole;
- Type: aws-cdk-lib.aws_iam.IRole
- Default: A role is automatically created for you
Role that will be used to manage DB instances monitoring.
public readonly parameters: {[ key: string ]: string};
- Type: {[ key: string ]: string}
- Default: {time_zone: 'UTC'}
RDS Parameters.
public readonly rdsPassword: string;
- Type: string
return RDS Cluster password.
public readonly securityGroups: ISecurityGroup[];
- Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]
- Default: []
Credentials to use for the RDS database.
public readonly storageEncrypted: boolean;
- Type: boolean
- Default: true
Global RDS Database Cluster Engine Storage Encrypted Option .
public readonly timeZone: MySQLtimeZone;
- Type: MySQLtimeZone
- Default: MySQLtimeZone.UTC
RDS time zone.
public readonly vpc: IVpc;
- Type: aws-cdk-lib.aws_ec2.IVpc
- Default: new VPC
RDS default VPC.
import { GlobalAuroraRDSSlaveInfraProps } from 'cdk-aurora-globaldatabase'
const globalAuroraRDSSlaveInfraProps: GlobalAuroraRDSSlaveInfraProps = { ... }
Name | Type | Description |
---|---|---|
deletionProtection |
boolean |
Global RDS Database Cluster Engine Deletion Protection Option . |
stack |
aws-cdk-lib.Stack |
RDS Stack. |
storageEncrypted |
boolean |
Global RDS Database Cluster Engine Storage Encrypted Option . |
subnetType |
aws-cdk-lib.aws_ec2.SubnetType |
Slave region. |
vpc |
aws-cdk-lib.aws_ec2.IVpc |
Slave region VPC. |
public readonly deletionProtection: boolean;
- Type: boolean
- Default: false
Global RDS Database Cluster Engine Deletion Protection Option .
public readonly stack: Stack;
- Type: aws-cdk-lib.Stack
RDS Stack.
public readonly storageEncrypted: boolean;
- Type: boolean
- Default: true
Global RDS Database Cluster Engine Storage Encrypted Option .
public readonly subnetType: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
Slave region.
public readonly vpc: IVpc;
- Type: aws-cdk-lib.aws_ec2.IVpc
- Default: new VPC
Slave region VPC.
import { RegionalOptions } from 'cdk-aurora-globaldatabase'
const regionalOptions: RegionalOptions = { ... }
Name | Type | Description |
---|---|---|
region |
string |
No description. |
dbParameterGroup |
string |
No description. |
dbSubnetGroupName |
string |
No description. |
securityGroupId |
string |
No description. |
public readonly region: string;
- Type: string
public readonly dbParameterGroup: string;
- Type: string
public readonly dbSubnetGroupName: string;
- Type: string
public readonly securityGroupId: string;
- Type: string
import { StackParams } from 'cdk-aurora-globaldatabase'
new StackParams(scope: Construct)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
- Type: constructs.Construct
Name | Type | Description |
---|---|---|
account |
string |
No description. |
name |
string |
No description. |
region |
string |
No description. |
public readonly account: string;
- Type: string
public readonly name: string;
- Type: string
public readonly region: string;
- Type: string
Name | Description |
---|---|
R4_LARGE |
db Instance Type r4.large. |
R4_XLARGE |
db Instance Type r4.xlarge. |
R4_2XLARGE |
db Instance Type r4.2xlarge. |
R4_4XLARGE |
db Instance Type r4.4xlarge. |
R4_8XLARGE |
db Instance Type r4.8xlarge. |
R4_16XLARGE |
db Instance Type r4.16xlarge. |
R5_LARGE |
db Instance Type r5.large. |
R5_XLARGE |
db Instance Type r5.xlarge. |
R5_2XLARGE |
db Instance Type r5.2xlarge. |
R5_4XLARGE |
db Instance Type r5.4xlarge. |
R5_8XLARGE |
db Instance Type r5.8xlarge. |
R5_12XLARGE |
db Instance Type r5.12xlarge. |
R5_16XLARGE |
db Instance Type r5.16xlarge. |
R5_24XLARGE |
db Instance Type r5.24xlarge. |
R6G_LARGE |
db Instance Type r6g.large. |
R6G_XLARGE |
db Instance Type r6g.xlarge. |
R6G_2XLARGE |
db Instance Type r6g.2xlarge. |
R6G_4XLARGE |
db Instance Type r6g.4xlarge. |
R6G_8XLARGE |
db Instance Type r6g.8xlarge. |
R6G_12XLARGE |
db Instance Type r6g.12xlarge. |
R6G_16XLARGE |
db Instance Type r6g.16xlarge. |
db Instance Type r4.large.
db Instance Type r4.xlarge.
db Instance Type r4.2xlarge.
db Instance Type r4.4xlarge.
db Instance Type r4.8xlarge.
db Instance Type r4.16xlarge.
db Instance Type r5.large.
db Instance Type r5.xlarge.
db Instance Type r5.2xlarge.
db Instance Type r5.4xlarge.
db Instance Type r5.8xlarge.
db Instance Type r5.12xlarge.
db Instance Type r5.16xlarge.
db Instance Type r5.24xlarge.
db Instance Type r6g.large.
db Instance Type r6g.xlarge.
db Instance Type r6g.2xlarge.
db Instance Type r6g.4xlarge.
db Instance Type r6g.8xlarge.
db Instance Type r6g.12xlarge.
db Instance Type r6g.16xlarge.
Name | Description |
---|---|
UTC |
TIME ZONE UTC. |
ASIA_TAIPEI |
TIME ZONE Asia/Taipei. |
AFRICA_CAIRO |
TIME ZONE Africa/Cairo. |
ASIA_BANGKOK |
TIME ZONE Asia/Bangkok. |
AUSTRALIA_DARWIN |
TIME ZONE Australia/Darwin. |
AFRICA_CASABLANCA |
TIME ZONE Africa/Casablanca. |
ASIA_BEIRUT |
TIME ZONE Asia/Beirut. |
AUSTRALIA_HOBART |
TIME ZONE Australia/Hobart. |
AFRICA_HARARE |
TIME ZONE Africa/Harare. |
ASIA_CALCUTTA |
TIME ZONE Asia/Calcutta. |
AUSTRALIA_PERTH |
TIME ZONE Australia/Perth. |
AFRICA_MONROVIA |
TIME ZONE Africa/Monrovia. |
ASIA_DAMASCUS |
TIME ZONE Asia/Damascus. |
AUSTRALIA_SYDNEY |
TIME ZONE Australia/Sydney. |
AFRICA_NAIROBI |
TIME ZONE Africa/Nairobi. |
ASIA_DHAKA |
TIME ZONE Asia/Dhaka. |
BRAZIL_EAST |
TIME ZONE Brazil/East. |
AFRICA_TRIPOLI |
TIME ZONE Africa/Tripoli. |
ASIA_IRKUTSK |
TIME ZONE Asia/Irkutsk. |
CANADA_NEWFOUNDLAND |
TIME ZONE Canada/Newfoundland. |
AFRICA_WINDHOEK |
TIME ZONE Africa/Windhoek. |
ASIA_JERUSALEM |
TIME ZONE Asia/Jerusalem. |
CANADA_SASKATCHEWAN |
TIME ZONE Canada/Saskatchewan. |
AMERICA_ARAGUAINA |
TIME ZONE America/Araguaina. |
ASIA_KABUL |
TIME ZONE Asia/Kabul. |
EUROPE_AMSTERDAM |
TIME ZONE Europe/Amsterdam. |
AMERICA_ASUNCION |
TIME ZONE America/Asuncion. |
ASIA_KARACHI |
TIME ZONE Asia/Karachi. |
EUROPE_ATHENS |
TIME ZONE Europe/Athens. |
AMERICA_BOGOTA |
TIME ZONE America/Bogota. |
ASIA_KATHMANDU |
TIME ZONE Asia/Kathmandu. |
EUROPE_DUBLIN |
TIME ZONE Europe/Dublin. |
AMERICA_CARACAS |
TIME ZONE America/Caracas. |
ASIA_KRASNOYARSK |
TIME ZONE Asia/Krasnoyarsk. |
EUROPE_HELSINKI |
TIME ZONE Europe/Helsinki. |
AMERICA_CHIHUAHUA |
TIME ZONE America/Chihuahua. |
ASIA_MAGADAN |
TIME ZONE Asia/Magadan. |
EUROPE_ISTANBUL |
TIME ZONE Europe/Istanbul. |
AMERICA_CUIABA |
TIME ZONE America/Cuiaba. |
ASIA_MUSCAT |
TIME ZONE Asia/Muscat. |
EUROPE_KALININGRAD |
TIME ZONE Europe/Kaliningrad. |
AMERICA_DENVER |
TIME ZONE America/Denver. |
ASIA_NOVOSIBIRSK |
TIME ZONE Asia/Novosibirsk. |
EUROPE_MOSCOW |
TIME ZONE Europe/Moscow'. |
AMERICA_FORTALEZA |
TIME ZONE America/Fortaleza. |
ASIA_RIYADH |
TIME ZONE Asia/Riyadh. |
EUROPE_PARIS |
TIME ZONE Europe/Paris. |
AMERICA_GUATEMALA |
TIME ZONE America/Guatemala. |
ASIA_SEOUL |
TIME ZONE Asia/Seoul. |
EUROPE_PRAGUE |
TIME ZONE Europe/Prague. |
AMERICA_HALIFAX |
TIME ZONE America/Halifax. |
ASIA_SHANGHAI |
TIME ZONE Asia/Shanghai. |
EUROPE_SARAJEVO |
TIME ZONE Europe/Sarajevo. |
AMERICA_MANAUS |
TIME ZONE America/Manaus. |
ASIA_SINGAPORE |
TIME ZONE Asia/Singapore. |
PACIFIC_AUCKLAND |
TIME ZONE Pacific/Auckland. |
AMERICA_MATAMOROS |
TIME ZONE America/Matamoros. |
PACIFIC_FIJI |
TIME ZONE Pacific/Fiji. |
AMERICA_MONTERREY |
TIME ZONE America/Monterrey. |
ASIA_TEHRAN |
TIME ZONE Asia/Tehran. |
PACIFIC_GUAM |
TIME ZONE Pacific/Guam. |
AMERICA_MONTEVIDEO |
TIME ZONE America/Montevideo. |
ASIA_TOKYO |
TIME ZONE Asia/Tokyo. |
PACIFIC_HONOLULU |
TIME ZONE Pacific/Honolulu. |
AMERICA_PHOENIX |
TIME ZONE America/Phoenix. |
ASIA_ULAANBAATAR |
TIME ZONE Asia/Ulaanbaatar. |
PACIFIC_SAMOA |
TIME ZONE Pacific/Samoa. |
AMERICA_SANTIAGO |
TIME ZONE America/Santiago. |
ASIA_VLADIVOSTOK |
TIME ZONE Asia/Vladivostok. |
US_ALASKA |
TIME ZONE US/Alaska. |
AMERICA_TIJUANA |
TIME ZONE America/Tijuana. |
ASIA_YAKUTSK |
TIME ZONE Asia/Yakutsk. |
US_CENTRAL |
TIME ZONE US/Central. |
ASIA_AMMAN |
TIME ZONE Asia/Amman. |
ASIA_YEREVAN |
TIME ZONE Asia/Yerevan. |
US_EASTERN |
TIME ZONE US/Eastern. |
ASIA_ASHGABAT |
TIME ZONE Asia/Ashgabat. |
ATLANTIC_AZORES |
TIME ZONE Atlantic/Azores. |
US_EAST_INDIANA |
TIME ZONE US/East-Indiana. |
ASIA_BAGHDAD |
TIME ZONE Asia/Baghdad. |
AUSTRALIA_ADELAIDE |
TIME ZONE Australia/Adelaide. |
US_PACIFIC |
TIME ZONE US/Pacific. |
ASIA_BAKU |
TIME ZONE Asia/Baku. |
AUSTRALIA_BRISBANE |
TIME ZONE Australia/Brisbane. |
TIME ZONE UTC.
TIME ZONE Asia/Taipei.
TIME ZONE Africa/Cairo.
TIME ZONE Asia/Bangkok.
TIME ZONE Australia/Darwin.
TIME ZONE Africa/Casablanca.
TIME ZONE Asia/Beirut.
TIME ZONE Australia/Hobart.
TIME ZONE Africa/Harare.
TIME ZONE Asia/Calcutta.
TIME ZONE Australia/Perth.
TIME ZONE Africa/Monrovia.
TIME ZONE Asia/Damascus.
TIME ZONE Australia/Sydney.
TIME ZONE Africa/Nairobi.
TIME ZONE Asia/Dhaka.
TIME ZONE Brazil/East.
TIME ZONE Africa/Tripoli.
TIME ZONE Asia/Irkutsk.
TIME ZONE Canada/Newfoundland.
TIME ZONE Africa/Windhoek.
TIME ZONE Asia/Jerusalem.
TIME ZONE Canada/Saskatchewan.
TIME ZONE America/Araguaina.
TIME ZONE Asia/Kabul.
TIME ZONE Europe/Amsterdam.
TIME ZONE America/Asuncion.
TIME ZONE Asia/Karachi.
TIME ZONE Europe/Athens.
TIME ZONE America/Bogota.
TIME ZONE Asia/Kathmandu.
TIME ZONE Europe/Dublin.
TIME ZONE America/Caracas.
TIME ZONE Asia/Krasnoyarsk.
TIME ZONE Europe/Helsinki.
TIME ZONE America/Chihuahua.
TIME ZONE Asia/Magadan.
TIME ZONE Europe/Istanbul.
TIME ZONE America/Cuiaba.
TIME ZONE Asia/Muscat.
TIME ZONE Europe/Kaliningrad.
TIME ZONE America/Denver.
TIME ZONE Asia/Novosibirsk.
TIME ZONE Europe/Moscow'.
TIME ZONE America/Fortaleza.
TIME ZONE Asia/Riyadh.
TIME ZONE Europe/Paris.
TIME ZONE America/Guatemala.
TIME ZONE Asia/Seoul.
TIME ZONE Europe/Prague.
TIME ZONE America/Halifax.
TIME ZONE Asia/Shanghai.
TIME ZONE Europe/Sarajevo.
TIME ZONE America/Manaus.
TIME ZONE Asia/Singapore.
TIME ZONE Pacific/Auckland.
TIME ZONE America/Matamoros.
TIME ZONE Pacific/Fiji.
TIME ZONE America/Monterrey.
TIME ZONE Asia/Tehran.
TIME ZONE Pacific/Guam.
TIME ZONE America/Montevideo.
TIME ZONE Asia/Tokyo.
TIME ZONE Pacific/Honolulu.
TIME ZONE America/Phoenix.
TIME ZONE Asia/Ulaanbaatar.
TIME ZONE Pacific/Samoa.
TIME ZONE America/Santiago.
TIME ZONE Asia/Vladivostok.
TIME ZONE US/Alaska.
TIME ZONE America/Tijuana.
TIME ZONE Asia/Yakutsk.
TIME ZONE US/Central.
TIME ZONE Asia/Amman.
TIME ZONE Asia/Yerevan.
TIME ZONE US/Eastern.
TIME ZONE Asia/Ashgabat.
TIME ZONE Atlantic/Azores.
TIME ZONE US/East-Indiana.
TIME ZONE Asia/Baghdad.
TIME ZONE Australia/Adelaide.
TIME ZONE US/Pacific.
TIME ZONE Asia/Baku.
TIME ZONE Australia/Brisbane.