com.aliyun.ros.cdk.sls.LogtailConfig Maven / Gradle / Ivy
Show all versions of ros-cdk-sls Show documentation
package com.aliyun.ros.cdk.sls;
/**
* This class encapsulates and extends the ROS resource type ALIYUN::SLS::LogtailConfig, which is used to configure Logtail properties for data collection.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-09-29T07:52:42.711Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.sls.$Module.class, fqn = "@alicloud/ros-cdk-sls.LogtailConfig")
public class LogtailConfig extends com.aliyun.ros.cdk.core.Resource {
protected LogtailConfig(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected LogtailConfig(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
* @param enableResourcePropertyConstraint
*/
public LogtailConfig(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.LogtailConfigProps props, final @org.jetbrains.annotations.Nullable java.lang.Boolean enableResourcePropertyConstraint) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required"), enableResourcePropertyConstraint });
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
public LogtailConfig(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.LogtailConfigProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Attribute AppliedMachineGroups: Applied machine groups.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrAppliedMachineGroups() {
return software.amazon.jsii.Kernel.get(this, "attrAppliedMachineGroups", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute Endpoint: Endpoint address.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrEndpoint() {
return software.amazon.jsii.Kernel.get(this, "attrEndpoint", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute LogtailConfigName: Logtail config name.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrLogtailConfigName() {
return software.amazon.jsii.Kernel.get(this, "attrLogtailConfigName", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
protected @org.jetbrains.annotations.NotNull java.lang.Boolean getEnableResourcePropertyConstraint() {
return software.amazon.jsii.Kernel.get(this, "enableResourcePropertyConstraint", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
protected void setEnableResourcePropertyConstraint(final @org.jetbrains.annotations.NotNull java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableResourcePropertyConstraint", java.util.Objects.requireNonNull(value, "enableResourcePropertyConstraint is required"));
}
protected @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
protected void setId(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "id", java.util.Objects.requireNonNull(value, "id is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.LogtailConfigProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.sls.LogtailConfigProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.sls.LogtailConfigProps value) {
software.amazon.jsii.Kernel.set(this, "props", java.util.Objects.requireNonNull(value, "props is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.Construct.class));
}
protected void setScope(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct value) {
software.amazon.jsii.Kernel.set(this, "scope", java.util.Objects.requireNonNull(value, "scope is required"));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.sls.LogtailConfig}.
*/
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
* @param enableResourcePropertyConstraint
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
return new Builder(scope, id, enableResourcePropertyConstraint);
}
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id, null);
}
private final com.aliyun.ros.cdk.core.Construct scope;
private final java.lang.String id;
private final java.lang.Boolean enableResourcePropertyConstraint;
private final com.aliyun.ros.cdk.sls.LogtailConfigProps.Builder props;
private Builder(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
this.scope = scope;
this.id = id;
this.enableResourcePropertyConstraint = enableResourcePropertyConstraint;
this.props = new com.aliyun.ros.cdk.sls.LogtailConfigProps.Builder();
}
/**
* Property logstoreName: Logstore name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logstoreName Property logstoreName: Logstore name: 1. This parameter is required.
*/
public Builder logstoreName(final java.lang.String logstoreName) {
this.props.logstoreName(logstoreName);
return this;
}
/**
* Property logstoreName: Logstore name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logstoreName Property logstoreName: Logstore name: 1. This parameter is required.
*/
public Builder logstoreName(final com.aliyun.ros.cdk.core.IResolvable logstoreName) {
this.props.logstoreName(logstoreName);
return this;
}
/**
* Property logtailConfigName: Logtail config name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logtailConfigName Property logtailConfigName: Logtail config name: 1. This parameter is required.
*/
public Builder logtailConfigName(final java.lang.String logtailConfigName) {
this.props.logtailConfigName(logtailConfigName);
return this;
}
/**
* Property logtailConfigName: Logtail config name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param logtailConfigName Property logtailConfigName: Logtail config name: 1. This parameter is required.
*/
public Builder logtailConfigName(final com.aliyun.ros.cdk.core.IResolvable logtailConfigName) {
this.props.logtailConfigName(logtailConfigName);
return this;
}
/**
* Property projectName: Project name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param projectName Property projectName: Project name: 1. This parameter is required.
*/
public Builder projectName(final java.lang.String projectName) {
this.props.projectName(projectName);
return this;
}
/**
* Property projectName: Project name: 1.
*
* Only supports lowercase letters, numbers, hyphens (-) and underscores (_).
* 2. Must start and end with lowercase letters and numbers.
* 3. The name length is 3-63 characters.
*
* @return {@code this}
* @param projectName Property projectName: Project name: 1. This parameter is required.
*/
public Builder projectName(final com.aliyun.ros.cdk.core.IResolvable projectName) {
this.props.projectName(projectName);
return this;
}
/**
* Property cloneFrom: Clone logtail config data from existing logtail config.
*
* Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first.
*
* @return {@code this}
* @param cloneFrom Property cloneFrom: Clone logtail config data from existing logtail config. This parameter is required.
*/
public Builder cloneFrom(final com.aliyun.ros.cdk.core.IResolvable cloneFrom) {
this.props.cloneFrom(cloneFrom);
return this;
}
/**
* Property cloneFrom: Clone logtail config data from existing logtail config.
*
* Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first.
*
* @return {@code this}
* @param cloneFrom Property cloneFrom: Clone logtail config data from existing logtail config. This parameter is required.
*/
public Builder cloneFrom(final com.aliyun.ros.cdk.sls.RosLogtailConfig.CloneFromProperty cloneFrom) {
this.props.cloneFrom(cloneFrom);
return this;
}
/**
* Property rawConfigData: The format is the same as the response of SLS API GetConfig.
*
* Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first.
* configName, outputType, outputDetail in data will be ignored.For example:
* {
* "configName": "test-logtail-config",
* "createTime": 1574843554,
* "inputDetail": {
* "acceptNoEnoughKeys": false,
* "adjustTimezone": false,
* "advanced": {
* "force_multiconfig": false
* },
* "autoExtend": true,
* "delayAlarmBytes": 0,
* "delaySkipBytes": 0,
* "discardNonUtf8": false,
* "discardUnmatch": false,
* "dockerExcludeEnv": {},
* "dockerExcludeLabel": {},
* "dockerFile": false,
* "dockerIncludeEnv": {},
* "dockerIncludeLabel": {},
* "enableRawLog": false,
* "enableTag": false,
* "fileEncoding": "utf8",
* "filePattern": "test.log*",
* "filterKey": [],
* "filterRegex": [],
* "key": [
* "time",
* "logger",
* "level",
* "request_id",
* "user_id",
* "region_id",
* "content"
* ],
* "localStorage": true,
* "logPath": "/var/log/test",
* "logTimezone": "",
* "logType": "delimiter_log",
* "maxDepth": 100,
* "maxSendRate": -1,
* "mergeType": "topic",
* "preserve": true,
* "preserveDepth": 1,
* "priority": 0,
* "quote": "\u0001",
* "sendRateExpire": 0,
* "sensitive_keys": [],
* "separator": ",,,",
* "shardHashKey": [],
* "tailExisted": false,
* "timeFormat": "",
* "timeKey": "",
* "topicFormat": "none"
* },
* "inputType": "file",
* "lastModifyTime": 1574843554,
* "logSample": "2019-11-27 10:48:23,160,,,MAIN,,,INFO,,,98DCC51D-BE5D-49C7-B3FD-37B2BAEFB296,,,123456789,,,cn-hangzhou,,,this is a simple test.",
* "outputDetail": {
* "endpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
* "logstoreName": "test-logstore",
* "region": "cn-hangzhou"
* },
* "outputType": "LogService"
* }
*
* @return {@code this}
* @param rawConfigData Property rawConfigData: The format is the same as the response of SLS API GetConfig. This parameter is required.
*/
public Builder rawConfigData(final com.aliyun.ros.cdk.core.IResolvable rawConfigData) {
this.props.rawConfigData(rawConfigData);
return this;
}
/**
* Property rawConfigData: The format is the same as the response of SLS API GetConfig.
*
* Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first.
* configName, outputType, outputDetail in data will be ignored.For example:
* {
* "configName": "test-logtail-config",
* "createTime": 1574843554,
* "inputDetail": {
* "acceptNoEnoughKeys": false,
* "adjustTimezone": false,
* "advanced": {
* "force_multiconfig": false
* },
* "autoExtend": true,
* "delayAlarmBytes": 0,
* "delaySkipBytes": 0,
* "discardNonUtf8": false,
* "discardUnmatch": false,
* "dockerExcludeEnv": {},
* "dockerExcludeLabel": {},
* "dockerFile": false,
* "dockerIncludeEnv": {},
* "dockerIncludeLabel": {},
* "enableRawLog": false,
* "enableTag": false,
* "fileEncoding": "utf8",
* "filePattern": "test.log*",
* "filterKey": [],
* "filterRegex": [],
* "key": [
* "time",
* "logger",
* "level",
* "request_id",
* "user_id",
* "region_id",
* "content"
* ],
* "localStorage": true,
* "logPath": "/var/log/test",
* "logTimezone": "",
* "logType": "delimiter_log",
* "maxDepth": 100,
* "maxSendRate": -1,
* "mergeType": "topic",
* "preserve": true,
* "preserveDepth": 1,
* "priority": 0,
* "quote": "\u0001",
* "sendRateExpire": 0,
* "sensitive_keys": [],
* "separator": ",,,",
* "shardHashKey": [],
* "tailExisted": false,
* "timeFormat": "",
* "timeKey": "",
* "topicFormat": "none"
* },
* "inputType": "file",
* "lastModifyTime": 1574843554,
* "logSample": "2019-11-27 10:48:23,160,,,MAIN,,,INFO,,,98DCC51D-BE5D-49C7-B3FD-37B2BAEFB296,,,123456789,,,cn-hangzhou,,,this is a simple test.",
* "outputDetail": {
* "endpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
* "logstoreName": "test-logstore",
* "region": "cn-hangzhou"
* },
* "outputType": "LogService"
* }
*
* @return {@code this}
* @param rawConfigData Property rawConfigData: The format is the same as the response of SLS API GetConfig. This parameter is required.
*/
public Builder rawConfigData(final java.util.Map rawConfigData) {
this.props.rawConfigData(rawConfigData);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.sls.LogtailConfig}.
*/
@Override
public com.aliyun.ros.cdk.sls.LogtailConfig build() {
return new com.aliyun.ros.cdk.sls.LogtailConfig(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}