This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

log¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.log.Alert(resource_name, opts=None, alert_description=None, alert_displayname=None, alert_name=None, condition=None, dashboard=None, mute_until=None, notification_lists=None, notify_threshold=None, project_name=None, query_lists=None, schedule_interval=None, schedule_type=None, throttling=None, __props__=None, __name__=None, __opts__=None)¶

Create a Alert resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] alert_description: Alert description. :param pulumi.Input[str] alert_displayname: Alert displayname. :param pulumi.Input[str] alert_name: Name of logstore for configuring alarm service. :param pulumi.Input[str] condition: Conditional expression, such as: count> 100. :param pulumi.Input[float] mute_until: Timestamp, notifications before closing again. :param pulumi.Input[list] notification_lists: Alarm information notification list. :param pulumi.Input[float] notify_threshold: Notification threshold, which is not notified until the number of triggers is reached. The default is 1. :param pulumi.Input[str] project_name: The project name. :param pulumi.Input[list] query_lists: Multiple conditions for configured alarm query. :param pulumi.Input[str] schedule_interval: Execution interval. 60 seconds minimum, such as 60s, 1h. :param pulumi.Input[str] schedule_type: Default FixedRate. No need to configure this parameter. :param pulumi.Input[str] throttling: Notification interval, default is no interval. Support number + unit type, for example 60s, 1h.

The notification_lists object supports the following:

content (pulumi.Input[str]) - Notice content of alarm.
emailLists (pulumi.Input[list]) - Email address list.
mobileLists (pulumi.Input[list]) - SMS sending mobile number.
serviceUri (pulumi.Input[str]) - Request address.
type (pulumi.Input[str]) - Notification type. support Email, SMS, DingTalk.

The query_lists object supports the following:

chartTitle (pulumi.Input[str]) - chart title
end (pulumi.Input[str]) - end time. example: 20s.
logstore (pulumi.Input[str]) - Query logstore
query (pulumi.Input[str]) - query corresponding to chart. example: * AND aliyun.
start (pulumi.Input[str]) - begin time. example: -60s.
timeSpanType (pulumi.Input[str]) - default Custom. No need to configure this parameter.

alert_description: pulumi.Output[str] = None¶: Alert description.

alert_displayname: pulumi.Output[str] = None¶: Alert displayname.

alert_name: pulumi.Output[str] = None¶: Name of logstore for configuring alarm service.

condition: pulumi.Output[str] = None¶: Conditional expression, such as: count> 100.

mute_until: pulumi.Output[float] = None¶: Timestamp, notifications before closing again.

notification_lists: pulumi.Output[list] = None¶

Alarm information notification list.

content (str) - Notice content of alarm.
emailLists (list) - Email address list.
mobileLists (list) - SMS sending mobile number.
serviceUri (str) - Request address.
type (str) - Notification type. support Email, SMS, DingTalk.

notify_threshold: pulumi.Output[float] = None¶: Notification threshold, which is not notified until the number of triggers is reached. The default is 1.

project_name: pulumi.Output[str] = None¶: The project name.

query_lists: pulumi.Output[list] = None¶

Multiple conditions for configured alarm query.

chartTitle (str) - chart title
end (str) - end time. example: 20s.
logstore (str) - Query logstore
query (str) - query corresponding to chart. example: * AND aliyun.
start (str) - begin time. example: -60s.
timeSpanType (str) - default Custom. No need to configure this parameter.

schedule_interval: pulumi.Output[str] = None¶: Execution interval. 60 seconds minimum, such as 60s, 1h.

schedule_type: pulumi.Output[str] = None¶: Default FixedRate. No need to configure this parameter.

throttling: pulumi.Output[str] = None¶: Notification interval, default is no interval. Support number + unit type, for example 60s, 1h.

static get(resource_name, id, opts=None, alert_description=None, alert_displayname=None, alert_name=None, condition=None, dashboard=None, mute_until=None, notification_lists=None, notify_threshold=None, project_name=None, query_lists=None, schedule_interval=None, schedule_type=None, throttling=None)¶

