Skip to content

Trail

This class encapsulates and extends the ROS resource type ALIYUN::ACTIONTRAIL::Trail, which is used to create a trail to deliver events to Simple Log Service or Object Storage Service (OSS).

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the trail to be created, which must be unique for an account.
eventRw java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property eventRw: Indicates whether the event is a read or a write event.
ossBucketName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ossBucketName: The OSS bucket to which the trail delivers logs.
ossKeyPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ossKeyPrefix: The prefix of the specified OSS bucket name.
roleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property roleName: The RAM role in ActionTrail permitted by the user.
slsProjectArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property slsProjectArn: The unique ARN of the Log Service project.
slsWriteRoleArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property slsWriteRoleArn: The unique ARN of the Log Service role.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

nameRequired

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

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


eventRwOptional

  • 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.


ossBucketNameOptional

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

Property ossBucketName: The OSS bucket to which the trail delivers logs.

Ensure that this is an existing OSS bucket.


ossKeyPrefixOptional

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

Property ossKeyPrefix: The prefix of the specified OSS bucket name.

This parameter can be left empty.


roleNameOptional

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

Property roleName: The RAM role in ActionTrail permitted by the user.


slsProjectArnOptional

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

Property slsProjectArn: The unique ARN of the Log Service project.


slsWriteRoleArnOptional

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

Property slsWriteRoleArn: The unique ARN of the Log Service role.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: The name of the trail to be created, which must be unique for an account.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrNameRequired

public IResolvable getAttrName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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