Alibaba Cloud v3.59.1, Jul 25 24

Alibaba Cloud v3.59.1 published on Thursday, Jul 25, 2024 by Pulumi

alicloud.hologram.Instance

Explore with Pulumi AI

Alibaba Cloud v3.59.1 published on Thursday, Jul 25, 2024 by Pulumi

pulumi/pulumi-alicloud

Import

Hologram Instance can be imported using the id, e.g.

$ pulumi import alicloud:hologram/instance:Instance example <id>

Create Instance Resource

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

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_name: Optional[str] = None,
             zone_id: Optional[str] = None,
             payment_type: Optional[str] = None,
             instance_type: Optional[str] = None,
             endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
             pricing_cycle: Optional[str] = None,
             initial_databases: Optional[str] = None,
             auto_pay: Optional[bool] = None,
             duration: Optional[int] = None,
             leader_instance_id: Optional[str] = None,
             cpu: Optional[int] = None,
             gateway_count: Optional[int] = None,
             resource_group_id: Optional[str] = None,
             scale_type: Optional[str] = None,
             status: Optional[str] = None,
             storage_size: Optional[int] = None,
             tags: Optional[Mapping[str, Any]] = None,
             cold_storage_size: Optional[int] = None)

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: alicloud:hologram:Instance
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 InstanceArgs: 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 InstanceArgs: 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 InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

var exampleinstanceResourceResourceFromHolograminstance = new AliCloud.Hologram.Instance("exampleinstanceResourceResourceFromHolograminstance", new()
{
    InstanceName = "string",
    ZoneId = "string",
    PaymentType = "string",
    InstanceType = "string",
    Endpoints = new[]
    {
        new AliCloud.Hologram.Inputs.InstanceEndpointArgs
        {
            AlternativeEndpoints = "string",
            Enabled = false,
            Endpoint = "string",
            Type = "string",
            VpcId = "string",
            VpcInstanceId = "string",
            VswitchId = "string",
        },
    },
    PricingCycle = "string",
    InitialDatabases = "string",
    AutoPay = false,
    Duration = 0,
    LeaderInstanceId = "string",
    Cpu = 0,
    GatewayCount = 0,
    ResourceGroupId = "string",
    ScaleType = "string",
    Status = "string",
    StorageSize = 0,
    Tags = 
    {
        { "string", "any" },
    },
    ColdStorageSize = 0,
});

example, err := hologram.NewInstance(ctx, "exampleinstanceResourceResourceFromHolograminstance", &hologram.InstanceArgs{
	InstanceName: pulumi.String("string"),
	ZoneId:       pulumi.String("string"),
	PaymentType:  pulumi.String("string"),
	InstanceType: pulumi.String("string"),
	Endpoints: hologram.InstanceEndpointArray{
		&hologram.InstanceEndpointArgs{
			AlternativeEndpoints: pulumi.String("string"),
			Enabled:              pulumi.Bool(false),
			Endpoint:             pulumi.String("string"),
			Type:                 pulumi.String("string"),
			VpcId:                pulumi.String("string"),
			VpcInstanceId:        pulumi.String("string"),
			VswitchId:            pulumi.String("string"),
		},
	},
	PricingCycle:     pulumi.String("string"),
	InitialDatabases: pulumi.String("string"),
	AutoPay:          pulumi.Bool(false),
	Duration:         pulumi.Int(0),
	LeaderInstanceId: pulumi.String("string"),
	Cpu:              pulumi.Int(0),
	GatewayCount:     pulumi.Int(0),
	ResourceGroupId:  pulumi.String("string"),
	ScaleType:        pulumi.String("string"),
	Status:           pulumi.String("string"),
	StorageSize:      pulumi.Int(0),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	ColdStorageSize: pulumi.Int(0),
})

