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

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds"
alicloudroscdkrds.NewRosPrepayDBInstance(scope Construct, id *string, props RosPrepayDBInstanceProps, enableResourcePropertyConstraint *bool) RosPrepayDBInstance

Name	Type	Description
scope	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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.

session^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: *string

The new logical ID to use for this stack element.

---

AddCondition

func AddCondition(con RosCondition)

con^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

---

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

---

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: *string

The path of the value to delete.

---

AddDependsOn

func AddDependsOn(target RosResource)

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.

target^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

---

AddDesc

func AddDesc(desc *string)

desc^Required

• Type: *string

---

AddMetaData

func AddMetaData(key *string, value interface{})

key^Required

• Type: *string

---

value^Required

• Type: interface{}

---

AddOverride

func AddOverride(path *string, value interface{})

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"
       ...
     },
   ]
   ...
}

path^Required

• 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.

---

value^Required

• Type: interface{}

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: *string

The path to the property.

---

AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: *string

The path of the property.

---

value^Required

• Type: interface{}

The value.

---

AddRosDependency

func AddRosDependency(target *string)

target^Required

• Type: *string

---

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

---

options^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

---

GetAtt

func GetAtt(attributeName *string) Reference

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.

attributeName^Required

• 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

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds"
alicloudroscdkrds.RosPrepayDBInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

---

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds"
alicloudroscdkrds.RosPrepayDBInstance_IsRosElement(x interface{}) *bool

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.

x^Required

• Type: interface{}

---

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds"
alicloudroscdkrds.RosPrepayDBInstance_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

construct^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

---

Properties

Name	Type	Description
Node	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode	The construct tree node associated with this construct.
CreationStack	[]string	No description.
LogicalId	*string	The logical ID for this stack element.
Stack	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	*string	ROS resource type.
AttrDbInstanceId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrInnerConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrInnerIpAddress	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrInnerPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrOrderId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicConnectionString	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicIpAddress	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
AttrPublicPort	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	No description.
CommodityCode	interface{}	No description.
DbInstanceClass	interface{}	No description.
DbInstanceStorage	interface{}	No description.
EnableResourcePropertyConstraint	*bool	No description.
Engine	interface{}	No description.
EngineVersion	interface{}	No description.
Period	interface{}	No description.
PeriodType	interface{}	No description.
AllocatePublicConnection	interface{}	No description.
ArchiveBackupKeepCount	interface{}	No description.
ArchiveBackupKeepPolicy	interface{}	No description.
ArchiveBackupRetentionPeriod	interface{}	No description.
AutoPay	interface{}	No description.
AutoRenew	interface{}	No description.
BackUpCategory	interface{}	No description.
BackupPolicyMode	interface{}	No description.
BackupRetentionPeriod	interface{}	No description.
BurstingEnabled	interface{}	No description.
Category	interface{}	No description.
ColdDataEnabled	interface{}	No description.
CompressType	interface{}	No description.
ConnectionMode	interface{}	No description.
ConnectionStringPrefix	interface{}	No description.
ConnectionStringType	interface{}	No description.
CouponCode	interface{}	No description.
DbInstanceDescription	interface{}	No description.
DbInstanceNetType	interface{}	No description.
DbInstanceStorageType	interface{}	No description.
DbIsIgnoreCase	interface{}	No description.
DbMappings	interface{}	No description.
DbParamGroupId	interface{}	No description.
DbTimeZone	interface{}	No description.
DedicatedHostGroupId	interface{}	No description.
DeletionProtection	interface{}	No description.
EnableBackupLog	interface{}	No description.
EncryptionKey	interface{}	No description.
HighSpaceUsageProtection	interface{}	No description.
InstanceNetworkType	interface{}	No description.
IoAccelerationEnabled	interface{}	No description.
LocalLogRetentionHours	interface{}	No description.
LocalLogRetentionSpace	interface{}	No description.
LogBackupFrequency	interface{}	No description.
LogBackupLocalRetentionNumber	interface{}	No description.
LogBackupRetentionPeriod	interface{}	No description.
MaintainTime	interface{}	No description.
MasterUsername	interface{}	No description.
MasterUserPassword	interface{}	No description.
MasterUserType	interface{}	No description.
MultiAz	interface{}	No description.
Port	interface{}	No description.
PreferredBackupPeriod	interface{}	No description.
PreferredBackupTime	interface{}	No description.
PrivateIpAddress	interface{}	No description.
Quantity	interface{}	No description.
ReleasedKeepPolicy	interface{}	No description.
ResourceGroupId	interface{}	No description.
RoleArn	interface{}	No description.
SecurityGroupId	interface{}	No description.
ServerlessConfig	interface{}	No description.
SlaveZoneIds	interface{}	No description.
SqlCollectorStatus	interface{}	No description.
SslSetting	interface{}	No description.
StorageAutoScale	interface{}	No description.
StorageThreshold	interface{}	No description.
StorageUpperBound	interface{}	No description.
Tags	*map[string]interface{}	No description.
TargetDedicatedHostIdForLog	interface{}	No description.
TargetDedicatedHostIdForMaster	interface{}	No description.
TargetDedicatedHostIdForSlave	interface{}	No description.
VpcId	interface{}	No description.
VSwitchId	interface{}	No description.
ZoneId	interface{}	No description.

