API Reference

Classes

Name	Description
GlobalAuroraRDSMaster	No description
GlobalAuroraRDSSlaveInfra	No description

Structs

Name	Description
GlobalAuroraRDSMasterProps	No description
GlobalAuroraRDSSlaveInfraProps	No description
RegionalOptions	No description

Enums

Name	Description
InstanceTypeEnum	No description
MySQLtimeZone	No description

class GlobalAuroraRDSMaster 🔹

Implements: IConstruct, IDependable Extends: Construct

Initializer

new GlobalAuroraRDSMaster(scope: Construct, id: string, props?: GlobalAuroraRDSMasterProps)

scope (Construct) No description
id (string) No description
props (GlobalAuroraRDSMasterProps) No description
- credentials (aws_rds.Credentials) Credentials to use for the RDS database. Default: creates new credentials
- dbClusterpPG (aws_rds.IParameterGroup) RDS ParameterGroup. Default: Aurora MySQL ParameterGroup
- dbUserName (string) RDS default Super User Name. Default: sysadmin
- defaultDatabaseName (string) RDS default Database Name. Default: globaldatabase
- deletionProtection (boolean) Global RDS Database Cluster Engine Deletion Protection Option . Default: false
- engineVersion (aws_rds.IClusterEngine) RDS Database Cluster Engine . Default: rds.DatabaseClusterEngine.auroraMysql({version: rds.AuroraMysqlEngineVersion.VER_2_07_1,})
- 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. Default: r5.large
- monitoringInterval (Duration) The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances. Default: no enhanced monitoring
- monitoringRole (aws_iam.IRole) Role that will be used to manage DB instances monitoring. Default: A role is automatically created for you
- parameters (Map<string, string>) RDS Parameters. Default: {time_zone: 'UTC'}
- rdsPassword (string) return RDS Cluster password. Optional
- securityGroups (Array<aws_ec2.ISecurityGroup>) Credentials to use for the RDS database. Default: []
- storageEncrypted (boolean) Global RDS Database Cluster Engine Storage Encrypted Option . Default: true
- timeZone (MySQLtimeZone) RDS time zone. Default: MySQLtimeZone.UTC
- vpc (aws_ec2.IVpc) RDS default VPC. Default: new VPC

Properties

Name	Type	Description
clusterEngineVersion🔹	`string`	return RDS Cluster DB Engine Version.
dbClusterpPG🔹	`aws_rds.IParameterGroup`	return RDS Cluster ParameterGroup.
engine🔹	`string`	return RDS Cluster DB Engine .
engineVersion🔹	`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_rds.DatabaseCluster`	return RDS Cluster.
rdsClusterarn🔹	`string`	return RDS Cluster Resource ARN .
rdsInstanceType🔹	`InstanceTypeEnum`	return Global RDS Cluster instance Type .
rdsIsPublic🔹	`aws_ec2.SubnetType`	return RDS Cluster is Public ?
rdsPassword?🔹	`string`	return RDS Cluster password. *Optional*

Methods

addRegionalCluster(scope, id, options)🔹

addRegionalCluster(scope: Construct, id: string, options: RegionalOptions): void

scope (Construct) No description
id (string) No description
options (RegionalOptions) No description
- region (string) No description
- dbParameterGroup (string) No description Optional
- dbSubnetGroupName (string) No description Optional
- securityGroupId (string) No description Optional

class GlobalAuroraRDSSlaveInfra 🔹

Implements: IConstruct, IDependable Extends: Construct

Initializer

new GlobalAuroraRDSSlaveInfra(scope: Construct, id: string, props?: GlobalAuroraRDSSlaveInfraProps)

scope (Construct) No description
id (string) No description
props (GlobalAuroraRDSSlaveInfraProps) No description
- deletionProtection (boolean) Global RDS Database Cluster Engine Deletion Protection Option . Default: false
- stack (Stack) RDS Stack. Optional
- storageEncrypted (boolean) Global RDS Database Cluster Engine Storage Encrypted Option . Default: true
- subnetType (aws_ec2.SubnetType) Slave region. Optional
- vpc (aws_ec2.IVpc) Slave region VPC. Default: new VPC