var exampleinstanceResourceResourceFromHolograminstance = new Instance("exampleinstanceResourceResourceFromHolograminstance", InstanceArgs.builder()
    .instanceName("string")
    .zoneId("string")
    .paymentType("string")
    .instanceType("string")
    .endpoints(InstanceEndpointArgs.builder()
        .alternativeEndpoints("string")
        .enabled(false)
        .endpoint("string")
        .type("string")
        .vpcId("string")
        .vpcInstanceId("string")
        .vswitchId("string")
        .build())
    .pricingCycle("string")
    .initialDatabases("string")
    .autoPay(false)
    .duration(0)
    .leaderInstanceId("string")
    .cpu(0)
    .gatewayCount(0)
    .resourceGroupId("string")
    .scaleType("string")
    .status("string")
    .storageSize(0)
    .tags(Map.of("string", "any"))
    .coldStorageSize(0)
    .build());

exampleinstance_resource_resource_from_holograminstance = alicloud.hologram.Instance("exampleinstanceResourceResourceFromHolograminstance",
    instance_name="string",
    zone_id="string",
    payment_type="string",
    instance_type="string",
    endpoints=[alicloud.hologram.InstanceEndpointArgs(
        alternative_endpoints="string",
        enabled=False,
        endpoint="string",
        type="string",
        vpc_id="string",
        vpc_instance_id="string",
        vswitch_id="string",
    )],
    pricing_cycle="string",
    initial_databases="string",
    auto_pay=False,
    duration=0,
    leader_instance_id="string",
    cpu=0,
    gateway_count=0,
    resource_group_id="string",
    scale_type="string",
    status="string",
    storage_size=0,
    tags={
        "string": "any",
    },
    cold_storage_size=0)

const exampleinstanceResourceResourceFromHolograminstance = new alicloud.hologram.Instance("exampleinstanceResourceResourceFromHolograminstance", {
    instanceName: "string",
    zoneId: "string",
    paymentType: "string",
    instanceType: "string",
    endpoints: [{
        alternativeEndpoints: "string",
        enabled: false,
        endpoint: "string",
        type: "string",
        vpcId: "string",
        vpcInstanceId: "string",
        vswitchId: "string",
    }],
    pricingCycle: "string",
    initialDatabases: "string",
    autoPay: false,
    duration: 0,
    leaderInstanceId: "string",
    cpu: 0,
    gatewayCount: 0,
    resourceGroupId: "string",
    scaleType: "string",
    status: "string",
    storageSize: 0,
    tags: {
        string: "any",
    },
    coldStorageSize: 0,
});

type: alicloud:hologram:Instance
properties:
    autoPay: false
    coldStorageSize: 0
    cpu: 0
    duration: 0
    endpoints:
        - alternativeEndpoints: string
          enabled: false
          endpoint: string
          type: string
          vpcId: string
          vpcInstanceId: string
          vswitchId: string
    gatewayCount: 0
    initialDatabases: string
    instanceName: string
    instanceType: string
    leaderInstanceId: string
    paymentType: string
    pricingCycle: string
    resourceGroupId: string
    scaleType: string
    status: string
    storageSize: 0
    tags:
        string: any
    zoneId: string

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

InstanceName string

The name of the resource.

InstanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

PaymentType string

The payment type of the resource.

ZoneId string

The zone Id. Refer to "Instructions for Use".

AutoPay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

ColdStorageSize int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

Cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

Duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

Endpoints List<Pulumi.AliCloud.Hologram.Inputs.InstanceEndpoint>

List of domain names. See endpoints below.

GatewayCount int

Number of gateway nodes.

InitialDatabases string

Initialize the database and split multiple database names ",".

LeaderInstanceId string

The ID of the primary instance.

PricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

ResourceGroupId string

The ID of the resource group.

ScaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

Status string

The status of the resource.

StorageSize int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

Tags Dictionary<string, object>

Instance tag.

InstanceName string

The name of the resource.

InstanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

PaymentType string

The payment type of the resource.

ZoneId string

The zone Id. Refer to "Instructions for Use".