---

Node^Required

func Node() ConstructNode

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

func CreationStack() *[]*string

• Type: []string

---

LogicalId^Required

func LogicalId() *string

• 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

func Stack() Stack

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

Ref^Required

func Ref() *string

• 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

func RosOptions() IRosResourceOptions

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

---

RosResourceType^Required

func RosResourceType() *string

• Type: *string

ROS resource type.

---

AttrDbInstanceId^Required

func AttrDbInstanceId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrInnerConnectionString^Required

func AttrInnerConnectionString() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrInnerIpAddress^Required

func AttrInnerIpAddress() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrInnerPort^Required

func AttrInnerPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrOrderId^Required

func AttrOrderId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicConnectionString^Required

func AttrPublicConnectionString() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicIpAddress^Required

func AttrPublicIpAddress() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

AttrPublicPort^Required

func AttrPublicPort() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

---

CommodityCode^Required

func CommodityCode() interface{}

• Type: interface{}

---

DbInstanceClass^Required

func DbInstanceClass() interface{}

• Type: interface{}

---

DbInstanceStorage^Required

func DbInstanceStorage() interface{}

• Type: interface{}

---

EnableResourcePropertyConstraint^Required

func EnableResourcePropertyConstraint() *bool

• Type: *bool

---

Engine^Required

func Engine() interface{}

• Type: interface{}

---

EngineVersion^Required

func EngineVersion() interface{}

• Type: interface{}

---

Period^Required

func Period() interface{}

• Type: interface{}

---

PeriodType^Required

func PeriodType() interface{}

• Type: interface{}

---

AllocatePublicConnection^Optional

func AllocatePublicConnection() interface{}

• Type: interface{}

---

ArchiveBackupKeepCount^Optional

func ArchiveBackupKeepCount() interface{}

• Type: interface{}

---

ArchiveBackupKeepPolicy^Optional

func ArchiveBackupKeepPolicy() interface{}

• Type: interface{}

---

ArchiveBackupRetentionPeriod^Optional

func ArchiveBackupRetentionPeriod() interface{}

• Type: interface{}

---

AutoPay^Optional

func AutoPay() interface{}

• Type: interface{}

---

AutoRenew^Optional

func AutoRenew() interface{}

• Type: interface{}

---

BackUpCategory^Optional

func BackUpCategory() interface{}

• Type: interface{}

---

BackupPolicyMode^Optional

func BackupPolicyMode() interface{}

• Type: interface{}

---

BackupRetentionPeriod^Optional

func BackupRetentionPeriod() interface{}

• Type: interface{}

---

BurstingEnabled^Optional

func BurstingEnabled() interface{}

• Type: interface{}

---

Category^Optional

func Category() interface{}

• Type: interface{}

---

ColdDataEnabled^Optional

func ColdDataEnabled() interface{}

• Type: interface{}

---

CompressType^Optional

func CompressType() interface{}

• Type: interface{}

---

ConnectionMode^Optional

func ConnectionMode() interface{}

• Type: interface{}

---

ConnectionStringPrefix^Optional

func ConnectionStringPrefix() interface{}

• Type: interface{}

---

ConnectionStringType^Optional

func ConnectionStringType() interface{}

• Type: interface{}

---

CouponCode^Optional

func CouponCode() interface{}

• Type: interface{}

---

DbInstanceDescription^Optional

func DbInstanceDescription() interface{}

• Type: interface{}

---

DbInstanceNetType^Optional

func DbInstanceNetType() interface{}

• Type: interface{}

---

DbInstanceStorageType^Optional

func DbInstanceStorageType() interface{}

• Type: interface{}

---

DbIsIgnoreCase^Optional

func DbIsIgnoreCase() interface{}

• Type: interface{}

---

DbMappings^Optional

