Instance

• Implements: github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::MONGODB::Instance.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb/datasource"
datasource.NewInstance(scope Construct, id *string, props InstanceProps, enableResourcePropertyConstraint *bool) Instance

scope^Required

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

id^Required

• Type: *string

props^Required

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: *bool

Methods

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.

AddCondition

func AddCondition(condition RosCondition)

condition^Required

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

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

AddDependency

func AddDependency(resource Resource)

resource^Required

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

AddResourceDesc

func AddResourceDesc(desc *string)

desc^Required

• Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policy^Required

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

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

name^Required

• Type: *string

SetMetadata

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

key^Required

• Type: *string

value^Required

• Type: interface{}

Static Functions

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb/datasource"
datasource.Instance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

Properties

Node^Required

func Node() ConstructNode

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

The construct tree node associated with this construct.

Env^Required

func Env() IResourceEnvironment

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

Ref^Required

func Ref() *string

• Type: *string

Stack^Required

func Stack() Stack

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

The stack in which this resource is defined.

Resource^Optional

func Resource() RosResource

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

AttrAccountDescription^Required

func AttrAccountDescription() interface{}

• Type: interface{}

Attribute AccountDescription: The description of the account.

AttrAccountName^Required

func AttrAccountName() interface{}

• Type: interface{}

Attribute AccountName: The name of the account.

Value: *root * .

AttrAutoRenew^Required

func AttrAutoRenew() interface{}

• Type: interface{}

Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance.

Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.

AttrAutoRenewDuration^Required

func AttrAutoRenewDuration() interface{}

• Type: interface{}

Attribute AutoRenewDuration: Auto Renew Duration.

AttrBackupInterval^Required

func AttrBackupInterval() interface{}

• Type: interface{}

Attribute BackupInterval: The frequency at which high-frequency backup is created.

Valid values: -1: High-frequency backup is disabled. 15: every 15 minutes. 30: every 30 minutes. 60: every hour. 120: every 2 hours. 180: every 3 hours. 240: every 4 hours. 360: every 6 hours. 480: every 8 hours. 720: every 12 hours.

AttrBackupRetentionPeriod^Required

func AttrBackupRetentionPeriod() interface{}

• Type: interface{}

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

AttrCreateTime^Required

func AttrCreateTime() interface{}

• Type: interface{}

Attribute CreateTime: The Database create time.

AttrDbInstanceClass^Required

func AttrDbInstanceClass() interface{}

• Type: interface{}

Attribute DBInstanceClass: The instance type of the instance.

AttrDbInstanceDescription^Required

func AttrDbInstanceDescription() interface{}

• Type: interface{}

Attribute DBInstanceDescription: The name of the instance.

AttrDbInstanceReleaseProtection^Required

func AttrDbInstanceReleaseProtection() interface{}

• Type: interface{}

Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.

Valid values: true false

AttrDbInstanceStorage^Required

func AttrDbInstanceStorage() interface{}

• Type: interface{}

Attribute DbInstanceStorage: The storage capacity of the instance.

AttrDbInstanceType^Required

func AttrDbInstanceType() interface{}

• Type: interface{}

Attribute DBInstanceType: The architecture of the instance.

Valid values: replicate: replica set instance sharding: sharded cluster instance

AttrEnableBackupLog^Required

func AttrEnableBackupLog() interface{}

• Type: interface{}

Attribute EnableBackupLog: Indicates whether the log backup feature is enabled.

Valid values: 0 (default): The log backup feature is disabled. 1: The log backup feature is enabled.

AttrEngine^Required

func AttrEngine() interface{}

• Type: interface{}

Attribute Engine: The database engine of the instance.

Default value: mongodb.

AttrEngineVersion^Required

func AttrEngineVersion() interface{}

• Type: interface{}

Attribute EngineVersion: The database engine version of the instance.

6.0 5.0 4.4 4.2 4.0

AttrExpireTime^Required

func AttrExpireTime() interface{}

• Type: interface{}

Attribute ExpireTime: The time when the subscription instance expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

AttrHiddenZoneId^Required

func AttrHiddenZoneId() interface{}

• Type: interface{}

Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.

AttrInstanceId^Required

func AttrInstanceId() interface{}

• Type: interface{}

Attribute InstanceId: The ID of the mongos.

AttrKindCode^Required

func AttrKindCode() interface{}

• Type: interface{}

Attribute KindCode: The kind code of the instance.

Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster

AttrLastDowngradeTime^Required

func AttrLastDowngradeTime() interface{}

• Type: interface{}

Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.

AttrLockMode^Required

func AttrLockMode() interface{}

• Type: interface{}

Attribute LockMode: The lock status of the instance.

Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked before the instance is rolled back. LockByDiskQuota: The instance is automatically locked after the storage space is exhausted. Released: The instance is released.

AttrLogBackupRetentionPeriod^Required

