Class ShardingInstance

Inheritance

System.Object

Resource

CustomResource

ShardingInstance

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.MongoDB

Assembly: Pulumi.AliCloud.dll

Syntax

public class ShardingInstance : CustomResource

Constructors

View Source

ShardingInstance(String, ShardingInstanceArgs, CustomResourceOptions)

Create a ShardingInstance resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ShardingInstanceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AccountPassword

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

Declaration

public Output<string> AccountPassword { get; }

Property Value

Type	Description
Output<System.String>

View Source

BackupPeriods

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]

Declaration

public Output<ImmutableArray<string>> BackupPeriods { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

BackupTime

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

Declaration

public Output<string> BackupTime { get; }

Property Value

Type	Description
Output<System.String>

View Source

EngineVersion

Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

Declaration

public Output<string> EngineVersion { get; }

Property Value

Type	Description
Output<System.String>

View Source

InstanceChargeType

Valid values are PrePaid, PostPaid,System default to PostPaid.

Declaration

public Output<string> InstanceChargeType { get; }

Property Value

Type	Description
Output<System.String>

View Source

KmsEncryptedPassword

An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.

Declaration

public Output<string> KmsEncryptedPassword { get; }

Property Value

Type	Description
Output<System.String>

View Source

KmsEncryptionContext

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.

Declaration

public Output<ImmutableDictionary<string, object>> KmsEncryptionContext { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

MongoLists

The mongo-node count can be purchased is in range of [2, 32].

Declaration

public Output<ImmutableArray<ShardingInstanceMongoList>> MongoLists { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ShardingInstanceMongoList>>

View Source

Name

The name of DB instance. It a string of 2 to 256 characters.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

Period

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.

Declaration

public Output<int> Period { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

RetentionPeriod

Instance log backup retention days. Available in 1.42.0+.

Declaration

public Output<int> RetentionPeriod { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

SecurityGroupId

The Security Group ID of ECS.

Declaration

public Output<string> SecurityGroupId { get; }

Property Value

Type	Description
Output<System.String>

View Source

SecurityIpLists

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

Declaration

public Output<ImmutableArray<string>> SecurityIpLists { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

ShardLists

the shard-node count can be purchased is in range of [2, 32].

Declaration

public Output<ImmutableArray<ShardingInstanceShardList>> ShardLists { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ShardingInstanceShardList>>

View Source

StorageEngine

Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

Declaration

public Output<string> StorageEngine { get; }

Property Value

Type	Description
Output<System.String>

View Source

TdeStatus

The TDE(Transparent Data Encryption) status.

Declaration

public Output<string> TdeStatus { get; }

Property Value

Type	Description
Output<System.String>

View Source

VswitchId

The virtual switch ID to launch DB instances in one VPC.

Declaration

public Output<string> VswitchId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ZoneId

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.

Declaration

public Output<string> ZoneId { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, ShardingInstanceState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ShardingInstanceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ShardingInstance