Trail

• Implements: ITrail

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

Initializers

import com.aliyun.ros.cdk.actiontrail.Trail;
Trail.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .name(java.lang.String)
    .name(IResolvable)
//  .eventRw(java.lang.String)
//  .eventRw(IResolvable)
//  .ossBucketName(java.lang.String)
//  .ossBucketName(IResolvable)
//  .ossKeyPrefix(java.lang.String)
//  .ossKeyPrefix(IResolvable)
//  .roleName(java.lang.String)
//  .roleName(IResolvable)
//  .slsProjectArn(java.lang.String)
//  .slsProjectArn(IResolvable)
//  .slsWriteRoleArn(java.lang.String)
//  .slsWriteRoleArn(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

name^Required

• Type: java.lang.String OR com.aliyun.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.

eventRw^Optional

• Type: java.lang.String OR com.aliyun.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.

ossBucketName^Optional

• Type: java.lang.String OR com.aliyun.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.

ossKeyPrefix^Optional

• Type: java.lang.String OR com.aliyun.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 (_).

roleName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

slsProjectArn^Optional

• Type: java.lang.String OR com.aliyun.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.

slsWriteRoleArn^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.actiontrail.Trail;
Trail.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrName^Required

public java.lang.Object getAttrName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public TrailProps getProps();

• Type: TrailProps