AutoPay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

ColdStorageSize int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

Cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

Duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

Endpoints []InstanceEndpointArgs

List of domain names. See endpoints below.

GatewayCount int

Number of gateway nodes.

InitialDatabases string

Initialize the database and split multiple database names ",".

LeaderInstanceId string

The ID of the primary instance.

PricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

ResourceGroupId string

The ID of the resource group.

ScaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

Status string

The status of the resource.

StorageSize int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

Tags map[string]interface{}

Instance tag.

instanceName String

The name of the resource.

instanceType String

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

paymentType String

The payment type of the resource.

zoneId String

The zone Id. Refer to "Instructions for Use".

autoPay Boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize Integer

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu Integer

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

duration Integer

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints List<InstanceEndpoint>

List of domain names. See endpoints below.

gatewayCount Integer

Number of gateway nodes.

initialDatabases String

Initialize the database and split multiple database names ",".

leaderInstanceId String

The ID of the primary instance.

pricingCycle String

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId String

The ID of the resource group.

scaleType String

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status String

The status of the resource.

storageSize Integer

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Map<String,Object>

Instance tag.

instanceName string

The name of the resource.

instanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

paymentType string

The payment type of the resource.

zoneId string

The zone Id. Refer to "Instructions for Use".

autoPay boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize number

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu number

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

duration number

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints InstanceEndpoint[]

List of domain names. See endpoints below.

gatewayCount number

Number of gateway nodes.

initialDatabases string

Initialize the database and split multiple database names ",".

leaderInstanceId string

The ID of the primary instance.

pricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId string

The ID of the resource group.

scaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status string

The status of the resource.

storageSize number

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags {[key: string]: any}

Instance tag.

instance_name str

The name of the resource.

instance_type str

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

payment_type str

The payment type of the resource.

zone_id str

The zone Id. Refer to "Instructions for Use".

auto_pay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

cold_storage_size int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints Sequence[InstanceEndpointArgs]

List of domain names. See endpoints below.

gateway_count int

Number of gateway nodes.

initial_databases str

Initialize the database and split multiple database names ",".

leader_instance_id str

The ID of the primary instance.

pricing_cycle str

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resource_group_id str

The ID of the resource group.

scale_type str

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status str

The status of the resource.

storage_size int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Mapping[str, Any]

Instance tag.

instanceName String

The name of the resource.

instanceType String

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

paymentType String

The payment type of the resource.

zoneId String

The zone Id. Refer to "Instructions for Use".

autoPay Boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize Number

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu Number

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

duration Number

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints List<Property Map>

List of domain names. See endpoints below.

gatewayCount Number

Number of gateway nodes.

initialDatabases String

Initialize the database and split multiple database names ",".

leaderInstanceId String

The ID of the primary instance.

pricingCycle String

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId String

The ID of the resource group.

scaleType String

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status String

The status of the resource.

storageSize Number

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Map<Any>

Instance tag.

Outputs

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

CreateTime string: The creation time of the resource.
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: The creation time of the resource.
Id string: The provider-assigned unique ID for this managed resource.

createTime String: The creation time of the resource.
id String: The provider-assigned unique ID for this managed resource.

createTime string: The creation time of the resource.
id string: The provider-assigned unique ID for this managed resource.

create_time str: The creation time of the resource.
id str: The provider-assigned unique ID for this managed resource.

createTime String: The creation time of the resource.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_pay: Optional[bool] = None,
        cold_storage_size: Optional[int] = None,
        cpu: Optional[int] = None,
        create_time: Optional[str] = None,
        duration: Optional[int] = None,
        endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
        gateway_count: Optional[int] = None,
        initial_databases: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        leader_instance_id: Optional[str] = None,
        payment_type: Optional[str] = None,
        pricing_cycle: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        scale_type: Optional[str] = None,
        status: Optional[str] = None,
        storage_size: Optional[int] = None,
        tags: Optional[Mapping[str, Any]] = None,
        zone_id: Optional[str] = None) -> Instance

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

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

