ShardingInstance

Create a ShardingInstance Resource

new ShardingInstance(name: string, args: ShardingInstanceArgs, opts?: CustomResourceOptions);

def ShardingInstance(resource_name, opts=None, account_password=None, backup_periods=None, backup_time=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, mongo_lists=None, name=None, period=None, security_group_id=None, security_ip_lists=None, shard_lists=None, storage_engine=None, tde_status=None, vswitch_id=None, zone_id=None, __props__=None);

func NewShardingInstance(ctx *Context, name string, args ShardingInstanceArgs, opts ...ResourceOption) (*ShardingInstance, error)

public ShardingInstance(string name, ShardingInstanceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ShardingInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ShardingInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ShardingInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ShardingInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ShardingInstance resource accepts the following input properties:

EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
MongoLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs>: The mongo-node count can be purchased is in range of [2, 32].
ShardLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceShardListArgs>: the shard-node count can be purchased is in range of [2, 32].
AccountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
BackupPeriods List<string>: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
InstanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
KmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Name string: The name of DB instance. It a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
SecurityGroupId string: The Security Group ID of ECS.
SecurityIpLists List<string>: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
TdeStatus string: The TDE(Transparent Data Encryption) status.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.
ZoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
MongoLists []ShardingInstanceMongoList: The mongo-node count can be purchased is in range of [2, 32].
ShardLists []ShardingInstanceShardList: the shard-node count can be purchased is in range of [2, 32].
AccountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
BackupPeriods []string: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
InstanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
KmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Name string: The name of DB instance. It a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
SecurityGroupId string: The Security Group ID of ECS.
SecurityIpLists []string: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
TdeStatus string: The TDE(Transparent Data Encryption) status.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.
ZoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

engineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
mongoLists ShardingInstanceMongoList[]: The mongo-node count can be purchased is in range of [2, 32].
shardLists ShardingInstanceShardList[]: the shard-node count can be purchased is in range of [2, 32].
accountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backupPeriods string[]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
instanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
kmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name string: The name of DB instance. It a string of 2 to 256 characters.
period number: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
securityGroupId string: The Security Group ID of ECS.
securityIpLists string[]: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tdeStatus string: The TDE(Transparent Data Encryption) status.
vswitchId string: The virtual switch ID to launch DB instances in one VPC.
zoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

engine_version str: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
mongo_lists List[ShardingInstanceMongoList]: The mongo-node count can be purchased is in range of [2, 32].
shard_lists List[ShardingInstanceShardList]: the shard-node count can be purchased is in range of [2, 32].
account_password str: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backup_periods List[str]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_time str: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
instance_charge_type str: Valid values are PrePaid, PostPaid,System default to PostPaid.
kms_encrypted_password str: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Dict[str, Any]: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name str: The name of DB instance. It a string of 2 to 256 characters.
period float: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
security_group_id str: The Security Group ID of ECS.
security_ip_lists List[str]: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storage_engine str: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tde_status str: The TDE(Transparent Data Encryption) status.
vswitch_id str: The virtual switch ID to launch DB instances in one VPC.
zone_id str: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

Outputs

All input properties are implicitly available as output properties. Additionally, the ShardingInstance resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.

Id string: The provider-assigned unique ID for this managed resource.
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.

id string: The provider-assigned unique ID for this managed resource.
retentionPeriod number: Instance log backup retention days. Available in 1.42.0+.

id str: The provider-assigned unique ID for this managed resource.
retention_period float: Instance log backup retention days. Available in 1.42.0+.

Look up an Existing ShardingInstance Resource

Get an existing ShardingInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ShardingInstanceState, opts?: CustomResourceOptions): ShardingInstance

static get(resource_name, id, opts=None, account_password=None, backup_periods=None, backup_time=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, mongo_lists=None, name=None, period=None, retention_period=None, security_group_id=None, security_ip_lists=None, shard_lists=None, storage_engine=None, tde_status=None, vswitch_id=None, zone_id=None, __props__=None);

func GetShardingInstance(ctx *Context, name string, id IDInput, state *ShardingInstanceState, opts ...ResourceOption) (*ShardingInstance, error)

public static ShardingInstance Get(string name, Input<string> id, ShardingInstanceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
BackupPeriods List<string>: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
InstanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
KmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, object>: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
MongoLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs>: The mongo-node count can be purchased is in range of [2, 32].
Name string: The name of DB instance. It a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
SecurityGroupId string: The Security Group ID of ECS.
SecurityIpLists List<string>: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ShardLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceShardListArgs>: the shard-node count can be purchased is in range of [2, 32].
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
TdeStatus string: The TDE(Transparent Data Encryption) status.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.
ZoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

AccountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
BackupPeriods []string: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
InstanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
KmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]interface{}: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
MongoLists []ShardingInstanceMongoList: The mongo-node count can be purchased is in range of [2, 32].
Name string: The name of DB instance. It a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
SecurityGroupId string: The Security Group ID of ECS.
SecurityIpLists []string: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ShardLists []ShardingInstanceShardList: the shard-node count can be purchased is in range of [2, 32].
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
TdeStatus string: The TDE(Transparent Data Encryption) status.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.
ZoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

accountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backupPeriods string[]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupTime string: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
engineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instanceChargeType string: Valid values are PrePaid, PostPaid,System default to PostPaid.
kmsEncryptedPassword string: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: any}: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongoLists ShardingInstanceMongoList[]: The mongo-node count can be purchased is in range of [2, 32].
name string: The name of DB instance. It a string of 2 to 256 characters.
period number: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
retentionPeriod number: Instance log backup retention days. Available in 1.42.0+.
securityGroupId string: The Security Group ID of ECS.
securityIpLists string[]: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shardLists ShardingInstanceShardList[]: the shard-node count can be purchased is in range of [2, 32].
storageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tdeStatus string: The TDE(Transparent Data Encryption) status.
vswitchId string: The virtual switch ID to launch DB instances in one VPC.
zoneId string: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

account_password str: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backup_periods List[str]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_time str: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
engine_version str: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type str: Valid values are PrePaid, PostPaid,System default to PostPaid.
kms_encrypted_password str: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Dict[str, Any]: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongo_lists List[ShardingInstanceMongoList]: The mongo-node count can be purchased is in range of [2, 32].
name str: The name of DB instance. It a string of 2 to 256 characters.
period float: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
retention_period float: Instance log backup retention days. Available in 1.42.0+.
security_group_id str: The Security Group ID of ECS.
security_ip_lists List[str]: List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shard_lists List[ShardingInstanceShardList]: the shard-node count can be purchased is in range of [2, 32].
storage_engine str: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tde_status str: The TDE(Transparent Data Encryption) status.
vswitch_id str: The virtual switch ID to launch DB instances in one VPC.
zone_id str: The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

Supporting Types

ShardingInstanceMongoList

See the input and output API doc for this type.

NodeClass string: -(Required) Node specification. see Instance specifications.
ConnectString string: Mongo node connection string
NodeId string: The ID of the shard-node.
Port int: Mongo node port * shard_list

NodeClass string: -(Required) Node specification. see Instance specifications.
ConnectString string: Mongo node connection string
NodeId string: The ID of the shard-node.
Port int: Mongo node port * shard_list

nodeClass string: -(Required) Node specification. see Instance specifications.
connectString string: Mongo node connection string
nodeId string: The ID of the shard-node.
port number: Mongo node port * shard_list