func DbMappings() interface{}

• Type: interface{}

---

DbParamGroupId^Optional

func DbParamGroupId() interface{}

• Type: interface{}

---

DbTimeZone^Optional

func DbTimeZone() interface{}

• Type: interface{}

---

DedicatedHostGroupId^Optional

func DedicatedHostGroupId() interface{}

• Type: interface{}

---

DeletionProtection^Optional

func DeletionProtection() interface{}

• Type: interface{}

---

EnableBackupLog^Optional

func EnableBackupLog() interface{}

• Type: interface{}

---

EncryptionKey^Optional

func EncryptionKey() interface{}

• Type: interface{}

---

HighSpaceUsageProtection^Optional

func HighSpaceUsageProtection() interface{}

• Type: interface{}

---

InstanceNetworkType^Optional

func InstanceNetworkType() interface{}

• Type: interface{}

---

IoAccelerationEnabled^Optional

func IoAccelerationEnabled() interface{}

• Type: interface{}

---

LocalLogRetentionHours^Optional

func LocalLogRetentionHours() interface{}

• Type: interface{}

---

LocalLogRetentionSpace^Optional

func LocalLogRetentionSpace() interface{}

• Type: interface{}

---

LogBackupFrequency^Optional

func LogBackupFrequency() interface{}

• Type: interface{}

---

LogBackupLocalRetentionNumber^Optional

func LogBackupLocalRetentionNumber() interface{}

• Type: interface{}

---

LogBackupRetentionPeriod^Optional

func LogBackupRetentionPeriod() interface{}

• Type: interface{}

---

MaintainTime^Optional

func MaintainTime() interface{}

• Type: interface{}

---

MasterUsername^Optional

func MasterUsername() interface{}

• Type: interface{}

---

MasterUserPassword^Optional

func MasterUserPassword() interface{}

• Type: interface{}

---

MasterUserType^Optional

func MasterUserType() interface{}

• Type: interface{}

---

MultiAz^Optional

func MultiAz() interface{}

• Type: interface{}

---

Port^Optional

func Port() interface{}

• Type: interface{}

---

PreferredBackupPeriod^Optional

func PreferredBackupPeriod() interface{}

• Type: interface{}

---

PreferredBackupTime^Optional

func PreferredBackupTime() interface{}

• Type: interface{}

---

PrivateIpAddress^Optional

func PrivateIpAddress() interface{}

• Type: interface{}

---

Quantity^Optional

func Quantity() interface{}

• Type: interface{}

---

ReleasedKeepPolicy^Optional

func ReleasedKeepPolicy() interface{}

• Type: interface{}

---

ResourceGroupId^Optional

func ResourceGroupId() interface{}

• Type: interface{}

---

RoleArn^Optional

func RoleArn() interface{}

• Type: interface{}

---

SecurityGroupId^Optional

func SecurityGroupId() interface{}

• Type: interface{}

---

ServerlessConfig^Optional

func ServerlessConfig() interface{}

• Type: interface{}

---

SlaveZoneIds^Optional

func SlaveZoneIds() interface{}

• Type: interface{}

---

SqlCollectorStatus^Optional

func SqlCollectorStatus() interface{}

• Type: interface{}

---

SslSetting^Optional

func SslSetting() interface{}

• Type: interface{}

---

StorageAutoScale^Optional

func StorageAutoScale() interface{}

• Type: interface{}

---

StorageThreshold^Optional

func StorageThreshold() interface{}

• Type: interface{}

---

StorageUpperBound^Optional

func StorageUpperBound() interface{}

• Type: interface{}

---

Tags^Optional

func Tags() *map[string]interface{}

• Type: *map[string]interface{}

---

TargetDedicatedHostIdForLog^Optional

func TargetDedicatedHostIdForLog() interface{}

• Type: interface{}

---

TargetDedicatedHostIdForMaster^Optional

func TargetDedicatedHostIdForMaster() interface{}

• Type: interface{}

---

TargetDedicatedHostIdForSlave^Optional

func TargetDedicatedHostIdForSlave() interface{}

• Type: interface{}

---

VpcId^Optional

func VpcId() interface{}

• Type: interface{}

---

VSwitchId^Optional

func VSwitchId() interface{}

• Type: interface{}

---

ZoneId^Optional

func ZoneId() interface{}

• Type: interface{}

---

Constants

Name	Type	Description
RosResourceTypeName	*string	The resource type name for this resource class.

---

RosResourceTypeName^Required

func RosResourceTypeName() *string

• Type: *string

The resource type name for this resource class.

---