Get an existing Alert resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
alert_description (pulumi.Input[str]) – Alert description.
alert_displayname (pulumi.Input[str]) – Alert displayname.
alert_name (pulumi.Input[str]) – Name of logstore for configuring alarm service.
condition (pulumi.Input[str]) – Conditional expression, such as: count> 100.
mute_until (pulumi.Input[float]) – Timestamp, notifications before closing again.
notification_lists (pulumi.Input[list]) – Alarm information notification list.
notify_threshold (pulumi.Input[float]) – Notification threshold, which is not notified until the number of triggers is reached. The default is 1.
project_name (pulumi.Input[str]) – The project name.
query_lists (pulumi.Input[list]) – Multiple conditions for configured alarm query.
schedule_interval (pulumi.Input[str]) – Execution interval. 60 seconds minimum, such as 60s, 1h.
schedule_type (pulumi.Input[str]) – Default FixedRate. No need to configure this parameter.
throttling (pulumi.Input[str]) – Notification interval, default is no interval. Support number + unit type, for example 60s, 1h.

The notification_lists object supports the following:

content (pulumi.Input[str]) - Notice content of alarm.
emailLists (pulumi.Input[list]) - Email address list.
mobileLists (pulumi.Input[list]) - SMS sending mobile number.
serviceUri (pulumi.Input[str]) - Request address.
type (pulumi.Input[str]) - Notification type. support Email, SMS, DingTalk.

The query_lists object supports the following:

chartTitle (pulumi.Input[str]) - chart title
end (pulumi.Input[str]) - end time. example: 20s.
logstore (pulumi.Input[str]) - Query logstore
query (pulumi.Input[str]) - query corresponding to chart. example: * AND aliyun.
start (pulumi.Input[str]) - begin time. example: -60s.
timeSpanType (pulumi.Input[str]) - default Custom. No need to configure this parameter.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.Audit(resource_name, opts=None, aliuid=None, display_name=None, multi_accounts=None, variable_map=None, __props__=None, __name__=None, __opts__=None)¶

SLS log audit exists in the form of log service app.

In addition to inheriting all SLS functions, it also enhances the real-time automatic centralized collection of audit related logs across multi cloud products under multi accounts, and provides support for storage, query and information summary required by audit. It covers actiontrail, OSS, NAS, SLB, API gateway, RDS, WAF, cloud firewall, cloud security center and other products.