Properties

Name	Type	Description
dbSubnetGroup🔹	`aws_rds.CfnDBSubnetGroup`	GlobalAuroraRDSSlaveInfra subnet group .

struct GlobalAuroraRDSMasterProps 🔹

Name	Type	Description
credentials?🔹	`aws_rds.Credentials`	Credentials to use for the RDS database. *Default*: creates new credentials
dbClusterpPG?🔹	`aws_rds.IParameterGroup`	RDS ParameterGroup. *Default*: Aurora MySQL ParameterGroup
dbUserName?🔹	`string`	RDS default Super User Name. *Default*: sysadmin
defaultDatabaseName?🔹	`string`	RDS default Database Name. *Default*: globaldatabase
deletionProtection?🔹	`boolean`	Global RDS Database Cluster Engine Deletion Protection Option . *Default*: false
engineVersion?🔹	`aws_rds.IClusterEngine`	RDS Database Cluster Engine . *Default*: rds.DatabaseClusterEngine.auroraMysql({version: rds.AuroraMysqlEngineVersion.VER_2_07_1,})
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. *Default*: r5.large
monitoringInterval?🔹	`Duration`	The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances. *Default*: no enhanced monitoring
monitoringRole?🔹	`aws_iam.IRole`	Role that will be used to manage DB instances monitoring. *Default*: A role is automatically created for you
parameters?🔹	`Map<string, string>`	RDS Parameters. *Default*: {time_zone: 'UTC'}
rdsPassword?🔹	`string`	return RDS Cluster password. *Optional*
securityGroups?🔹	`Array<aws_ec2.ISecurityGroup>`	Credentials to use for the RDS database. *Default*: []
storageEncrypted?🔹	`boolean`	Global RDS Database Cluster Engine Storage Encrypted Option . *Default*: true
timeZone?🔹	`MySQLtimeZone`	RDS time zone. *Default*: MySQLtimeZone.UTC
vpc?🔹	`aws_ec2.IVpc`	RDS default VPC. *Default*: new VPC

struct GlobalAuroraRDSSlaveInfraProps 🔹

Name	Type	Description
deletionProtection?🔹	`boolean`	Global RDS Database Cluster Engine Deletion Protection Option . *Default*: false
stack?🔹	`Stack`	RDS Stack. *Optional*
storageEncrypted?🔹	`boolean`	Global RDS Database Cluster Engine Storage Encrypted Option . *Default*: true
subnetType?🔹	`aws_ec2.SubnetType`	Slave region. *Optional*
vpc?🔹	`aws_ec2.IVpc`	Slave region VPC. *Default*: new VPC

struct RegionalOptions 🔹

Name	Type	Description
region🔹	`string`
dbParameterGroup?🔹	`string`	*Optional*
dbSubnetGroupName?🔹	`string`	*Optional*
securityGroupId?🔹	`string`	*Optional*

enum InstanceTypeEnum 🔹

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.

enum MySQLtimeZone 🔹

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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API.md

API.md

API Reference

class GlobalAuroraRDSMaster 🔹

Initializer

Properties

Methods

addRegionalCluster(scope, id, options)🔹

class GlobalAuroraRDSSlaveInfra 🔹

Initializer

Properties

struct GlobalAuroraRDSMasterProps 🔹

struct GlobalAuroraRDSSlaveInfraProps 🔹

struct RegionalOptions 🔹

enum InstanceTypeEnum 🔹

enum MySQLtimeZone 🔹

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

class GlobalAuroraRDSMaster 🔹

Initializer

Properties

Methods

addRegionalCluster(scope, id, options)🔹

class GlobalAuroraRDSSlaveInfra 🔹

Initializer

Properties

struct GlobalAuroraRDSMasterProps 🔹

struct GlobalAuroraRDSSlaveInfraProps 🔹

struct RegionalOptions 🔹

enum InstanceTypeEnum 🔹

enum MySQLtimeZone 🔹