public static Instance get(String name, Output<String> id, InstanceState 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:

AutoPay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

ColdStorageSize int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

Cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

CreateTime string

The creation time of the resource.

Duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

Endpoints List<Pulumi.AliCloud.Hologram.Inputs.InstanceEndpoint>

List of domain names. See endpoints below.

GatewayCount int

Number of gateway nodes.

InitialDatabases string

Initialize the database and split multiple database names ",".

InstanceName string

The name of the resource.

InstanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

LeaderInstanceId string

The ID of the primary instance.

PaymentType string

The payment type of the resource.

PricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

ResourceGroupId string

The ID of the resource group.

ScaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

Status string

The status of the resource.

StorageSize int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

Tags Dictionary<string, object>

Instance tag.

ZoneId string

The zone Id. Refer to "Instructions for Use".

AutoPay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

ColdStorageSize int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

Cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

CreateTime string

The creation time of the resource.

Duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

Endpoints []InstanceEndpointArgs

List of domain names. See endpoints below.

GatewayCount int

Number of gateway nodes.

InitialDatabases string

Initialize the database and split multiple database names ",".

InstanceName string

The name of the resource.

InstanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

LeaderInstanceId string

The ID of the primary instance.

PaymentType string

The payment type of the resource.

PricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

ResourceGroupId string

The ID of the resource group.

ScaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

Status string

The status of the resource.

StorageSize int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

Tags map[string]interface{}

Instance tag.

ZoneId string

The zone Id. Refer to "Instructions for Use".

autoPay Boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize Integer

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu Integer

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

createTime String

The creation time of the resource.

duration Integer

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints List<InstanceEndpoint>

List of domain names. See endpoints below.

gatewayCount Integer

Number of gateway nodes.

initialDatabases String

Initialize the database and split multiple database names ",".

instanceName String

The name of the resource.

instanceType String

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

leaderInstanceId String

The ID of the primary instance.

paymentType String

The payment type of the resource.

pricingCycle String

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId String

The ID of the resource group.

scaleType String

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status String

The status of the resource.

storageSize Integer

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Map<String,Object>

Instance tag.

zoneId String

The zone Id. Refer to "Instructions for Use".

autoPay boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize number

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu number

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

createTime string

The creation time of the resource.

duration number

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints InstanceEndpoint[]

List of domain names. See endpoints below.

gatewayCount number

Number of gateway nodes.

initialDatabases string

Initialize the database and split multiple database names ",".

instanceName string

The name of the resource.

instanceType string

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

leaderInstanceId string

The ID of the primary instance.

paymentType string

The payment type of the resource.

pricingCycle string

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId string

The ID of the resource group.

scaleType string

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status string

The status of the resource.

storageSize number

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags {[key: string]: any}

Instance tag.

zoneId string

The zone Id. Refer to "Instructions for Use".

auto_pay bool

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

cold_storage_size int

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu int

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

create_time str

The creation time of the resource.

duration int

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints Sequence[InstanceEndpointArgs]

List of domain names. See endpoints below.

gateway_count int

Number of gateway nodes.

initial_databases str

Initialize the database and split multiple database names ",".

instance_name str

The name of the resource.

instance_type str

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

leader_instance_id str

The ID of the primary instance.

payment_type str

The payment type of the resource.

pricing_cycle str

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resource_group_id str

The ID of the resource group.

scale_type str

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status str

The status of the resource.

storage_size int

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Mapping[str, Any]

Instance tag.

zone_id str

The zone Id. Refer to "Instructions for Use".

autoPay Boolean

Whether to pay automatically. The default value is true. Value:

true: automatic payment
false: only generate orders, not pay

NOTE: The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

coldStorageSize Number

Instance low-frequency storage space. Unit: GB.

NOTE: PayAsYouGo (PostPaid) instances ignore this parameter.

cpu Number

Instance specifications. Value:

8 cores 32 GB (number of compute nodes: 1)
16 cores 64 GB (number of compute nodes: 1)
32 core 128 GB (number of compute nodes: 2)
64 core 256 GB (number of compute nodes: 4)
96 core 384 GB (number of computing nodes: 6)
128 core 512 GB (number of compute nodes: 8)

NOTE: Just fill in the audit number. Please submit a work order application for purchasing 1024 or above specifications. Shared instance types do not need to specify specifications. The specification of - 8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

createTime String

The creation time of the resource.

duration Number

The buying cycle. Buy for 2 months. If the Payment type is PayAsYouGo (PostPaid), you do not need to specify it.

endpoints List<Property Map>

List of domain names. See endpoints below.

gatewayCount Number

Number of gateway nodes.

initialDatabases String

Initialize the database and split multiple database names ",".

instanceName String

The name of the resource.

instanceType String

The instance type. Value:

Standard: Universal.
Follower: Read-only slave instance.
Warehouse: calculation group type.
Shared: Shared.

leaderInstanceId String

The ID of the primary instance.

paymentType String

The payment type of the resource.

pricingCycle String

Billing cycle. Value:

Month: monthly billing
Hour: hourly billing

NOTE: Subscription instances (PrePaid) only supports Month. PayAsYouGo instances (PostPaid) only supports Hour. The Shared type is automatically set to Hour without specifying it.

resourceGroupId String

The ID of the resource group.

scaleType String

Change matching type. Value:

UPGRADE: UPGRADE
DOWNGRADE: Downgrading

NOTE: The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

status String

The status of the resource.

storageSize Number

The standard storage space of the instance. Unit: GB.

NOTE: PayAsYouGo instances (PostPaid) ignore this parameter.

tags Map<Any>

Instance tag.

zoneId String

The zone Id. Refer to "Instructions for Use".

Supporting Types

InstanceEndpoint, InstanceEndpointArgs

AlternativeEndpoints string: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
Enabled bool: Whether to turn on the network.
Endpoint string: Domain name.
Type string: The network type.
VpcId string: VPC primary key.
VpcInstanceId string: The vpc instance ID.
VswitchId string: The ID of the virtual switch.

AlternativeEndpoints string: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
Enabled bool: Whether to turn on the network.
Endpoint string: Domain name.
Type string: The network type.
VpcId string: VPC primary key.
VpcInstanceId string: The vpc instance ID.
VswitchId string: The ID of the virtual switch.

alternativeEndpoints String: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
enabled Boolean: Whether to turn on the network.
endpoint String: Domain name.
type String: The network type.
vpcId String: VPC primary key.
vpcInstanceId String: The vpc instance ID.
vswitchId String: The ID of the virtual switch.

alternativeEndpoints string: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
enabled boolean: Whether to turn on the network.
endpoint string: Domain name.
type string: The network type.
vpcId string: VPC primary key.
vpcInstanceId string: The vpc instance ID.
vswitchId string: The ID of the virtual switch.

alternative_endpoints str: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
enabled bool: Whether to turn on the network.
endpoint str: Domain name.
type str: The network type.
vpc_id str: VPC primary key.
vpc_instance_id str: The vpc instance ID.
vswitch_id str: The ID of the virtual switch.

alternativeEndpoints String: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint.
enabled Boolean: Whether to turn on the network.
endpoint String: Domain name.
type String: The network type.
vpcId String: VPC primary key.
vpcInstanceId String: The vpc instance ID.
vswitchId String: The ID of the virtual switch.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.59.1 published on Thursday, Jul 25, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.hologram.Instance

On this page

On this page

Import

Create Instance Resource

Constructor syntax

Parameters

Constructor example

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceEndpoint, InstanceEndpointArgs

Package Details

On this page

On this page