NOTE: Available in 1.81.0

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.log.Audit("example",
    aliuid="12345678",
    display_name="tf-audit-test",
    variable_map={
        "actiontrail_enabled": "true",
        "actiontrail_ttl": "180",
        "oss_access_enabled": "true",
        "oss_access_ttl": "180",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
aliuid (pulumi.Input[str]) – Aliuid value of your account.
display_name (pulumi.Input[str]) – Name of SLS log audit.
multi_accounts (pulumi.Input[list]) – Multi-account configuration, please fill in multiple aliuid.
variable_map (pulumi.Input[dict]) – Log audit detailed configuration.

aliuid: pulumi.Output[str] = None¶: Aliuid value of your account.

display_name: pulumi.Output[str] = None¶: Name of SLS log audit.

multi_accounts: pulumi.Output[list] = None¶: Multi-account configuration, please fill in multiple aliuid.

variable_map: pulumi.Output[dict] = None¶: Log audit detailed configuration.

static get(resource_name, id, opts=None, aliuid=None, display_name=None, multi_accounts=None, variable_map=None)¶

Get an existing Audit resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
aliuid (pulumi.Input[str]) – Aliuid value of your account.
display_name (pulumi.Input[str]) – Name of SLS log audit.
multi_accounts (pulumi.Input[list]) – Multi-account configuration, please fill in multiple aliuid.
variable_map (pulumi.Input[dict]) – Log audit detailed configuration.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.Dashboard(resource_name, opts=None, char_list=None, dashboard_name=None, display_name=None, project_name=None, __props__=None, __name__=None, __opts__=None)¶

The dashboard is a real-time data analysis platform provided by the log service. You can display frequently used query and analysis statements in the form of charts and save statistical charts to the dashboard. Refer to details.

NOTE: Available in 1.86.0

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
char_list (pulumi.Input[str]) – Configuration of charts in the dashboard.
dashboard_name (pulumi.Input[str]) – The name of the Log Dashboard.
display_name (pulumi.Input[str]) – Dashboard alias.
project_name (pulumi.Input[str]) – The name of the log project. It is the only in one Alicloud account.

char_list: pulumi.Output[str] = None¶: Configuration of charts in the dashboard.

dashboard_name: pulumi.Output[str] = None¶: The name of the Log Dashboard.

display_name: pulumi.Output[str] = None¶: Dashboard alias.

project_name: pulumi.Output[str] = None¶: The name of the log project. It is the only in one Alicloud account.

static get(resource_name, id, opts=None, char_list=None, dashboard_name=None, display_name=None, project_name=None)¶

Get an existing Dashboard resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
char_list (pulumi.Input[str]) – Configuration of charts in the dashboard.
dashboard_name (pulumi.Input[str]) – The name of the Log Dashboard.
display_name (pulumi.Input[str]) – Dashboard alias.
project_name (pulumi.Input[str]) – The name of the log project. It is the only in one Alicloud account.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.LogTailAttachment(resource_name, opts=None, logtail_config_name=None, machine_group_name=None, project=None, __props__=None, __name__=None, __opts__=None)¶

Create a LogTailAttachment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] logtail_config_name: The Logtail configuration name, which is unique in the same project. :param pulumi.Input[str] machine_group_name: The machine group name, which is unique in the same project. :param pulumi.Input[str] project: The project name to the log store belongs.

logtail_config_name: pulumi.Output[str] = None¶: The Logtail configuration name, which is unique in the same project.

machine_group_name: pulumi.Output[str] = None¶: The machine group name, which is unique in the same project.

project: pulumi.Output[str] = None¶: The project name to the log store belongs.

static get(resource_name, id, opts=None, logtail_config_name=None, machine_group_name=None, project=None)¶

Get an existing LogTailAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
logtail_config_name (pulumi.Input[str]) – The Logtail configuration name, which is unique in the same project.
machine_group_name (pulumi.Input[str]) – The machine group name, which is unique in the same project.
project (pulumi.Input[str]) – The project name to the log store belongs.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.LogTailConfig(resource_name, opts=None, input_detail=None, input_type=None, log_sample=None, logstore=None, name=None, output_type=None, project=None, __props__=None, __name__=None, __opts__=None)¶

Create a LogTailConfig resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] input_detail: The logtail configure the required JSON files. (Refer to details) :param pulumi.Input[str] input_type: The input type. Currently only two types of files and plugin are supported. :param pulumi.Input[str] log_sample: （Optional）The log sample of the Logtail configuration. The log size cannot exceed 1,000 bytes. :param pulumi.Input[str] logstore: The log store name to the query index belongs. :param pulumi.Input[str] name: The Logtail configuration name, which is unique in the same project. :param pulumi.Input[str] output_type: The output type. Currently, only LogService is supported. :param pulumi.Input[str] project: The project name to the log store belongs.

input_detail: pulumi.Output[str] = None¶: The logtail configure the required JSON files. (Refer to details)

input_type: pulumi.Output[str] = None¶: The input type. Currently only two types of files and plugin are supported.

log_sample: pulumi.Output[str] = None¶: （Optional）The log sample of the Logtail configuration. The log size cannot exceed 1,000 bytes.

logstore: pulumi.Output[str] = None¶: The log store name to the query index belongs.

