Package-level declarations

Types

Link copied to clipboard
class Alert : KotlinCustomResource

Log alert is a unit of log service, which is used to monitor and alert the user's logstore status information. Log Service enables you to configure alerts based on the charts in a dashboard to monitor the service status in real time. For information about SLS Alert and how to use it, see SLS Alert Overview

Link copied to clipboard
data class AlertArgs(val alertDescription: Output<String>? = null, val alertDisplayname: Output<String>? = null, val alertName: Output<String>? = null, val annotations: Output<List<AlertAnnotationArgs>>? = null, val autoAnnotation: Output<Boolean>? = null, val condition: Output<String>? = null, val dashboard: Output<String>? = null, val groupConfiguration: Output<AlertGroupConfigurationArgs>? = null, val joinConfigurations: Output<List<AlertJoinConfigurationArgs>>? = null, val labels: Output<List<AlertLabelArgs>>? = null, val muteUntil: Output<Int>? = null, val noDataFire: Output<Boolean>? = null, val noDataSeverity: Output<Int>? = null, val notificationLists: Output<List<AlertNotificationListArgs>>? = null, val notifyThreshold: Output<Int>? = null, val policyConfiguration: Output<AlertPolicyConfigurationArgs>? = null, val projectName: Output<String>? = null, val queryLists: Output<List<AlertQueryListArgs>>? = null, val schedule: Output<AlertScheduleArgs>? = null, val scheduleInterval: Output<String>? = null, val scheduleType: Output<String>? = null, val sendResolved: Output<Boolean>? = null, val severityConfigurations: Output<List<AlertSeverityConfigurationArgs>>? = null, val templateConfiguration: Output<AlertTemplateConfigurationArgs>? = null, val threshold: Output<Int>? = null, val throttling: Output<String>? = null, val type: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<AlertArgs>

Log alert is a unit of log service, which is used to monitor and alert the user's logstore status information. Log Service enables you to configure alerts based on the charts in a dashboard to monitor the service status in real time. For information about SLS Alert and how to use it, see SLS Alert Overview

Link copied to clipboard

Builder for AlertArgs.

Link copied to clipboard
object AlertMapper : ResourceMapper<Alert>
Link copied to clipboard
class AlertResource : KotlinCustomResource

Using this resource can init SLS Alert resources automatically. For information about SLS Alert and how to use it, see SLS Alert Overview

Link copied to clipboard
data class AlertResourceArgs(val lang: Output<String>? = null, val project: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<AlertResourceArgs>

Using this resource can init SLS Alert resources automatically. For information about SLS Alert and how to use it, see SLS Alert Overview

Link copied to clipboard
Link copied to clipboard

Builder for Alert.

Link copied to clipboard
object AlertResourceMapper : ResourceMapper<AlertResource>
Link copied to clipboard
Link copied to clipboard
class Audit : KotlinCustomResource

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.

Link copied to clipboard
data class AuditArgs(val aliuid: Output<String>? = null, val displayName: Output<String>? = null, val multiAccounts: Output<List<String>>? = null, val resourceDirectoryType: Output<String>? = null, val variableMap: Output<Map<String, String>>? = null) : ConvertibleToJava<AuditArgs>

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.

Link copied to clipboard

Builder for AuditArgs.

Link copied to clipboard
object AuditMapper : ResourceMapper<Audit>
Link copied to clipboard

Builder for Audit.

Link copied to clipboard
class Dashboard : KotlinCustomResource

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.

Link copied to clipboard
data class DashboardArgs(val attribute: Output<String>? = null, val charList: Output<String>? = null, val dashboardName: Output<String>? = null, val displayName: Output<String>? = null, val projectName: Output<String>? = null) : ConvertibleToJava<DashboardArgs>

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.

Link copied to clipboard
Link copied to clipboard
object DashboardMapper : ResourceMapper<Dashboard>
Link copied to clipboard
Link copied to clipboard
class Etl : KotlinCustomResource

The data transformation of the log service is a hosted, highly available, and scalable data processing service, which is widely applicable to scenarios such as data regularization, enrichment, distribution, aggregation, and index reconstruction. Refer to details.

Link copied to clipboard
data class EtlArgs(val accessKeyId: Output<String>? = null, val accessKeySecret: Output<String>? = null, val createTime: Output<Int>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val etlName: Output<String>? = null, val etlSinks: Output<List<EtlEtlSinkArgs>>? = null, val etlType: Output<String>? = null, val fromTime: Output<Int>? = null, val kmsEncryptedAccessKeyId: Output<String>? = null, val kmsEncryptedAccessKeySecret: Output<String>? = null, val kmsEncryptionAccessKeyIdContext: Output<Map<String, String>>? = null, val kmsEncryptionAccessKeySecretContext: Output<Map<String, String>>? = null, val lastModifiedTime: Output<Int>? = null, val logstore: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val project: Output<String>? = null, val roleArn: Output<String>? = null, val schedule: Output<String>? = null, val script: Output<String>? = null, val status: Output<String>? = null, val toTime: Output<Int>? = null, val version: Output<Int>? = null) : ConvertibleToJava<EtlArgs>

The data transformation of the log service is a hosted, highly available, and scalable data processing service, which is widely applicable to scenarios such as data regularization, enrichment, distribution, aggregation, and index reconstruction. Refer to details.

Link copied to clipboard

Builder for EtlArgs.

Link copied to clipboard
object EtlMapper : ResourceMapper<Etl>
Link copied to clipboard

Builder for Etl.

Link copied to clipboard
class Ingestion : KotlinCustomResource

Log service ingestion, this service provides the function of importing logs of various data sources(OSS, MaxCompute) into logstore. Refer to details.

Link copied to clipboard
data class IngestionArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val ingestionName: Output<String>? = null, val interval: Output<String>? = null, val logstore: Output<String>? = null, val project: Output<String>? = null, val runImmediately: Output<Boolean>? = null, val source: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<IngestionArgs>

Log service ingestion, this service provides the function of importing logs of various data sources(OSS, MaxCompute) into logstore. Refer to details.

Link copied to clipboard
Link copied to clipboard
object IngestionMapper : ResourceMapper<Ingestion>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class LogTailAttachment : KotlinCustomResource

The Logtail access service is a log collection agent provided by Log Service. You can use Logtail to collect logs from servers such as Alibaba Cloud Elastic Compute Service (ECS) instances in real time in the Log Service console. Refer to details This resource amis to attach one logtail configure to a machine group.

Link copied to clipboard
data class LogTailAttachmentArgs(val logtailConfigName: Output<String>? = null, val machineGroupName: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<LogTailAttachmentArgs>

The Logtail access service is a log collection agent provided by Log Service. You can use Logtail to collect logs from servers such as Alibaba Cloud Elastic Compute Service (ECS) instances in real time in the Log Service console. Refer to details This resource amis to attach one logtail configure to a machine group.

Link copied to clipboard
object LogTailAttachmentMapper : ResourceMapper<LogTailAttachment>
Link copied to clipboard
class LogTailConfig : KotlinCustomResource

The Logtail access service is a log collection agent provided by Log Service. You can use Logtail to collect logs from servers such as Alibaba Cloud Elastic Compute Service (ECS) instances in real time in the Log Service console. Refer to details(https://www.alibabacloud.com/help/doc-detail/29058.htm

Link copied to clipboard
data class LogTailConfigArgs(val inputDetail: Output<String>? = null, val inputType: Output<String>? = null, val logSample: Output<String>? = null, val logstore: Output<String>? = null, val name: Output<String>? = null, val outputType: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<LogTailConfigArgs>

The Logtail access service is a log collection agent provided by Log Service. You can use Logtail to collect logs from servers such as Alibaba Cloud Elastic Compute Service (ECS) instances in real time in the Log Service console. Refer to details(https://www.alibabacloud.com/help/doc-detail/29058.htm

Link copied to clipboard
Link copied to clipboard
object LogTailConfigMapper : ResourceMapper<LogTailConfig>
Link copied to clipboard
Link copied to clipboard
class MachineGroup : KotlinCustomResource

Log Service manages all the ECS instances whose logs need to be collected by using the Logtail client in the form of machine groups. Refer to details

Link copied to clipboard
data class MachineGroupArgs(val identifyLists: Output<List<String>>? = null, val identifyType: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val topic: Output<String>? = null) : ConvertibleToJava<MachineGroupArgs>

Log Service manages all the ECS instances whose logs need to be collected by using the Logtail client in the form of machine groups. Refer to details

Link copied to clipboard
Link copied to clipboard
object MachineGroupMapper : ResourceMapper<MachineGroup>
Link copied to clipboard
Link copied to clipboard
class OssExport : KotlinCustomResource

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

Link copied to clipboard
data class OssExportArgs(val bucket: Output<String>? = null, val bufferInterval: Output<Int>? = null, val bufferSize: Output<Int>? = null, val compressType: Output<String>? = null, val configColumns: Output<List<OssExportConfigColumnArgs>>? = null, val contentType: Output<String>? = null, val csvConfigColumns: Output<List<String>>? = null, val csvConfigDelimiter: Output<String>? = null, val csvConfigEscape: Output<String>? = null, val csvConfigHeader: Output<Boolean>? = null, val csvConfigLinefeed: Output<String>? = null, val csvConfigNull: Output<String>? = null, val csvConfigQuote: Output<String>? = null, val displayName: Output<String>? = null, val exportName: Output<String>? = null, val fromTime: Output<Int>? = null, val jsonEnableTag: Output<Boolean>? = null, val logReadRoleArn: Output<String>? = null, val logstoreName: Output<String>? = null, val pathFormat: Output<String>? = null, val prefix: Output<String>? = null, val projectName: Output<String>? = null, val roleArn: Output<String>? = null, val suffix: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<OssExportArgs>

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

Link copied to clipboard
Link copied to clipboard
object OssExportMapper : ResourceMapper<OssExport>
Link copied to clipboard
Link copied to clipboard
class OssShipper : KotlinCustomResource

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

Link copied to clipboard
data class OssShipperArgs(val bufferInterval: Output<Int>? = null, val bufferSize: Output<Int>? = null, val compressType: Output<String>? = null, val csvConfigColumns: Output<List<String>>? = null, val csvConfigDelimiter: Output<String>? = null, val csvConfigHeader: Output<Boolean>? = null, val csvConfigLinefeed: Output<String>? = null, val csvConfigNullidentifier: Output<String>? = null, val csvConfigQuote: Output<String>? = null, val format: Output<String>? = null, val jsonEnableTag: Output<Boolean>? = null, val logstoreName: Output<String>? = null, val ossBucket: Output<String>? = null, val ossPrefix: Output<String>? = null, val parquetConfigs: Output<List<OssShipperParquetConfigArgs>>? = null, val pathFormat: Output<String>? = null, val projectName: Output<String>? = null, val roleArn: Output<String>? = null, val shipperName: Output<String>? = null) : ConvertibleToJava<OssShipperArgs>

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

Link copied to clipboard
Link copied to clipboard
object OssShipperMapper : ResourceMapper<OssShipper>
Link copied to clipboard
Link copied to clipboard
class Project : KotlinCustomResource

Provides a SLS Project resource. For information about SLS Project and how to use it, see What is Project.

Link copied to clipboard
data class ProjectArgs(val description: Output<String>? = null, val name: Output<String>? = null, val policy: Output<String>? = null, val projectName: Output<String>? = null, val resourceGroupId: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ProjectArgs>

Provides a SLS Project resource. For information about SLS Project and how to use it, see What is Project.

Link copied to clipboard
Link copied to clipboard
object ProjectMapper : ResourceMapper<Project>
Link copied to clipboard
Link copied to clipboard
class Resource : KotlinCustomResource

Log resource is a meta store service provided by log service, resource can be used to define meta store's table structure. For information about SLS Resource and how to use it, see Resource management

Link copied to clipboard
data class ResourceArgs(val description: Output<String>? = null, val extInfo: Output<String>? = null, val name: Output<String>? = null, val schema: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<ResourceArgs>

Log resource is a meta store service provided by log service, resource can be used to define meta store's table structure. For information about SLS Resource and how to use it, see Resource management

Link copied to clipboard
Link copied to clipboard
object ResourceMapper : ResourceMapper<Resource>
Link copied to clipboard
class ResourceRecord : KotlinCustomResource

Log resource is a meta store service provided by log service, resource can be used to define meta store's table structure, record can be used for table's row data. For information about SLS Resource and how to use it, see Resource management

Link copied to clipboard
data class ResourceRecordArgs(val recordId: Output<String>? = null, val resourceName: Output<String>? = null, val tag: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<ResourceRecordArgs>

Log resource is a meta store service provided by log service, resource can be used to define meta store's table structure, record can be used for table's row data. For information about SLS Resource and how to use it, see Resource management

Link copied to clipboard
Link copied to clipboard
object ResourceRecordMapper : ResourceMapper<ResourceRecord>
Link copied to clipboard
Link copied to clipboard
class Store : KotlinCustomResource

Provides a SLS Log Store resource. For information about SLS Log Store and how to use it, see What is Log Store.

Link copied to clipboard
data class StoreArgs(val appendMeta: Output<Boolean>? = null, val autoSplit: Output<Boolean>? = null, val enableWebTracking: Output<Boolean>? = null, val encryptConf: Output<StoreEncryptConfArgs>? = null, val hotTtl: Output<Int>? = null, val infrequentAccessTtl: Output<Int>? = null, val logstoreName: Output<String>? = null, val maxSplitShardCount: Output<Int>? = null, val meteringMode: Output<String>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val projectName: Output<String>? = null, val retentionPeriod: Output<Int>? = null, val shardCount: Output<Int>? = null, val telemetryType: Output<String>? = null) : ConvertibleToJava<StoreArgs>

Provides a SLS Log Store resource. For information about SLS Log Store and how to use it, see What is Log Store.

Link copied to clipboard

Builder for StoreArgs.

Link copied to clipboard
class StoreIndex : KotlinCustomResource

Log Service provides the LogSearch/Analytics function to query and analyze large amounts of logs in real time. You can use this function by enabling the index and field statistics. Refer to details

Link copied to clipboard
data class StoreIndexArgs(val fieldSearches: Output<List<StoreIndexFieldSearchArgs>>? = null, val fullText: Output<StoreIndexFullTextArgs>? = null, val logstore: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<StoreIndexArgs>

Log Service provides the LogSearch/Analytics function to query and analyze large amounts of logs in real time. You can use this function by enabling the index and field statistics. Refer to details

Link copied to clipboard
Link copied to clipboard
object StoreIndexMapper : ResourceMapper<StoreIndex>
Link copied to clipboard
Link copied to clipboard
object StoreMapper : ResourceMapper<Store>
Link copied to clipboard

Builder for Store.

Functions

Link copied to clipboard
fun alert(name: String): Alert
suspend fun alert(name: String, block: suspend AlertResourceBuilder.() -> Unit): Alert
Link copied to clipboard
Link copied to clipboard
fun audit(name: String): Audit
suspend fun audit(name: String, block: suspend AuditResourceBuilder.() -> Unit): Audit
Link copied to clipboard
suspend fun dashboard(name: String, block: suspend DashboardResourceBuilder.() -> Unit): Dashboard
Link copied to clipboard
fun etl(name: String): Etl
suspend fun etl(name: String, block: suspend EtlResourceBuilder.() -> Unit): Etl
Link copied to clipboard
suspend fun ingestion(name: String, block: suspend IngestionResourceBuilder.() -> Unit): Ingestion
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun ossExport(name: String, block: suspend OssExportResourceBuilder.() -> Unit): OssExport
Link copied to clipboard
suspend fun ossShipper(name: String, block: suspend OssShipperResourceBuilder.() -> Unit): OssShipper
Link copied to clipboard
fun project(name: String): Project
suspend fun project(name: String, block: suspend ProjectResourceBuilder.() -> Unit): Project
Link copied to clipboard
suspend fun resource(name: String, block: suspend ResourceResourceBuilder.() -> Unit): Resource
Link copied to clipboard
Link copied to clipboard
fun store(name: String): Store
suspend fun store(name: String, block: suspend StoreResourceBuilder.() -> Unit): Store
Link copied to clipboard
suspend fun storeIndex(name: String, block: suspend StoreIndexResourceBuilder.() -> Unit): StoreIndex