ALIYUN::ESA::SiteDeliveryTask - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::ESA::SiteDeliveryTask",
  "Properties": {
    "BusinessType": String,
    "DataCenter": String,
    "DeliveryType": String,
    "FieldName": String,
    "SiteId": Integer,
    "TaskName": String,
    "DiscardRate": Integer,
    "HttpDelivery": Map,
    "KafkaDelivery": Map,
    "OssDelivery": Map,
    "SlsDelivery": Map,
    "S3Delivery": Map
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
BusinessType	String	Sim	Sim	Tipo de negócio.	Valores válidos: dcdn_log_access_l1 (padrão): log de acesso. dcdn_log_er: log do Edge Routine. dcdn_log_waf: logs de mitigação. dcdn_log_ipa: log de aceleração de camada 4.
DataCenter	String	Sim	Não	Data center.	Valores válidos: cn: China continental. oversea: fora da China continental.
DeliveryType	String	Sim	Não	Tipo de entrega.	Valores válidos: sls: Simple Log Service. http: serviço HTTP. aws3: serviço Amazon S3. oss: Object Storage Service. kafka: serviço Kafka. aws3cmpt: serviço compatível com Amazon S3.
FieldName	String	Sim	Sim	Campos de log selecionados.	Separe vários campos por vírgulas (,).
SiteId	Integer	Sim	Não	ID do site.	Nenhuma
TaskName	String	Sim	Não	Nome da tarefa.	Nenhuma
DiscardRate	Integer	Não	Sim	Taxa de descarte. Caso você não especifique este parâmetro, o valor padrão 0 será utilizado.	Nenhuma
HttpDelivery	Map	Não	Não	Parâmetros de configuração para entrega via HTTP.	Para mais informações, consulte Propriedades de HttpDelivery.
KafkaDelivery	Map	Não	Não	Parâmetros de configuração para entrega via Kafka.	Para mais informações, consulte Propriedades de KafkaDelivery.
OssDelivery	Map	Não	Não	Configuração para entrega via OSS.	Para mais informações, consulte Propriedades de OssDelivery.
SlsDelivery	Map	Não	Não	Configuração para entrega via SLS.	Para mais informações, consulte Propriedades de SlsDelivery.
S3Delivery	Map	Não	Não	Parâmetros de configuração para entrega via S3 ou compatível com S3.	Para mais informações, consulte Propriedades de S3Delivery.

Sintaxe de SlsDelivery

"SlsDelivery": {
  "SLSProject": String,
  "SLSRegion": String,
  "SLSLogStore": String
}

Propriedades de SlsDelivery

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
SLSProject	String	Não	Não	Nome do projeto de log em tempo real do SLS.	Nenhuma
SLSRegion	String	Não	Não	Região do projeto do Simple Log Service.	Nenhuma
SLSLogStore	String	Não	Não	Nome do Logstore.	Nenhuma

Sintaxe de HttpDelivery

"HttpDelivery": {
  "Compress": String,
  "LogBodySuffix": String,
  "HeaderParam": Map,
  "StandardAuthParam": Map,
  "StandardAuthOn": Boolean,
  "LogBodyPrefix": String,
  "QueryParam": Map,
  "DestUrl": String,
  "MaxBatchSize": Integer,
  "TransformTimeout": Integer,
  "MaxRetry": Integer,
  "MaxBatchMB": Integer
}

Propriedades de HttpDelivery

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
DestUrl	String	Sim	Não	Endereço de entrega do servidor HTTP.	Nenhuma
Compress	String	Não	Não	Método de compressão.	Valores válidos: gzip zlib no snappy
HeaderParam	Map	Não	Não	Cabeçalho personalizado.	Para mais informações, consulte Propriedades de HeaderParam.
LogBodySuffix	String	Não	Não	Sufixo do pacote de entrega de logs.	Nenhuma
LogBodyPrefix	String	Não	Não	Prefixo do pacote de entrega de logs.	Nenhuma
MaxBatchSize	Integer	Não	Não	Número máximo de entradas por entrega.	Nenhuma
MaxRetry	Integer	Não	Não	Número máximo de tentativas.	Nenhuma
MaxBatchMB	Integer	Não	Não	Tamanho máximo de uma única entrega.	Unidade: MB.
QueryParam	Map	Não	Não	Parâmetros de solicitação personalizados.	Para mais informações, consulte Propriedades de QueryParam.
StandardAuthParam	Map	Não	Não	Parâmetros de autenticação padrão.	Para mais informações, consulte Propriedades de StandardAuthParam.
StandardAuthOn	Boolean	Não	Não	Define se a autenticação padrão deve ser usada.	Nenhuma
TransformTimeout	Integer	Não	Não	Período de tempo limite.	Unidade: segundos.

Sintaxe de HeaderParam

"HeaderParam": {
  "StaticValue": String
}

Propriedades de HeaderParam

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
StaticValue	String	Não	Não	Valor do parâmetro de solicitação personalizado.	Nenhuma

Sintaxe de StandardAuthParam

"StandardAuthParam": {
  "PrivateKey": String,
  "UrlPath": String,
  "ExpiredTime": Integer
}

Propriedades de StandardAuthParam

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
ExpiredTime	Integer	Não	Não	Período de tempo limite de criptografia.	Nota O valor deve ser maior que 0. Recomenda-se um valor igual ou superior a 300.
PrivateKey	String	Não	Não	Chave privada.	Nenhuma
UrlPath	String	Não	Não	Caminho URI para autenticação padrão.	Nenhuma

Sintaxe de QueryParam

"QueryParam": {
  "StaticValue": String
}

Propriedades de QueryParam

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
StaticValue	String	Não	Não	Valor do parâmetro de solicitação personalizado.	Nenhuma

Sintaxe de S3Delivery

"S3Delivery": {
  "SecretKey": String,
  "Endpoint": String,
  "VertifyType": String,
  "Region": String,
  "ServerSideEncryption": Boolean,
  "BucketPath": String,
  "PrefixPath": String,
  "AccessKey": String,
  "S3Cmpt": Boolean
}

Propriedades de S3Delivery

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
AccessKey	String	Não	Não	AccessKey ID da conta Alibaba Cloud ou usuário RAM.	Nenhuma
BucketPath	String	Não	Não	Caminho do bucket.	Nenhuma
Endpoint	String	Não	Não	Endpoint do servidor.	Nenhuma
PrefixPath	String	Não	Não	Prefixo do caminho de armazenamento.	Nenhuma
Region	String	Não	Não	Região onde o serviço está localizado.	Nenhuma
SecretKey	String	Não	Não	AccessKey secreta usada pela conta S3.	Nenhuma
ServerSideEncryption	Boolean	Não	Não	Criptografia no lado do servidor.	Nenhuma
S3Cmpt	Boolean	Não	Não	Define se o serviço é compatível com S3.	Nenhuma
VertifyType	String	Não	Não	Tipo de autenticação.	Nenhuma

Sintaxe de KafkaDelivery

"KafkaDelivery": {
  "Compress": String,
  "UserName": String,
  "MachanismType": String,
  "Brokers": List,
  "Balancer": String,
  "Topic": String,
  "UserAuth": Boolean,
  "Password": String
}

Propriedades de KafkaDelivery

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Brokers	List	Não	Não	Array de servidores.	Nenhuma
Balancer	String	Não	Não	Método de balanceamento de carga.	Nenhuma
Compress	String	Não	Não	Método de compressão.	Nenhuma
MachanismType	String	Não	Não	Método de criptografia.	Nenhuma
Password	String	Não	Não	Senha de criptografia.	Nenhuma
Topic	String	Não	Não	Tópico da mensagem Kafka.	Nenhuma
UserName	String	Não	Não	Nome de usuário.	Nenhuma
UserAuth	Boolean	Não	Não	Define se a autenticação de usuário deve ser ativada.	Nenhuma

Sintaxe de OssDelivery

"OssDelivery": {
  "BucketName": String,
  "Region": String,
  "PrefixPath": String,
  "Aliuid": String
}

Propriedades de OssDelivery

Propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Aliuid	String	Não	Não	ID da conta Alibaba Cloud.	Nenhuma
BucketName	String	Não	Não	Nome do bucket.	Nenhuma
PrefixPath	String	Não	Não	Prefixo do caminho de armazenamento.	Nenhuma
Region	String	Não	Não	Região onde o serviço está localizado.	Nenhuma

Valores de retorno

Fn::GetAtt

SiteId: ID do site.
DataCenter: Data center.
DiscardRate: Taxa de descarte. O valor padrão é 0.
SiteName: Nome do site.
SinkConfig: Configuração de entrega.
TaskName: Nome da tarefa.
BusinessType: Tipo de log em tempo real.
FilterRules: Regras de filtro.
FieldName: Campos de log selecionados.
DeliveryType: Tipo de entrega.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SiteId:
    Type: Number
    Description: The site ID.
    Required: true
  DataCenter:
    Type: String
    Description: |-
      The data center. Valid values:
      - `cn`: the Chinese mainland.
      - `oversea`: outside the Chinese mainland.
    AllowedValues:
      - cn
      - oversea
    Required: true
  TaskName:
    Type: String
    Description: The name of the delivery task.
    Required: true
  BusinessType:
    Type: String
    Description: |-
      The real-time log type. Valid values:
      - `dcdn_log_access_l1` (default): access log.
      - `dcdn_log_er`: Edge Routine log.
      - `dcdn_log_waf`: Mitigation Logs.
      - `dcdn_log_ipa`: Layer 4 acceleration log.
    AllowedValues:
      - dcdn_log_access_l1
      - dcdn_log_er
      - dcdn_log_waf
      - dcdn_log_ipa
    Required: true
  FieldName:
    Type: String
    Description: The selected log fields, separated by commas.
    Required: true
  OssDelivery:
    AssociationPropertyMetadata:
      Parameters:
        BucketName:
          Type: String
          Description: The name of the OSS bucket.
          Required: false
        Region:
          Type: String
          Description: The region in which the bucket is located.
          Required: false
        PrefixPath:
          Type: String
          Description: The prefix of the path in which you want to store logs.
          Required: false
        Aliuid:
          Type: String
          Description: The account ID.
          Required: false
    Type: Json
    Description: The configuration for OSS delivery.
    Required: false
  DeliveryType:
    Type: String
    Description: |-
      The delivery type. Valid values:
      - `sls`: Simple Log Service.
      - `http`: HTTP service.
      - `aws3`: Amazon S3 service.
      - `oss`: Object Storage Service.
      - `kafka`: Kafka service.
      - `aws3cmpt`: Amazon S3-compatible service.
    AllowedValues:
      - sls
      - http
      - aws3
      - oss
      - kafka
      - aws3cmpt
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::SiteDeliveryTask
    Properties:
      SiteId:
        Ref: SiteId
      DataCenter:
        Ref: DataCenter
      TaskName:
        Ref: TaskName
      BusinessType:
        Ref: BusinessType
      FieldName:
        Ref: FieldName
      OssDelivery:
        Ref: OssDelivery
      DeliveryType:
        Ref: DeliveryType
Outputs:
  SiteId:
    Description: The site ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteId
  DataCenter:
    Description: The data center.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DataCenter
  DiscardRate:
    Description: The discard rate. If you do not specify this parameter, the default value is 0.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DiscardRate
  SiteName:
    Description: The site name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteName
  SinkConfig:
    Description: The delivery configuration.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SinkConfig
  TaskName:
    Description: The task name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TaskName
  BusinessType:
    Description: The real-time log type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - BusinessType
  FilterRules:
    Description: The filter rules.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - FilterRules
  FieldName:
    Description: The selected log fields, separated by commas.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - FieldName
  DeliveryType:
    Description: The delivery type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DeliveryType

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SiteId": {
      "Type": "Number",
      "Description": "The site ID.",
      "Required": true
    },
    "DataCenter": {
      "Type": "String",
      "Description": "The data center. Valid values:\n- `cn`: the Chinese mainland.\n- `oversea`: outside the Chinese mainland.",
      "AllowedValues": [
        "cn",
        "oversea"
      ],
      "Required": true
    },
    "TaskName": {
      "Type": "String",
      "Description": "The name of the delivery task.",
      "Required": true
    },
    "BusinessType": {
      "Type": "String",
      "Description": "The real-time log type. Valid values:\n- `dcdn_log_access_l1` (default): access log.\n- `dcdn_log_er`: Edge Routine log.\n- `dcdn_log_waf`: Mitigation Logs.\n- `dcdn_log_ipa`: Layer 4 acceleration log.",
      "AllowedValues": [
        "dcdn_log_access_l1",
        "dcdn_log_er",
        "dcdn_log_waf",
        "dcdn_log_ipa"
      ],
      "Required": true
    },
    "FieldName": {
      "Type": "String",
      "Description": "The selected log fields, separated by commas.",
      "Required": true
    },
    "OssDelivery": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "BucketName": {
            "Type": "String",
            "Description": "The name of the OSS bucket.",
            "Required": false
          },
          "Region": {
            "Type": "String",
            "Description": "The region in which the bucket is located.",
            "Required": false
          },
          "PrefixPath": {
            "Type": "String",
            "Description": "The prefix of the path in which you want to store logs.",
            "Required": false
          },
          "Aliuid": {
            "Type": "String",
            "Description": "The account ID.",
            "Required": false
          }
        }
      },
      "Type": "Json",
      "Description": "The configuration for OSS delivery.",
      "Required": false
    },
    "DeliveryType": {
      "Type": "String",
      "Description": "The delivery type. Valid values:\n- `sls`: Simple Log Service.\n- `http`: HTTP service.\n- `aws3`: Amazon S3 service.\n- `oss`: Object Storage Service.\n- `kafka`: Kafka service.\n- `aws3cmpt`: Amazon S3-compatible service.",
      "AllowedValues": [
        "sls",
        "http",
        "aws3",
        "oss",
        "kafka",
        "aws3cmpt"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::SiteDeliveryTask",
      "Properties": {
        "SiteId": {
          "Ref": "SiteId"
        },
        "DataCenter": {
          "Ref": "DataCenter"
        },
        "TaskName": {
          "Ref": "TaskName"
        },
        "BusinessType": {
          "Ref": "BusinessType"
        },
        "FieldName": {
          "Ref": "FieldName"
        },
        "OssDelivery": {
          "Ref": "OssDelivery"
        },
        "DeliveryType": {
          "Ref": "DeliveryType"
        }
      }
    }
  },
  "Outputs": {
    "SiteId": {
      "Description": "The site ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteId"
        ]
      }
    },
    "DataCenter": {
      "Description": "The data center.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DataCenter"
        ]
      }
    },
    "DiscardRate": {
      "Description": "The discard rate. If you do not specify this parameter, the default value is 0.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DiscardRate"
        ]
      }
    },
    "SiteName": {
      "Description": "The site name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteName"
        ]
      }
    },
    "SinkConfig": {
      "Description": "The delivery configuration.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SinkConfig"
        ]
      }
    },
    "TaskName": {
      "Description": "The task name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TaskName"
        ]
      }
    },
    "BusinessType": {
      "Description": "The real-time log type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BusinessType"
        ]
      }
    },
    "FilterRules": {
      "Description": "The filter rules.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "FilterRules"
        ]
      }
    },
    "FieldName": {
      "Description": "The selected log fields, separated by commas.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "FieldName"
        ]
      }
    },
    "DeliveryType": {
      "Description": "The delivery type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DeliveryType"
        ]
      }
    }
  }
}