name: pulumi.Output[str] = None¶: The Logtail configuration name, which is unique in the same project.

output_type: pulumi.Output[str] = None¶: The output type. Currently, only LogService is supported.

project: pulumi.Output[str] = None¶: The project name to the log store belongs.

static get(resource_name, id, opts=None, input_detail=None, input_type=None, log_sample=None, logstore=None, name=None, output_type=None, project=None)¶

Get an existing LogTailConfig resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
input_detail (pulumi.Input[str]) –
The logtail configure the required JSON files. (Refer to details)
input_type (pulumi.Input[str]) – The input type. Currently only two types of files and plugin are supported.
log_sample (pulumi.Input[str]) – （Optional）The log sample of the Logtail configuration. The log size cannot exceed 1,000 bytes.
logstore (pulumi.Input[str]) – The log store name to the query index belongs.
name (pulumi.Input[str]) – The Logtail configuration name, which is unique in the same project.
output_type (pulumi.Input[str]) – The output type. Currently, only LogService is supported.
project (pulumi.Input[str]) – The project name to the log store belongs.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.MachineGroup(resource_name, opts=None, identify_lists=None, identify_type=None, name=None, project=None, topic=None, __props__=None, __name__=None, __opts__=None)¶

Create a MachineGroup resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] identify_lists: The specific machine identification, which can be an IP address or user-defined identity. :param pulumi.Input[str] identify_type: The machine identification type, including IP and user-defined identity. Valid values are “ip” and “userdefined”. Default to “ip”. :param pulumi.Input[str] name: The machine group name, which is unique in the same project. :param pulumi.Input[str] project: The project name to the machine group belongs. :param pulumi.Input[str] topic: The topic of a machine group.

identify_lists: pulumi.Output[list] = None¶: The specific machine identification, which can be an IP address or user-defined identity.

identify_type: pulumi.Output[str] = None¶: The machine identification type, including IP and user-defined identity. Valid values are “ip” and “userdefined”. Default to “ip”.

name: pulumi.Output[str] = None¶: The machine group name, which is unique in the same project.

project: pulumi.Output[str] = None¶: The project name to the machine group belongs.

topic: pulumi.Output[str] = None¶: The topic of a machine group.

static get(resource_name, id, opts=None, identify_lists=None, identify_type=None, name=None, project=None, topic=None)¶

Get an existing MachineGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
identify_lists (pulumi.Input[list]) – The specific machine identification, which can be an IP address or user-defined identity.
identify_type (pulumi.Input[str]) – The machine identification type, including IP and user-defined identity. Valid values are “ip” and “userdefined”. Default to “ip”.
name (pulumi.Input[str]) – The machine group name, which is unique in the same project.
project (pulumi.Input[str]) – The project name to the machine group belongs.
topic (pulumi.Input[str]) – The topic of a machine group.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.Project(resource_name, opts=None, description=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a Project resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: Description of the log project. :param pulumi.Input[str] name: The name of the log project. It is the only in one Alicloud account.

description: pulumi.Output[str] = None¶: Description of the log project.

name: pulumi.Output[str] = None¶: The name of the log project. It is the only in one Alicloud account.

static get(resource_name, id, opts=None, description=None, name=None)¶

Get an existing Project resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Description of the log project.
name (pulumi.Input[str]) – The name of the log project. It is the only in one Alicloud account.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.Store(resource_name, opts=None, append_meta=None, auto_split=None, enable_web_tracking=None, max_split_shard_count=None, name=None, project=None, retention_period=None, shard_count=None, __props__=None, __name__=None, __opts__=None)¶

Create a Store resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] append_meta: Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. :param pulumi.Input[bool] auto_split: Determines whether to automatically split a shard. Default to true. :param pulumi.Input[bool] enable_web_tracking: Determines whether to enable Web Tracking. Default false. :param pulumi.Input[float] max_split_shard_count: The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. :param pulumi.Input[str] name: The log store, which is unique in the same project. :param pulumi.Input[str] project: The project name to the log store belongs. :param pulumi.Input[float] retention_period: The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is “3650”. :param pulumi.Input[float] shard_count: The number of shards in this log store. Default to 2. You can modify it by “Split” or “Merge” operations. Refer to details

