1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. mongodb
  5. ShardingNetworkPrivateAddress
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.mongodb.ShardingNetworkPrivateAddress

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a MongoDB Sharding Network Private Address resource.

    For information about MongoDB Sharding Network Private Address and how to use it, see What is Sharding Network Private Address.

    NOTE: Available since v1.157.0.

    Create ShardingNetworkPrivateAddress Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ShardingNetworkPrivateAddress(name: string, args: ShardingNetworkPrivateAddressArgs, opts?: CustomResourceOptions);
    @overload
    def ShardingNetworkPrivateAddress(resource_name: str,
                                      args: ShardingNetworkPrivateAddressArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ShardingNetworkPrivateAddress(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      db_instance_id: Optional[str] = None,
                                      node_id: Optional[str] = None,
                                      zone_id: Optional[str] = None,
                                      account_name: Optional[str] = None,
                                      account_password: Optional[str] = None)
    func NewShardingNetworkPrivateAddress(ctx *Context, name string, args ShardingNetworkPrivateAddressArgs, opts ...ResourceOption) (*ShardingNetworkPrivateAddress, error)
    public ShardingNetworkPrivateAddress(string name, ShardingNetworkPrivateAddressArgs args, CustomResourceOptions? opts = null)
    public ShardingNetworkPrivateAddress(String name, ShardingNetworkPrivateAddressArgs args)
    public ShardingNetworkPrivateAddress(String name, ShardingNetworkPrivateAddressArgs args, CustomResourceOptions options)
    
    type: alicloud:mongodb:ShardingNetworkPrivateAddress
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ShardingNetworkPrivateAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ShardingNetworkPrivateAddressArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ShardingNetworkPrivateAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShardingNetworkPrivateAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShardingNetworkPrivateAddressArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var shardingNetworkPrivateAddressResource = new AliCloud.MongoDB.ShardingNetworkPrivateAddress("shardingNetworkPrivateAddressResource", new()
    {
        DbInstanceId = "string",
        NodeId = "string",
        ZoneId = "string",
        AccountName = "string",
        AccountPassword = "string",
    });
    
    example, err := mongodb.NewShardingNetworkPrivateAddress(ctx, "shardingNetworkPrivateAddressResource", &mongodb.ShardingNetworkPrivateAddressArgs{
    	DbInstanceId:    pulumi.String("string"),
    	NodeId:          pulumi.String("string"),
    	ZoneId:          pulumi.String("string"),
    	AccountName:     pulumi.String("string"),
    	AccountPassword: pulumi.String("string"),
    })
    
    var shardingNetworkPrivateAddressResource = new ShardingNetworkPrivateAddress("shardingNetworkPrivateAddressResource", ShardingNetworkPrivateAddressArgs.builder()
        .dbInstanceId("string")
        .nodeId("string")
        .zoneId("string")
        .accountName("string")
        .accountPassword("string")
        .build());
    
    sharding_network_private_address_resource = alicloud.mongodb.ShardingNetworkPrivateAddress("shardingNetworkPrivateAddressResource",
        db_instance_id="string",
        node_id="string",
        zone_id="string",
        account_name="string",
        account_password="string")
    
    const shardingNetworkPrivateAddressResource = new alicloud.mongodb.ShardingNetworkPrivateAddress("shardingNetworkPrivateAddressResource", {
        dbInstanceId: "string",
        nodeId: "string",
        zoneId: "string",
        accountName: "string",
        accountPassword: "string",
    });
    
    type: alicloud:mongodb:ShardingNetworkPrivateAddress
    properties:
        accountName: string
        accountPassword: string
        dbInstanceId: string
        nodeId: string
        zoneId: string
    

    ShardingNetworkPrivateAddress Resource Properties

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

    Inputs

    The ShardingNetworkPrivateAddress resource accepts the following input properties:

    DbInstanceId string
    The db instance id.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    ZoneId string
    The zone ID of the instance.
    AccountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    AccountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    DbInstanceId string
    The db instance id.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    ZoneId string
    The zone ID of the instance.
    AccountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    AccountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId String
    The db instance id.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    zoneId String
    The zone ID of the instance.
    accountName String
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword String
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId string
    The db instance id.
    nodeId string
    The ID of the Shard node or the ConfigServer node.
    zoneId string
    The zone ID of the instance.
    accountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    db_instance_id str
    The db instance id.
    node_id str
    The ID of the Shard node or the ConfigServer node.
    zone_id str
    The zone ID of the instance.
    account_name str
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    account_password str
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId String
    The db instance id.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    zoneId String
    The zone ID of the instance.
    accountName String
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword String
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAddresses List<Pulumi.AliCloud.MongoDB.Outputs.ShardingNetworkPrivateAddressNetworkAddress>
    The endpoint of the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAddresses []ShardingNetworkPrivateAddressNetworkAddress
    The endpoint of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAddresses List<ShardingNetworkPrivateAddressNetworkAddress>
    The endpoint of the instance.
    id string
    The provider-assigned unique ID for this managed resource.
    networkAddresses ShardingNetworkPrivateAddressNetworkAddress[]
    The endpoint of the instance.
    id str
    The provider-assigned unique ID for this managed resource.
    network_addresses Sequence[ShardingNetworkPrivateAddressNetworkAddress]
    The endpoint of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAddresses List<Property Map>
    The endpoint of the instance.

    Look up Existing ShardingNetworkPrivateAddress Resource

    Get an existing ShardingNetworkPrivateAddress 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?: ShardingNetworkPrivateAddressState, opts?: CustomResourceOptions): ShardingNetworkPrivateAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            account_password: Optional[str] = None,
            db_instance_id: Optional[str] = None,
            network_addresses: Optional[Sequence[ShardingNetworkPrivateAddressNetworkAddressArgs]] = None,
            node_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> ShardingNetworkPrivateAddress
    func GetShardingNetworkPrivateAddress(ctx *Context, name string, id IDInput, state *ShardingNetworkPrivateAddressState, opts ...ResourceOption) (*ShardingNetworkPrivateAddress, error)
    public static ShardingNetworkPrivateAddress Get(string name, Input<string> id, ShardingNetworkPrivateAddressState? state, CustomResourceOptions? opts = null)
    public static ShardingNetworkPrivateAddress get(String name, Output<String> id, ShardingNetworkPrivateAddressState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    AccountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    AccountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    DbInstanceId string
    The db instance id.
    NetworkAddresses List<Pulumi.AliCloud.MongoDB.Inputs.ShardingNetworkPrivateAddressNetworkAddress>
    The endpoint of the instance.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    ZoneId string
    The zone ID of the instance.
    AccountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    AccountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    DbInstanceId string
    The db instance id.
    NetworkAddresses []ShardingNetworkPrivateAddressNetworkAddressArgs
    The endpoint of the instance.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    ZoneId string
    The zone ID of the instance.
    accountName String
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword String
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId String
    The db instance id.
    networkAddresses List<ShardingNetworkPrivateAddressNetworkAddress>
    The endpoint of the instance.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    zoneId String
    The zone ID of the instance.
    accountName string
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword string
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId string
    The db instance id.
    networkAddresses ShardingNetworkPrivateAddressNetworkAddress[]
    The endpoint of the instance.
    nodeId string
    The ID of the Shard node or the ConfigServer node.
    zoneId string
    The zone ID of the instance.
    account_name str
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    account_password str
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    db_instance_id str
    The db instance id.
    network_addresses Sequence[ShardingNetworkPrivateAddressNetworkAddressArgs]
    The endpoint of the instance.
    node_id str
    The ID of the Shard node or the ConfigServer node.
    zone_id str
    The zone ID of the instance.
    accountName String
    The name of the account.

    • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
    • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
    • The permissions of this account are fixed to read-only.
    accountPassword String
    Account password.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=.
    • The password must be 8 to 32 characters in length.
    dbInstanceId String
    The db instance id.
    networkAddresses List<Property Map>
    The endpoint of the instance.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    zoneId String
    The zone ID of the instance.

    Supporting Types

    ShardingNetworkPrivateAddressNetworkAddress, ShardingNetworkPrivateAddressNetworkAddressArgs

    ExpiredTime string
    The remaining duration of the classic network address. Unit: seconds.
    IpAddress string
    The IP address of the instance.
    NetworkAddress string
    The endpoint of the instance.
    NetworkType string
    The network type.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    NodeType string
    The type of the node.
    Port string
    The port number.
    Role string
    The role of the node.
    VpcId string
    The ID of the VPC.
    VswitchId string
    The vSwitch ID of the VPC.
    ExpiredTime string
    The remaining duration of the classic network address. Unit: seconds.
    IpAddress string
    The IP address of the instance.
    NetworkAddress string
    The endpoint of the instance.
    NetworkType string
    The network type.
    NodeId string
    The ID of the Shard node or the ConfigServer node.
    NodeType string
    The type of the node.
    Port string
    The port number.
    Role string
    The role of the node.
    VpcId string
    The ID of the VPC.
    VswitchId string
    The vSwitch ID of the VPC.
    expiredTime String
    The remaining duration of the classic network address. Unit: seconds.
    ipAddress String
    The IP address of the instance.
    networkAddress String
    The endpoint of the instance.
    networkType String
    The network type.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    nodeType String
    The type of the node.
    port String
    The port number.
    role String
    The role of the node.
    vpcId String
    The ID of the VPC.
    vswitchId String
    The vSwitch ID of the VPC.
    expiredTime string
    The remaining duration of the classic network address. Unit: seconds.
    ipAddress string
    The IP address of the instance.
    networkAddress string
    The endpoint of the instance.
    networkType string
    The network type.
    nodeId string
    The ID of the Shard node or the ConfigServer node.
    nodeType string
    The type of the node.
    port string
    The port number.
    role string
    The role of the node.
    vpcId string
    The ID of the VPC.
    vswitchId string
    The vSwitch ID of the VPC.
    expired_time str
    The remaining duration of the classic network address. Unit: seconds.
    ip_address str
    The IP address of the instance.
    network_address str
    The endpoint of the instance.
    network_type str
    The network type.
    node_id str
    The ID of the Shard node or the ConfigServer node.
    node_type str
    The type of the node.
    port str
    The port number.
    role str
    The role of the node.
    vpc_id str
    The ID of the VPC.
    vswitch_id str
    The vSwitch ID of the VPC.
    expiredTime String
    The remaining duration of the classic network address. Unit: seconds.
    ipAddress String
    The IP address of the instance.
    networkAddress String
    The endpoint of the instance.
    networkType String
    The network type.
    nodeId String
    The ID of the Shard node or the ConfigServer node.
    nodeType String
    The type of the node.
    port String
    The port number.
    role String
    The role of the node.
    vpcId String
    The ID of the VPC.
    vswitchId String
    The vSwitch ID of the VPC.

    Import

    MongoDB Sharding Network Private Address can be imported using the id, e.g.

    $ pulumi import alicloud:mongodb/shardingNetworkPrivateAddress:ShardingNetworkPrivateAddress example <db_instance_id>:<node_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi