RosPrepayDBInstance
This class is a base encapsulation around the ROS resource type ALIYUN::RDS::PrepayDBInstance
, which is used to create subscription ApsaraDB RDS instances.
Initializers
using AlibabaCloud.SDK.ROS.CDK.Rds;
new RosPrepayDBInstance(Construct Scope, string Id, RosPrepayDBInstanceProps Props, bool EnableResourcePropertyConstraint);
Name | Type | Description |
---|---|---|
Scope |
AlibabaCloud.SDK.ROS.CDK.Core.Construct |
- scope in which this resource is defined. |
Id |
string |
- scoped id of the resource. |
Props |
RosPrepayDBInstanceProps |
- resource properties. |
EnableResourcePropertyConstraint |
bool |
No description. |
Scope
Required
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct
scope in which this resource is defined.
Id
Required
- Type: string
scoped id of the resource.
Props
Required
- Type: RosPrepayDBInstanceProps
resource properties.
EnableResourcePropertyConstraint
Required
- Type: bool
Methods
Name | Description |
---|---|
ToString |
Returns a string representation of this construct. |
Synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
OverrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
AddCondition |
No description. |
AddCount |
No description. |
AddDeletionOverride |
Syntactic sugar for addOverride(path, undefined) . |
AddDependsOn |
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
AddDesc |
No description. |
AddMetaData |
No description. |
AddOverride |
Adds an override to the synthesized ROS resource. |
AddPropertyDeletionOverride |
Adds an override that deletes the value of a property from the resource definition. |
AddPropertyOverride |
Adds an override to a resource property. |
AddRosDependency |
No description. |
ApplyRemovalPolicy |
Sets the deletion policy of the resource based on the removal policy specified. |
GetAtt |
Returns a token for an runtime attribute of this resource. |
ToString
private string ToString()
Returns a string representation of this construct.
Synthesize
private void Synthesize(ISynthesisSession Session)
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.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession
The synthesis session.
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
AddCondition
private void AddCondition(RosCondition Con)
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition
AddCount
private void AddCount(object Count)
- Type: object
AddDeletionOverride
private void AddDeletionOverride(string Path)
Syntactic sugar for addOverride(path, undefined)
.
- Type: string
The path of the value to delete.
AddDependsOn
private void AddDependsOn(RosResource Target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource
AddDesc
private void AddDesc(string Desc)
- Type: string
AddMetaData
private void AddMetaData(string Key, object Value)
- Type: string
- Type: object
AddOverride
private void AddOverride(string Path, object Value)
Adds an override to the synthesized ROS resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
For example,
addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
- Type: string
The path of the property, you can use dot notation to override values in complex types.
Any intermdediate keys will be created as needed.
- Type: object
The value.
Could be primitive or complex.
AddPropertyDeletionOverride
private void AddPropertyDeletionOverride(string PropertyPath)
Adds an override that deletes the value of a property from the resource definition.
- Type: string
The path to the property.
AddPropertyOverride
private void AddPropertyOverride(string PropertyPath, object Value)
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
- Type: string
The path of the property.
- Type: object
The value.
AddRosDependency
private void AddRosDependency(string Target)
- Type: string
ApplyRemovalPolicy
private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)
Sets the deletion policy of the resource based on the removal policy specified.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions
GetAtt
private Reference GetAtt(string AttributeName)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
- Type: string
The name of the attribute.
Static Functions
Name | Description |
---|---|
IsConstruct |
Return whether the given object is a Construct. |
IsRosElement |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
IsRosResource |
Check whether the given construct is a RosResource. |
IsConstruct
using AlibabaCloud.SDK.ROS.CDK.Rds;
RosPrepayDBInstance.IsConstruct(object X);
Return whether the given object is a Construct.
- Type: object
IsRosElement
using AlibabaCloud.SDK.ROS.CDK.Rds;
RosPrepayDBInstance.IsRosElement(object X);
Returns true
if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of instanceof
to allow stack elements from different
versions of this library to be included in the same stack.
- Type: object
IsRosResource
using AlibabaCloud.SDK.ROS.CDK.Rds;
RosPrepayDBInstance.IsRosResource(IConstruct Construct);
Check whether the given construct is a RosResource.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct
Properties
Name | Type | Description |
---|---|---|
Node |
AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode |
The construct tree node associated with this construct. |
CreationStack |
string[] |
No description. |
LogicalId |
string |
The logical ID for this stack element. |
Stack |
AlibabaCloud.SDK.ROS.CDK.Core.Stack |
The stack in which this element is defined. |
Ref |
string |
Return a string that will be resolved to a RosTemplate { Ref } for this element. |
RosOptions |
AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions |
Options for this resource, such as condition, update policy etc. |
RosResourceType |
string |
ROS resource type. |
AttrDbInstanceId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrInnerConnectionString |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrInnerIpAddress |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrInnerPort |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrOrderId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrPublicConnectionString |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrPublicIpAddress |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrPublicPort |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
CommodityCode |
object |
No description. |
DbInstanceClass |
object |
No description. |
DbInstanceStorage |
object |
No description. |
EnableResourcePropertyConstraint |
bool |
No description. |
Engine |
object |
No description. |
EngineVersion |
object |
No description. |
Period |
object |
No description. |
PeriodType |
object |
No description. |
AllocatePublicConnection |
object |
No description. |
ArchiveBackupKeepCount |
object |
No description. |
ArchiveBackupKeepPolicy |
object |
No description. |
ArchiveBackupRetentionPeriod |
object |
No description. |
AutoPay |
object |
No description. |
AutoRenew |
object |
No description. |
BackUpCategory |
object |
No description. |
BackupPolicyMode |
object |
No description. |
BackupRetentionPeriod |
object |
No description. |
BurstingEnabled |
object |
No description. |
Category |
object |
No description. |
ColdDataEnabled |
object |
No description. |
CompressType |
object |
No description. |
ConnectionMode |
object |
No description. |
ConnectionStringPrefix |
object |
No description. |
ConnectionStringType |
object |
No description. |
CouponCode |
object |
No description. |
DbInstanceDescription |
object |
No description. |
DbInstanceNetType |
object |
No description. |
DbInstanceStorageType |
object |
No description. |
DbIsIgnoreCase |
object |
No description. |
DbMappings |
object |
No description. |
DbParamGroupId |
object |
No description. |
DbTimeZone |
object |
No description. |
DedicatedHostGroupId |
object |
No description. |
EnableBackupLog |
object |
No description. |
EncryptionKey |
object |
No description. |
HighSpaceUsageProtection |
object |
No description. |
InstanceNetworkType |
object |
No description. |
IoAccelerationEnabled |
object |
No description. |
LocalLogRetentionHours |
object |
No description. |
LocalLogRetentionSpace |
object |
No description. |
LogBackupFrequency |
object |
No description. |
LogBackupLocalRetentionNumber |
object |
No description. |
LogBackupRetentionPeriod |
object |
No description. |
MaintainTime |
object |
No description. |
MasterUsername |
object |
No description. |
MasterUserPassword |
object |
No description. |
MasterUserType |
object |
No description. |
MultiAz |
object |
No description. |
Port |
object |
No description. |
PreferredBackupPeriod |
object |
No description. |
PreferredBackupTime |
object |
No description. |
PrivateIpAddress |
object |
No description. |
Quantity |
object |
No description. |
ReleasedKeepPolicy |
object |
No description. |
ResourceGroupId |
object |
No description. |
RoleArn |
object |
No description. |
SecurityGroupId |
object |
No description. |
ServerlessConfig |
object |
No description. |
SlaveZoneIds |
object |
No description. |
SqlCollectorStatus |
object |
No description. |
SslSetting |
object |
No description. |
StorageAutoScale |
object |
No description. |
StorageThreshold |
object |
No description. |
StorageUpperBound |
object |
No description. |
Tags |
System.Collections.Generic.IDictionary |
No description. |
TargetDedicatedHostIdForLog |
object |
No description. |
TargetDedicatedHostIdForMaster |
object |
No description. |
TargetDedicatedHostIdForSlave |
object |
No description. |
VpcId |
object |
No description. |
VSwitchId |
object |
No description. |
ZoneId |
object |
No description. |
Node
Required
public ConstructNode Node { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode
The construct tree node associated with this construct.
CreationStack
Required
public string[] CreationStack { get; }
- Type: string[]
LogicalId
Required
public string LogicalId { get; }
- Type: string
The logical ID for this stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
Stack
Required
public Stack Stack { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
Ref
Required
public string Ref { get; }
- Type: string
Return a string that will be resolved to a RosTemplate { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
RosOptions
Required
public IRosResourceOptions RosOptions { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
RosResourceType
Required
public string RosResourceType { get; }
- Type: string
ROS resource type.
AttrDbInstanceId
Required
public IResolvable AttrDbInstanceId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrInnerConnectionString
Required
public IResolvable AttrInnerConnectionString { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrInnerIpAddress
Required
public IResolvable AttrInnerIpAddress { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrInnerPort
Required
public IResolvable AttrInnerPort { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrOrderId
Required
public IResolvable AttrOrderId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrPublicConnectionString
Required
public IResolvable AttrPublicConnectionString { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrPublicIpAddress
Required
public IResolvable AttrPublicIpAddress { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrPublicPort
Required
public IResolvable AttrPublicPort { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
CommodityCode
Required
public object CommodityCode { get; }
- Type: object
DbInstanceClass
Required
public object DbInstanceClass { get; }
- Type: object
DbInstanceStorage
Required
public object DbInstanceStorage { get; }
- Type: object
EnableResourcePropertyConstraint
Required
public bool EnableResourcePropertyConstraint { get; }
- Type: bool
Engine
Required
public object Engine { get; }
- Type: object
EngineVersion
Required
public object EngineVersion { get; }
- Type: object
Period
Required
public object Period { get; }
- Type: object
PeriodType
Required
public object PeriodType { get; }
- Type: object
AllocatePublicConnection
Optional
public object AllocatePublicConnection { get; }
- Type: object
ArchiveBackupKeepCount
Optional
public object ArchiveBackupKeepCount { get; }
- Type: object
ArchiveBackupKeepPolicy
Optional
public object ArchiveBackupKeepPolicy { get; }
- Type: object
ArchiveBackupRetentionPeriod
Optional
public object ArchiveBackupRetentionPeriod { get; }
- Type: object
AutoPay
Optional
public object AutoPay { get; }
- Type: object
AutoRenew
Optional
public object AutoRenew { get; }
- Type: object
BackUpCategory
Optional
public object BackUpCategory { get; }
- Type: object
BackupPolicyMode
Optional
public object BackupPolicyMode { get; }
- Type: object
BackupRetentionPeriod
Optional
public object BackupRetentionPeriod { get; }
- Type: object
BurstingEnabled
Optional
public object BurstingEnabled { get; }
- Type: object
Category
Optional
public object Category { get; }
- Type: object
ColdDataEnabled
Optional
public object ColdDataEnabled { get; }
- Type: object
CompressType
Optional
public object CompressType { get; }
- Type: object
ConnectionMode
Optional
public object ConnectionMode { get; }
- Type: object
ConnectionStringPrefix
Optional
public object ConnectionStringPrefix { get; }
- Type: object
ConnectionStringType
Optional
public object ConnectionStringType { get; }
- Type: object
CouponCode
Optional
public object CouponCode { get; }
- Type: object
DbInstanceDescription
Optional
public object DbInstanceDescription { get; }
- Type: object
DbInstanceNetType
Optional
public object DbInstanceNetType { get; }
- Type: object
DbInstanceStorageType
Optional
public object DbInstanceStorageType { get; }
- Type: object
DbIsIgnoreCase
Optional
public object DbIsIgnoreCase { get; }
- Type: object
DbMappings
Optional
public object DbMappings { get; }
- Type: object
DbParamGroupId
Optional
public object DbParamGroupId { get; }
- Type: object
DbTimeZone
Optional
public object DbTimeZone { get; }
- Type: object
DedicatedHostGroupId
Optional
public object DedicatedHostGroupId { get; }
- Type: object
EnableBackupLog
Optional
public object EnableBackupLog { get; }
- Type: object
EncryptionKey
Optional
public object EncryptionKey { get; }
- Type: object
HighSpaceUsageProtection
Optional
public object HighSpaceUsageProtection { get; }
- Type: object
InstanceNetworkType
Optional
public object InstanceNetworkType { get; }
- Type: object
IoAccelerationEnabled
Optional
public object IoAccelerationEnabled { get; }
- Type: object
LocalLogRetentionHours
Optional
public object LocalLogRetentionHours { get; }
- Type: object
LocalLogRetentionSpace
Optional
public object LocalLogRetentionSpace { get; }
- Type: object
LogBackupFrequency
Optional
public object LogBackupFrequency { get; }
- Type: object
LogBackupLocalRetentionNumber
Optional
public object LogBackupLocalRetentionNumber { get; }
- Type: object
LogBackupRetentionPeriod
Optional
public object LogBackupRetentionPeriod { get; }
- Type: object
MaintainTime
Optional
public object MaintainTime { get; }
- Type: object
MasterUsername
Optional
public object MasterUsername { get; }
- Type: object
MasterUserPassword
Optional
public object MasterUserPassword { get; }
- Type: object
MasterUserType
Optional
public object MasterUserType { get; }
- Type: object
MultiAz
Optional
public object MultiAz { get; }
- Type: object
Port
Optional
public object Port { get; }
- Type: object
PreferredBackupPeriod
Optional
public object PreferredBackupPeriod { get; }
- Type: object
PreferredBackupTime
Optional
public object PreferredBackupTime { get; }
- Type: object
PrivateIpAddress
Optional
public object PrivateIpAddress { get; }
- Type: object
Quantity
Optional
public object Quantity { get; }
- Type: object
ReleasedKeepPolicy
Optional
public object ReleasedKeepPolicy { get; }
- Type: object
ResourceGroupId
Optional
public object ResourceGroupId { get; }
- Type: object
RoleArn
Optional
public object RoleArn { get; }
- Type: object
SecurityGroupId
Optional
public object SecurityGroupId { get; }
- Type: object
ServerlessConfig
Optional
public object ServerlessConfig { get; }
- Type: object
SlaveZoneIds
Optional
public object SlaveZoneIds { get; }
- Type: object
SqlCollectorStatus
Optional
public object SqlCollectorStatus { get; }
- Type: object
SslSetting
Optional
public object SslSetting { get; }
- Type: object
StorageAutoScale
Optional
public object StorageAutoScale { get; }
- Type: object
StorageThreshold
Optional
public object StorageThreshold { get; }
- Type: object
StorageUpperBound
Optional
public object StorageUpperBound { get; }
- Type: object
Tags
Optional
public System.Collections.Generic.IDictionary<string, object> Tags { get; }
- Type: System.Collections.Generic.IDictionary
TargetDedicatedHostIdForLog
Optional
public object TargetDedicatedHostIdForLog { get; }
- Type: object
TargetDedicatedHostIdForMaster
Optional
public object TargetDedicatedHostIdForMaster { get; }
- Type: object
TargetDedicatedHostIdForSlave
Optional
public object TargetDedicatedHostIdForSlave { get; }
- Type: object
VpcId
Optional
public object VpcId { get; }
- Type: object
VSwitchId
Optional
public object VSwitchId { get; }
- Type: object
ZoneId
Optional
public object ZoneId { get; }
- Type: object
Constants
Name | Type | Description |
---|---|---|
RosResourceTypeName |
string |
The resource type name for this resource class. |
RosResourceTypeName
Required
public string RosResourceTypeName { get; }
- Type: string
The resource type name for this resource class.