append_meta: pulumi.Output[bool] = None¶: Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true.

auto_split: pulumi.Output[bool] = None¶: Determines whether to automatically split a shard. Default to true.

enable_web_tracking: pulumi.Output[bool] = None¶: Determines whether to enable Web Tracking. Default false.

max_split_shard_count: pulumi.Output[float] = None¶: The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true.

name: pulumi.Output[str] = None¶: The log store, which is unique in the same project.

project: pulumi.Output[str] = None¶: The project name to the log store belongs.

retention_period: pulumi.Output[float] = None¶: The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is “3650”.

shard_count: pulumi.Output[float] = None¶: The number of shards in this log store. Default to 2. You can modify it by “Split” or “Merge” operations. Refer to details

static get(resource_name, id, opts=None, append_meta=None, auto_split=None, enable_web_tracking=None, max_split_shard_count=None, name=None, project=None, retention_period=None, shard_count=None, shards=None)¶

Get an existing Store resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
append_meta (pulumi.Input[bool]) – Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true.
auto_split (pulumi.Input[bool]) – Determines whether to automatically split a shard. Default to true.
enable_web_tracking (pulumi.Input[bool]) – Determines whether to enable Web Tracking. Default false.
max_split_shard_count (pulumi.Input[float]) – The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true.
name (pulumi.Input[str]) – The log store, which is unique in the same project.
project (pulumi.Input[str]) – The project name to the log store belongs.
retention_period (pulumi.Input[float]) – The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is “3650”.
shard_count (pulumi.Input[float]) –
The number of shards in this log store. Default to 2. You can modify it by “Split” or “Merge” operations. Refer to details

The shards object supports the following:

