Skip to content

TrailProps

Properties for defining a Trail.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-actiontrail-trail

Initializer

import { TrailProps } from '@alicloud/ros-cdk-actiontrail'
const trailProps: TrailProps = { ... }

Properties

Name Type Description
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the trail to be created.
eventRw string | @alicloud/ros-cdk-core.IResolvable Property eventRw: Indicates whether the event is a read or a write event.
ossBucketName string | @alicloud/ros-cdk-core.IResolvable Property ossBucketName: The OSS bucket for the trail delivery.
ossKeyPrefix string | @alicloud/ros-cdk-core.IResolvable Property ossKeyPrefix: The prefix for the filenames in the OSS bucket for the trail delivery.
roleName string | @alicloud/ros-cdk-core.IResolvable Property roleName: The name of the associated role for Operation Audit, with a default value of serviceroleforactiontrail.
slsProjectArn string | @alicloud/ros-cdk-core.IResolvable Property slsProjectArn: The ARN of the Log Service project for the trail delivery.
slsWriteRoleArn string | @alicloud/ros-cdk-core.IResolvable Property slsWriteRoleArn: The ARN of the role assumed by Operation Audit when delivering operation events to the Log Service project.

nameRequired

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the trail to be created.

Length should be between 6 and 36 characters, must start with a lowercase letter, and can include lowercase letters, numbers, hyphens (-), and underscores (_).

The trail name must be unique within the same account.


eventRwOptional

public readonly eventRw: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property eventRw: Indicates whether the event is a read or a write event.

Valid values: Read, Write, and All. Default value: Write.


ossBucketNameOptional

public readonly ossBucketName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ossBucketName: The OSS bucket for the trail delivery.

Length should be between 3 and 63 characters, must start with a lowercase letter or number, and can include lowercase letters, numbers, and hyphens (-).

At least one of OssBucketName and SlsProjectArn must be specified.


ossKeyPrefixOptional

public readonly ossKeyPrefix: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ossKeyPrefix: The prefix for the filenames in the OSS bucket for the trail delivery.

Length should be between 6 and 32 characters, must start with a letter, and can include letters, numbers, hyphens (-), forward slashes (\/), and underscores (_).


roleNameOptional

public readonly roleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property roleName: The name of the associated role for Operation Audit, with a default value of serviceroleforactiontrail.


slsProjectArnOptional

public readonly slsProjectArn: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property slsProjectArn: The ARN of the Log Service project for the trail delivery.

At least one of OssBucketName and SlsProjectArn must be specified.


slsWriteRoleArnOptional

public readonly slsWriteRoleArn: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property slsWriteRoleArn: The ARN of the role assumed by Operation Audit when delivering operation events to the Log Service project.

If this parameter is not specified, Operation Audit will create the necessary resources by creating a service-linked role. - If this parameter is specified, when you need to deliver events to the current account, you need to grant the RAM role the permissions of the Operation Audit service-linked role. When you need to deliver events to another account, you need to bind the system permission policy for event delivery to the RAM role. For more information on cross-account delivery, see Deliver Events from Multiple Accounts to One Account.


Protocols