Docs Packages
  1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. opensearch
  5. AppGroup
alicloud logo
Alibaba Cloud v3.37.0, May 15 23

alicloud.opensearch.AppGroup

Explore with Pulumi AI

Provides a Open Search App Group resource.

For information about Open Search App Group and how to use it, see What is App Group.

NOTE: Available in v1.136.0+.

Example Usage

Basic Usage

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") ?? "name";
    var @default = new AliCloud.OpenSearch.AppGroup("default", new()
    {
        AppGroupName = name,
        PaymentType = "PayAsYouGo",
        Type = "standard",
        Quota = new AliCloud.OpenSearch.Inputs.AppGroupQuotaArgs
        {
            DocSize = 1,
            ComputeResource = 20,
            Spec = "opensearch.share.common",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/opensearch"
	"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 := "name"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := opensearch.NewAppGroup(ctx, "default", &opensearch.AppGroupArgs{
			AppGroupName: pulumi.String(name),
			PaymentType:  pulumi.String("PayAsYouGo"),
			Type:         pulumi.String("standard"),
			Quota: &opensearch.AppGroupQuotaArgs{
				DocSize:         pulumi.Int(1),
				ComputeResource: pulumi.Int(20),
				Spec:            pulumi.String("opensearch.share.common"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.opensearch.AppGroup;
import com.pulumi.alicloud.opensearch.AppGroupArgs;
import com.pulumi.alicloud.opensearch.inputs.AppGroupQuotaArgs;
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("name");
        var default_ = new AppGroup("default", AppGroupArgs.builder()        
            .appGroupName(name)
            .paymentType("PayAsYouGo")
            .type("standard")
            .quota(AppGroupQuotaArgs.builder()
                .docSize(1)
                .computeResource(20)
                .spec("opensearch.share.common")
                .build())
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "name"
default = alicloud.opensearch.AppGroup("default",
    app_group_name=name,
    payment_type="PayAsYouGo",
    type="standard",
    quota=alicloud.opensearch.AppGroupQuotaArgs(
        doc_size=1,
        compute_resource=20,
        spec="opensearch.share.common",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "name";
const _default = new alicloud.opensearch.AppGroup("default", {
    appGroupName: name,
    paymentType: "PayAsYouGo",
    type: "standard",
    quota: {
        docSize: 1,
        computeResource: 20,
        spec: "opensearch.share.common",
    },
});

configuration:
  name:
    type: string
    default: name
resources:
  default:
    type: alicloud:opensearch:AppGroup
    properties:
      appGroupName: ${name}
      paymentType: PayAsYouGo
      type: standard
      quota:
        docSize: 1
        computeResource: 20
        spec: opensearch.share.common

Create AppGroup Resource

new AppGroup(name: string, args: AppGroupArgs, opts?: CustomResourceOptions);
@overload
def AppGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             app_group_name: Optional[str] = None,
             charge_way: Optional[str] = None,
             current_version: Optional[str] = None,
             description: Optional[str] = None,
             order_type: Optional[str] = None,
             orders: Optional[Sequence[AppGroupOrderArgs]] = None,
             payment_type: Optional[str] = None,
             quota: Optional[AppGroupQuotaArgs] = None,
             type: Optional[str] = None)
@overload
def AppGroup(resource_name: str,
             args: AppGroupArgs,
             opts: Optional[ResourceOptions] = None)
func NewAppGroup(ctx *Context, name string, args AppGroupArgs, opts ...ResourceOption) (*AppGroup, error)
public AppGroup(string name, AppGroupArgs args, CustomResourceOptions? opts = null)
public AppGroup(String name, AppGroupArgs args)
public AppGroup(String name, AppGroupArgs args, CustomResourceOptions options)

type: alicloud:opensearch:AppGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppGroupArgs
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 AppGroupArgs
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 AppGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AppGroupName string

Application Group Name.

PaymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

Quota Pulumi.AliCloud.OpenSearch.Inputs.AppGroupQuotaArgs

Quota information. The details see Block quota.

Type string

Application type. Valid Values: standard, enhanced.

ChargeWay string

Billing model. Valid values:compute_resource and qps.

CurrentVersion string

The version of Application Group Name.

Description string

The description of the resource.

OrderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

Orders List<Pulumi.AliCloud.OpenSearch.Inputs.AppGroupOrderArgs>

Order cycle information. The details see Block order.

AppGroupName string

Application Group Name.

PaymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

Quota AppGroupQuotaArgs

Quota information. The details see Block quota.

Type string

Application type. Valid Values: standard, enhanced.

ChargeWay string

Billing model. Valid values:compute_resource and qps.

CurrentVersion string

The version of Application Group Name.

Description string

The description of the resource.

OrderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

Orders []AppGroupOrderArgs

Order cycle information. The details see Block order.

appGroupName String

Application Group Name.

paymentType String

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

type String

Application type. Valid Values: standard, enhanced.

chargeWay String

Billing model. Valid values:compute_resource and qps.

currentVersion String

The version of Application Group Name.

description String

The description of the resource.

orderType String

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders List<AppGroupOrderArgs>

Order cycle information. The details see Block order.

appGroupName string

Application Group Name.

paymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

type string

Application type. Valid Values: standard, enhanced.

chargeWay string

Billing model. Valid values:compute_resource and qps.

currentVersion string

The version of Application Group Name.

description string

The description of the resource.

orderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders AppGroupOrderArgs[]

Order cycle information. The details see Block order.

app_group_name str

Application Group Name.

payment_type str

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

type str

Application type. Valid Values: standard, enhanced.

charge_way str

Billing model. Valid values:compute_resource and qps.

current_version str

The version of Application Group Name.

description str

The description of the resource.

order_type str

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders Sequence[AppGroupOrderArgs]

Order cycle information. The details see Block order.

appGroupName String

Application Group Name.

paymentType String

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota Property Map

Quota information. The details see Block quota.

type String

Application type. Valid Values: standard, enhanced.

chargeWay String

Billing model. Valid values:compute_resource and qps.

currentVersion String

The version of Application Group Name.

description String

The description of the resource.

orderType String

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders List<Property Map>

Order cycle information. The details see Block order.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

InstanceId string

The instance id.

Status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

Id string

The provider-assigned unique ID for this managed resource.

InstanceId string

The instance id.

Status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

id String

The provider-assigned unique ID for this managed resource.

instanceId String

The instance id.

status String

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

id string

The provider-assigned unique ID for this managed resource.

instanceId string

The instance id.

status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

id str

The provider-assigned unique ID for this managed resource.

instance_id str

The instance id.

status str

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

id String

The provider-assigned unique ID for this managed resource.

instanceId String

The instance id.

status String

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

Look up Existing AppGroup Resource

Get an existing AppGroup 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?: AppGroupState, opts?: CustomResourceOptions): AppGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_group_name: Optional[str] = None,
        charge_way: Optional[str] = None,
        current_version: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        order_type: Optional[str] = None,
        orders: Optional[Sequence[AppGroupOrderArgs]] = None,
        payment_type: Optional[str] = None,
        quota: Optional[AppGroupQuotaArgs] = None,
        status: Optional[str] = None,
        type: Optional[str] = None) -> AppGroup
func GetAppGroup(ctx *Context, name string, id IDInput, state *AppGroupState, opts ...ResourceOption) (*AppGroup, error)
public static AppGroup Get(string name, Input<string> id, AppGroupState? state, CustomResourceOptions? opts = null)
public static AppGroup get(String name, Output<String> id, AppGroupState 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:
AppGroupName string

Application Group Name.

ChargeWay string

Billing model. Valid values:compute_resource and qps.

CurrentVersion string

The version of Application Group Name.

Description string

The description of the resource.

InstanceId string

The instance id.

OrderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

Orders List<Pulumi.AliCloud.OpenSearch.Inputs.AppGroupOrderArgs>

Order cycle information. The details see Block order.

PaymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

Quota Pulumi.AliCloud.OpenSearch.Inputs.AppGroupQuotaArgs

Quota information. The details see Block quota.

Status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

Type string

Application type. Valid Values: standard, enhanced.

AppGroupName string

Application Group Name.

ChargeWay string

Billing model. Valid values:compute_resource and qps.

CurrentVersion string

The version of Application Group Name.

Description string

The description of the resource.

InstanceId string

The instance id.

OrderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

Orders []AppGroupOrderArgs

Order cycle information. The details see Block order.

PaymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

Quota AppGroupQuotaArgs

Quota information. The details see Block quota.

Status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

Type string

Application type. Valid Values: standard, enhanced.

appGroupName String

Application Group Name.

chargeWay String

Billing model. Valid values:compute_resource and qps.

currentVersion String

The version of Application Group Name.

description String

The description of the resource.

instanceId String

The instance id.

orderType String

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders List<AppGroupOrderArgs>

Order cycle information. The details see Block order.

paymentType String

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

status String

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

type String

Application type. Valid Values: standard, enhanced.

appGroupName string

Application Group Name.

chargeWay string

Billing model. Valid values:compute_resource and qps.

currentVersion string

The version of Application Group Name.

description string

The description of the resource.

instanceId string

The instance id.

orderType string

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders AppGroupOrderArgs[]

Order cycle information. The details see Block order.

paymentType string

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

status string

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

type string

Application type. Valid Values: standard, enhanced.

app_group_name str

Application Group Name.

charge_way str

Billing model. Valid values:compute_resource and qps.

current_version str

The version of Application Group Name.

description str

The description of the resource.

instance_id str

The instance id.

order_type str

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders Sequence[AppGroupOrderArgs]

Order cycle information. The details see Block order.

payment_type str

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota AppGroupQuotaArgs

Quota information. The details see Block quota.

status str

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

type str

Application type. Valid Values: standard, enhanced.

appGroupName String

Application Group Name.

chargeWay String

Billing model. Valid values:compute_resource and qps.

currentVersion String

The version of Application Group Name.

description String

The description of the resource.

instanceId String

The instance id.

orderType String

Order change type. Valid values: UPGRADE and DOWNGRADE.

orders List<Property Map>

Order cycle information. The details see Block order.

paymentType String

The billing method of the resource. Valid values: Subscription and PayAsYouGo.

quota Property Map

Quota information. The details see Block quota.

status String

The status of the resource. Valid values: producing,review_pending,config_pending,normal,frozen.

type String

Application type. Valid Values: standard, enhanced.

Supporting Types

AppGroupOrder

AutoRenew bool

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

Duration int

Order cycle. The minimum value is not less than 0.

PricingCycle string

Order cycle unit. Valid values: Year and Month.

AutoRenew bool

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

Duration int

Order cycle. The minimum value is not less than 0.

PricingCycle string

Order cycle unit. Valid values: Year and Month.

autoRenew Boolean

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

duration Integer

Order cycle. The minimum value is not less than 0.

pricingCycle String

Order cycle unit. Valid values: Year and Month.

autoRenew boolean

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

duration number

Order cycle. The minimum value is not less than 0.

pricingCycle string

Order cycle unit. Valid values: Year and Month.

auto_renew bool

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

duration int

Order cycle. The minimum value is not less than 0.

pricing_cycle str

Order cycle unit. Valid values: Year and Month.

autoRenew Boolean

Whether to renew automatically. It only takes effect when the parameter payment_type takes the value Subscription.

duration Number

Order cycle. The minimum value is not less than 0.

pricingCycle String

Order cycle unit. Valid values: Year and Month.

AppGroupQuota

ComputeResource int

Computing resources. Unit: LCU.

DocSize int

Storage Size. Unit: GB.

Spec string

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
Qps int

Search request. Unit: times/second.

ComputeResource int

Computing resources. Unit: LCU.

DocSize int

Storage Size. Unit: GB.

Spec string

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
Qps int

Search request. Unit: times/second.

computeResource Integer

Computing resources. Unit: LCU.

docSize Integer

Storage Size. Unit: GB.

spec String

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
qps Integer

Search request. Unit: times/second.

computeResource number

Computing resources. Unit: LCU.

docSize number

Storage Size. Unit: GB.

spec string

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
qps number

Search request. Unit: times/second.

compute_resource int

Computing resources. Unit: LCU.

doc_size int

Storage Size. Unit: GB.

spec str

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
qps int

Search request. Unit: times/second.

computeResource Number

Computing resources. Unit: LCU.

docSize Number

Storage Size. Unit: GB.

spec String

Specification. Valid values:

  • opensearch.share.junior: Entry-level.
  • opensearch.share.common: Shared universal.
  • opensearch.share.compute: Shared computing.
  • opensearch.share.storage: Shared storage type.
  • opensearch.private.common: Exclusive universal type.
  • opensearch.private.compute: Exclusive computing type.
  • opensearch.private.storage: Exclusive storage type
qps Number

Search request. Unit: times/second.

Import

Open Search App Group can be imported using the id, e.g.

 $ pulumi import alicloud:opensearch/appGroup:AppGroup example <id>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.