Trail

• Implements: ITrail

This class encapsulates and extends the ROS resource type ALIYUN::ACTIONTRAIL::Trail.

Initializers

import ros_cdk_actiontrail
ros_cdk_actiontrail.Trail(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  event_rw: typing.Union[str, IResolvable] = None,
  oss_bucket_name: typing.Union[str, IResolvable] = None,
  oss_key_prefix: typing.Union[str, IResolvable] = None,
  role_name: typing.Union[str, IResolvable] = None,
  sls_project_arn: typing.Union[str, IResolvable] = None,
  sls_write_role_arn: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

name^Required

• Type: typing.Union[str, 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.

event_rw^Optional

• Type: typing.Union[str, 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.

oss_bucket_name^Optional

• Type: typing.Union[str, 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.

oss_key_prefix^Optional

• Type: typing.Union[str, 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 (_).

role_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

sls_project_arn^Optional

• Type: typing.Union[str, 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.

sls_write_role_arn^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_actiontrail
ros_cdk_actiontrail.Trail.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_name^Required

attr_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Name: The name of the trail to be created, which must be unique for an account.

props^Required

props: TrailProps

• Type: TrailProps