func AttrLogBackupRetentionPeriod() interface{}

• Type: interface{}

Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.

Valid values: 7 to 730.

AttrMaintainEndTime^Required

func AttrMaintainEndTime() interface{}

• Type: interface{}

Attribute MaintainEndTime: The end time of the maintenance window.

The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.

AttrMaintainStartTime^Required

func AttrMaintainStartTime() interface{}

• Type: interface{}

Attribute MaintainStartTime: The start time of the maintenance window.

The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.

AttrMongosList^Required

func AttrMongosList() interface{}

• Type: interface{}

Attribute MongosList: The information of the mongos nodes.

AttrNetworkAddresses^Required

func AttrNetworkAddresses() interface{}

• Type: interface{}

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

AttrNetworkType^Required

func AttrNetworkType() interface{}

• Type: interface{}

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

AttrParameters^Required

func AttrParameters() interface{}

• Type: interface{}

Attribute Parameters: The settings of the parameters that have taken effect.

AttrPaymentType^Required

func AttrPaymentType() interface{}

• Type: interface{}

Attribute PaymentType: The billing method of the Database.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

AttrPreferredBackupPeriod^Required

func AttrPreferredBackupPeriod() interface{}

• Type: interface{}

Attribute PreferredBackupPeriod: The day of a week on which to back up data.

Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday

AttrPreferredBackupTime^Required

func AttrPreferredBackupTime() interface{}

• Type: interface{}

Attribute PreferredBackupTime: The time range during which the backup was created.

The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

AttrProtocolType^Required

func AttrProtocolType() interface{}

• Type: interface{}

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

AttrReadonlyReplicas^Required

func AttrReadonlyReplicas() interface{}

• Type: interface{}

Attribute ReadonlyReplicas: The number of read-only nodes in the shard node.

Valid values: 0 to 5. The value must be an integer.

AttrReplicaSetsConnections^Required

func AttrReplicaSetsConnections() interface{}

• Type: interface{}

Attribute ReplicaSetsConnections: ReplicaSets Connections.

AttrReplicationFactor^Required

func AttrReplicationFactor() interface{}

• Type: interface{}

Attribute ReplicationFactor: The number of nodes in the instance.

AttrResourceGroupId^Required

func AttrResourceGroupId() interface{}

• Type: interface{}

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

AttrSecondaryZoneId^Required

func AttrSecondaryZoneId() interface{}

• Type: interface{}

Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.

AttrSecurityGroupId^Required

func AttrSecurityGroupId() interface{}

• Type: interface{}

Attribute SecurityGroupId: The ID of the ECS security group.

AttrSecurityIpList^Required

func AttrSecurityIpList() interface{}

• Type: interface{}

Attribute SecurityIpList: The name of the IP whitelist.

AttrSecurityIps^Required

func AttrSecurityIps() interface{}

• Type: interface{}

Attribute SecurityIps: The IP addresses in the default whitelist.

AttrShardList^Required

func AttrShardList() interface{}

• Type: interface{}

Attribute ShardList: The information of the shard nodes.

AttrSnapshotBackupType^Required

func AttrSnapshotBackupType() interface{}

• Type: interface{}

Attribute SnapshotBackupType: The snapshot backup type.

Valid values: Flash: single-digit second backup Standard (default): standard backup

AttrSslExpiredTime^Required

func AttrSslExpiredTime() interface{}

• Type: interface{}

Attribute SslExpiredTime: The time when the SSL certificate expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).

AttrSslStatus^Required

func AttrSslStatus() interface{}

• Type: interface{}

Attribute SslStatus: The status of the SSL feature.

Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.

AttrStorageEngine^Required

func AttrStorageEngine() interface{}

• Type: interface{}

Attribute StorageEngine: The Storage Engine Of The Instance Type.

AttrTags^Required

func AttrTags() interface{}

• Type: interface{}

Attribute Tags: The details of the instance tags.

AttrTdeStatus^Required

func AttrTdeStatus() interface{}

• Type: interface{}

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

AttrVpcAuthMode^Required

func AttrVpcAuthMode() interface{}

• Type: interface{}

Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled.

Valid values: Open: Password-free access within the VPC is enabled. Close: Password-free access within the VPC is disabled, and you must use a password for access. NotSupport: Password-free access within the VPC is not supported.

AttrVpcId^Required

func AttrVpcId() interface{}

• Type: interface{}

Attribute VpcId: The VPC ID of the instance.

AttrVSwitchId^Required

func AttrVSwitchId() interface{}

• Type: interface{}

Attribute VSwitchId: The vSwitch ID of the instance.

AttrZoneId^Required

func AttrZoneId() interface{}

• Type: interface{}

Attribute ZoneId: The ID of the zone in which the instance resides.

Props^Required

func Props() InstanceProps

• Type: InstanceProps