beginKey (pulumi.Input[str])
endKey (pulumi.Input[str])
id (pulumi.Input[float]) - The ID of the log project. It formats of <project>:<name>.
status (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.log.StoreIndex(resource_name, opts=None, field_searches=None, full_text=None, logstore=None, project=None, __props__=None, __name__=None, __opts__=None)¶

Create a StoreIndex resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[list] field_searches: List configurations of field search index. Valid item as follows:
:param pulumi.Input[dict] full_text: The configuration of full text index. Valid item as follows:
:param pulumi.Input[str] logstore: The log store name to the query index belongs.
:param pulumi.Input[str] project: The project name to the log store belongs.

The **field_searches** object supports the following:

  * `alias` (`pulumi.Input[str]`) - The alias of one field.
  * `caseSensitive` (`pulumi.Input[bool]`) - Whether the case sensitive for the field. Default to false. It is valid when "type" is "text" or "json".
  * `enableAnalytics` (`pulumi.Input[bool]`) - Whether to enable field analytics. Default to true.
  * `includeChinese` (`pulumi.Input[bool]`) - Whether includes the chinese for the field. Default to false. It is valid when "type" is "text" or "json".
  * `jsonKeys` (`pulumi.Input[list]`) - Use nested index when type is json
    * `alias` (`pulumi.Input[str]`) - The alias of one field.
    * `docValue` (`pulumi.Input[bool]`) - Whether to enable statistics. default to true.
    * `name` (`pulumi.Input[str]`) - When using the json_keys field, this field is required.
    * `type` (`pulumi.Input[str]`) - The type of one field. Valid values: ["long", "text", "double"]. Default to "long"

  * `name` (`pulumi.Input[str]`) - When using the json_keys field, this field is required.
  * `token` (`pulumi.Input[str]`) - The string of several split words, like "

“, “#”. It is valid when “type” is “text” or “json”.

  * `type` (`pulumi.Input[str]`) - The type of one field. Valid values: ["long", "text", "double"]. Default to "long"

The **full_text** object supports the following:

  * `caseSensitive` (`pulumi.Input[bool]`) - Whether the case sensitive for the field. Default to false. It is valid when "type" is "text" or "json".
  * `includeChinese` (`pulumi.Input[bool]`) - Whether includes the chinese for the field. Default to false. It is valid when "type" is "text" or "json".
  * `token` (`pulumi.Input[str]`) - The string of several split words, like "

“, “#”. It is valid when “type” is “text” or “json”.

field_searches: pulumi.Output[list] = None¶

List configurations of field search index. Valid item as follows:

alias (str) - The alias of one field.
caseSensitive (bool) - Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.
enableAnalytics (bool) - Whether to enable field analytics. Default to true.
includeChinese (bool) - Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.
jsonKeys (list) - Use nested index when type is json
- alias (str) - The alias of one field.
- docValue (bool) - Whether to enable statistics. default to true.
- name (str) - When using the json_keys field, this field is required.
- type (str) - The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”
name (str) - When using the json_keys field, this field is required.
token (str) - The string of several split words, like ” “, “#”. It is valid when “type” is “text” or “json”.
type (str) - The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”

full_text: pulumi.Output[dict] = None¶

The configuration of full text index. Valid item as follows:

caseSensitive (bool) - Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.
includeChinese (bool) - Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.
token (str) - The string of several split words, like ” “, “#”. It is valid when “type” is “text” or “json”.

logstore: pulumi.Output[str] = None¶: The log store name to the query index belongs.

project: pulumi.Output[str] = None¶: The project name to the log store belongs.

static get(resource_name, id, opts=None, field_searches=None, full_text=None, logstore=None, project=None)¶

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

:param str resource_name: The unique name of the resulting resource.
:param str id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[list] field_searches: List configurations of field search index. Valid item as follows:
:param pulumi.Input[dict] full_text: The configuration of full text index. Valid item as follows:
:param pulumi.Input[str] logstore: The log store name to the query index belongs.
:param pulumi.Input[str] project: The project name to the log store belongs.

The **field_searches** object supports the following:

  * `alias` (`pulumi.Input[str]`) - The alias of one field.
  * `caseSensitive` (`pulumi.Input[bool]`) - Whether the case sensitive for the field. Default to false. It is valid when "type" is "text" or "json".
  * `enableAnalytics` (`pulumi.Input[bool]`) - Whether to enable field analytics. Default to true.
  * `includeChinese` (`pulumi.Input[bool]`) - Whether includes the chinese for the field. Default to false. It is valid when "type" is "text" or "json".
  * `jsonKeys` (`pulumi.Input[list]`) - Use nested index when type is json
    * `alias` (`pulumi.Input[str]`) - The alias of one field.
    * `docValue` (`pulumi.Input[bool]`) - Whether to enable statistics. default to true.
    * `name` (`pulumi.Input[str]`) - When using the json_keys field, this field is required.
    * `type` (`pulumi.Input[str]`) - The type of one field. Valid values: ["long", "text", "double"]. Default to "long"

  * `name` (`pulumi.Input[str]`) - When using the json_keys field, this field is required.
  * `token` (`pulumi.Input[str]`) - The string of several split words, like "

“, “#”. It is valid when “type” is “text” or “json”.

  * `type` (`pulumi.Input[str]`) - The type of one field. Valid values: ["long", "text", "double"]. Default to "long"

The **full_text** object supports the following:

  * `caseSensitive` (`pulumi.Input[bool]`) - Whether the case sensitive for the field. Default to false. It is valid when "type" is "text" or "json".
  * `includeChinese` (`pulumi.Input[bool]`) - Whether includes the chinese for the field. Default to false. It is valid when "type" is "text" or "json".
  * `token` (`pulumi.Input[str]`) - The string of several split words, like "

“, “#”. It is valid when “type” is “text” or “json”.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

log¶

On This Page