1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. kvstore
  5. Connection
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

alicloud.kvstore.Connection

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

    Operate the public network ip of the specified resource. How to use it, see What is Resource Alicloud KVStore Connection.

    NOTE: Available since v1.101.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "tf-example";
    const defaultZones = alicloud.kvstore.getZones({});
    const defaultResourceGroups = alicloud.resourcemanager.getResourceGroups({
        status: "OK",
    });
    const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
        vpcName: name,
        cidrBlock: "10.4.0.0/16",
    });
    const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
        vswitchName: name,
        cidrBlock: "10.4.0.0/24",
        vpcId: defaultNetwork.id,
        zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
    });
    const defaultInstance = new alicloud.kvstore.Instance("defaultInstance", {
        dbInstanceName: name,
        vswitchId: defaultSwitch.id,
        resourceGroupId: defaultResourceGroups.then(defaultResourceGroups => defaultResourceGroups.ids?.[0]),
        zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
        instanceClass: "redis.master.large.default",
        instanceType: "Redis",
        engineVersion: "5.0",
        securityIps: ["10.23.12.24"],
        config: {
            appendonly: "yes",
            "lazyfree-lazy-eviction": "yes",
        },
        tags: {
            Created: "TF",
            For: "example",
        },
    });
    const defaultConnection = new alicloud.kvstore.Connection("defaultConnection", {
        connectionStringPrefix: "exampleconnection",
        instanceId: defaultInstance.id,
        port: "6370",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "tf-example"
    default_zones = alicloud.kvstore.get_zones()
    default_resource_groups = alicloud.resourcemanager.get_resource_groups(status="OK")
    default_network = alicloud.vpc.Network("defaultNetwork",
        vpc_name=name,
        cidr_block="10.4.0.0/16")
    default_switch = alicloud.vpc.Switch("defaultSwitch",
        vswitch_name=name,
        cidr_block="10.4.0.0/24",
        vpc_id=default_network.id,
        zone_id=default_zones.zones[0].id)
    default_instance = alicloud.kvstore.Instance("defaultInstance",
        db_instance_name=name,
        vswitch_id=default_switch.id,
        resource_group_id=default_resource_groups.ids[0],
        zone_id=default_zones.zones[0].id,
        instance_class="redis.master.large.default",
        instance_type="Redis",
        engine_version="5.0",
        security_ips=["10.23.12.24"],
        config={
            "appendonly": "yes",
            "lazyfree-lazy-eviction": "yes",
        },
        tags={
            "Created": "TF",
            "For": "example",
        })
    default_connection = alicloud.kvstore.Connection("defaultConnection",
        connection_string_prefix="exampleconnection",
        instance_id=default_instance.id,
        port="6370")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/kvstore"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "tf-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		defaultZones, err := kvstore.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		defaultResourceGroups, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
    			Status: pulumi.StringRef("OK"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
    			VpcName:   pulumi.String(name),
    			CidrBlock: pulumi.String("10.4.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
    			VswitchName: pulumi.String(name),
    			CidrBlock:   pulumi.String("10.4.0.0/24"),
    			VpcId:       defaultNetwork.ID(),
    			ZoneId:      pulumi.String(defaultZones.Zones[0].Id),
    		})
    		if err != nil {
    			return err
    		}
    		defaultInstance, err := kvstore.NewInstance(ctx, "defaultInstance", &kvstore.InstanceArgs{
    			DbInstanceName:  pulumi.String(name),
    			VswitchId:       defaultSwitch.ID(),
    			ResourceGroupId: pulumi.String(defaultResourceGroups.Ids[0]),
    			ZoneId:          pulumi.String(defaultZones.Zones[0].Id),
    			InstanceClass:   pulumi.String("redis.master.large.default"),
    			InstanceType:    pulumi.String("Redis"),
    			EngineVersion:   pulumi.String("5.0"),
    			SecurityIps: pulumi.StringArray{
    				pulumi.String("10.23.12.24"),
    			},
    			Config: pulumi.Map{
    				"appendonly":             pulumi.Any("yes"),
    				"lazyfree-lazy-eviction": pulumi.Any("yes"),
    			},
    			Tags: pulumi.Map{
    				"Created": pulumi.Any("TF"),
    				"For":     pulumi.Any("example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kvstore.NewConnection(ctx, "defaultConnection", &kvstore.ConnectionArgs{
    			ConnectionStringPrefix: pulumi.String("exampleconnection"),
    			InstanceId:             defaultInstance.ID(),
    			Port:                   pulumi.String("6370"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "tf-example";
        var defaultZones = AliCloud.KVStore.GetZones.Invoke();
    
        var defaultResourceGroups = AliCloud.ResourceManager.GetResourceGroups.Invoke(new()
        {
            Status = "OK",
        });
    
        var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new()
        {
            VpcName = name,
            CidrBlock = "10.4.0.0/16",
        });
    
        var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
        {
            VswitchName = name,
            CidrBlock = "10.4.0.0/24",
            VpcId = defaultNetwork.Id,
            ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        });
    
        var defaultInstance = new AliCloud.KVStore.Instance("defaultInstance", new()
        {
            DbInstanceName = name,
            VswitchId = defaultSwitch.Id,
            ResourceGroupId = defaultResourceGroups.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0]),
            ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            InstanceClass = "redis.master.large.default",
            InstanceType = "Redis",
            EngineVersion = "5.0",
            SecurityIps = new[]
            {
                "10.23.12.24",
            },
            Config = 
            {
                { "appendonly", "yes" },
                { "lazyfree-lazy-eviction", "yes" },
            },
            Tags = 
            {
                { "Created", "TF" },
                { "For", "example" },
            },
        });
    
        var defaultConnection = new AliCloud.KVStore.Connection("defaultConnection", new()
        {
            ConnectionStringPrefix = "exampleconnection",
            InstanceId = defaultInstance.Id,
            Port = "6370",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.kvstore.KvstoreFunctions;
    import com.pulumi.alicloud.kvstore.inputs.GetZonesArgs;
    import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
    import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.kvstore.Instance;
    import com.pulumi.alicloud.kvstore.InstanceArgs;
    import com.pulumi.alicloud.kvstore.Connection;
    import com.pulumi.alicloud.kvstore.ConnectionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var name = config.get("name").orElse("tf-example");
            final var defaultZones = KvstoreFunctions.getZones();
    
            final var defaultResourceGroups = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
                .status("OK")
                .build());
    
            var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()        
                .vpcName(name)
                .cidrBlock("10.4.0.0/16")
                .build());
    
            var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()        
                .vswitchName(name)
                .cidrBlock("10.4.0.0/24")
                .vpcId(defaultNetwork.id())
                .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .build());
    
            var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()        
                .dbInstanceName(name)
                .vswitchId(defaultSwitch.id())
                .resourceGroupId(defaultResourceGroups.applyValue(getResourceGroupsResult -> getResourceGroupsResult.ids()[0]))
                .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .instanceClass("redis.master.large.default")
                .instanceType("Redis")
                .engineVersion("5.0")
                .securityIps("10.23.12.24")
                .config(Map.ofEntries(
                    Map.entry("appendonly", "yes"),
                    Map.entry("lazyfree-lazy-eviction", "yes")
                ))
                .tags(Map.ofEntries(
                    Map.entry("Created", "TF"),
                    Map.entry("For", "example")
                ))
                .build());
    
            var defaultConnection = new Connection("defaultConnection", ConnectionArgs.builder()        
                .connectionStringPrefix("exampleconnection")
                .instanceId(defaultInstance.id())
                .port("6370")
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: tf-example
    resources:
      defaultNetwork:
        type: alicloud:vpc:Network
        properties:
          vpcName: ${name}
          cidrBlock: 10.4.0.0/16
      defaultSwitch:
        type: alicloud:vpc:Switch
        properties:
          vswitchName: ${name}
          cidrBlock: 10.4.0.0/24
          vpcId: ${defaultNetwork.id}
          zoneId: ${defaultZones.zones[0].id}
      defaultInstance:
        type: alicloud:kvstore:Instance
        properties:
          dbInstanceName: ${name}
          vswitchId: ${defaultSwitch.id}
          resourceGroupId: ${defaultResourceGroups.ids[0]}
          zoneId: ${defaultZones.zones[0].id}
          instanceClass: redis.master.large.default
          instanceType: Redis
          engineVersion: '5.0'
          securityIps:
            - 10.23.12.24
          config:
            appendonly: yes
            lazyfree-lazy-eviction: yes
          tags:
            Created: TF
            For: example
      defaultConnection:
        type: alicloud:kvstore:Connection
        properties:
          connectionStringPrefix: exampleconnection
          instanceId: ${defaultInstance.id}
          port: '6370'
    variables:
      defaultZones:
        fn::invoke:
          Function: alicloud:kvstore:getZones
          Arguments: {}
      defaultResourceGroups:
        fn::invoke:
          Function: alicloud:resourcemanager:getResourceGroups
          Arguments:
            status: OK
    

    Create Connection Resource

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

    Constructor syntax

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def Connection(resource_name: str,
                   args: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_string_prefix: Optional[str] = None,
                   instance_id: Optional[str] = None,
                   port: Optional[str] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: alicloud:kvstore:Connection
    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 ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    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 exampleconnectionResourceResourceFromKvstoreconnection = new AliCloud.KVStore.Connection("exampleconnectionResourceResourceFromKvstoreconnection", new()
    {
        ConnectionStringPrefix = "string",
        InstanceId = "string",
        Port = "string",
    });
    
    example, err := kvstore.NewConnection(ctx, "exampleconnectionResourceResourceFromKvstoreconnection", &kvstore.ConnectionArgs{
    	ConnectionStringPrefix: pulumi.String("string"),
    	InstanceId:             pulumi.String("string"),
    	Port:                   pulumi.String("string"),
    })
    
    var exampleconnectionResourceResourceFromKvstoreconnection = new Connection("exampleconnectionResourceResourceFromKvstoreconnection", ConnectionArgs.builder()        
        .connectionStringPrefix("string")
        .instanceId("string")
        .port("string")
        .build());
    
    exampleconnection_resource_resource_from_kvstoreconnection = alicloud.kvstore.Connection("exampleconnectionResourceResourceFromKvstoreconnection",
        connection_string_prefix="string",
        instance_id="string",
        port="string")
    
    const exampleconnectionResourceResourceFromKvstoreconnection = new alicloud.kvstore.Connection("exampleconnectionResourceResourceFromKvstoreconnection", {
        connectionStringPrefix: "string",
        instanceId: "string",
        port: "string",
    });
    
    type: alicloud:kvstore:Connection
    properties:
        connectionStringPrefix: string
        instanceId: string
        port: string
    

    Connection 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 Connection resource accepts the following input properties:

    ConnectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    InstanceId string
    The ID of the instance.
    Port string
    The service port number of the instance.
    ConnectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    InstanceId string
    The ID of the instance.
    Port string
    The service port number of the instance.
    connectionStringPrefix String
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId String
    The ID of the instance.
    port String
    The service port number of the instance.
    connectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId string
    The ID of the instance.
    port string
    The service port number of the instance.
    connection_string_prefix str
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instance_id str
    The ID of the instance.
    port str
    The service port number of the instance.
    connectionStringPrefix String
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId String
    The ID of the instance.
    port String
    The service port number of the instance.

    Outputs

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

    ConnectionString string
    The public connection string of KVStore DBInstance.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConnectionString string
    The public connection string of KVStore DBInstance.
    Id string
    The provider-assigned unique ID for this managed resource.
    connectionString String
    The public connection string of KVStore DBInstance.
    id String
    The provider-assigned unique ID for this managed resource.
    connectionString string
    The public connection string of KVStore DBInstance.
    id string
    The provider-assigned unique ID for this managed resource.
    connection_string str
    The public connection string of KVStore DBInstance.
    id str
    The provider-assigned unique ID for this managed resource.
    connectionString String
    The public connection string of KVStore DBInstance.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connection_string: Optional[str] = None,
            connection_string_prefix: Optional[str] = None,
            instance_id: Optional[str] = None,
            port: Optional[str] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState 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:
    ConnectionString string
    The public connection string of KVStore DBInstance.
    ConnectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    InstanceId string
    The ID of the instance.
    Port string
    The service port number of the instance.
    ConnectionString string
    The public connection string of KVStore DBInstance.
    ConnectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    InstanceId string
    The ID of the instance.
    Port string
    The service port number of the instance.
    connectionString String
    The public connection string of KVStore DBInstance.
    connectionStringPrefix String
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId String
    The ID of the instance.
    port String
    The service port number of the instance.
    connectionString string
    The public connection string of KVStore DBInstance.
    connectionStringPrefix string
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId string
    The ID of the instance.
    port string
    The service port number of the instance.
    connection_string str
    The public connection string of KVStore DBInstance.
    connection_string_prefix str
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instance_id str
    The ID of the instance.
    port str
    The service port number of the instance.
    connectionString String
    The public connection string of KVStore DBInstance.
    connectionStringPrefix String
    The prefix of the public endpoint. The prefix can be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.
    instanceId String
    The ID of the instance.
    port String
    The service port number of the instance.

    Import

    KVStore connection can be imported using the id, e.g.

    $ pulumi import alicloud:kvstore/connection:Connection example r-abc12345678
    

    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.52.1 published on Thursday, Apr 4, 2024 by Pulumi