Flowlog
- Implements: IFlowlog
This class encapsulates and extends the ROS resource type ALIYUN::CEN::Flowlog.
Initializers
import com.aliyun.ros.cdk.cen.Flowlog;
Flowlog.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.cenId(java.lang.String)
.cenId(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .flowLogName(java.lang.String)
// .flowLogName(IResolvable)
// .interval(java.lang.Number)
// .interval(IResolvable)
// .logFormatString(java.lang.String)
// .logFormatString(IResolvable)
// .logStoreName(java.lang.String)
// .logStoreName(IResolvable)
// .projectName(java.lang.String)
// .projectName(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .transitRouterAttachmentId(java.lang.String)
// .transitRouterAttachmentId(IResolvable)
// .transitRouterId(java.lang.String)
// .transitRouterId(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. |
cenId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property cenId: The ID of the CEN instance. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the flow log. |
flowLogName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property flowLogName: The flow log name. |
interval | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property interval: The time window for collecting log data. |
logFormatString | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property logFormatString: The strings that define the fields in the flow log. |
logStoreName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property logStoreName: The Logstore that stores the captured traffic data. |
projectName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property projectName: The project that stores the captured traffic data. |
tags | java.util.List<TagsProperty> | Property tags: Tags of flow log. |
transitRouterAttachmentId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property transitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection. |
transitRouterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property transitRouterId: The ID of the transit router. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
cenIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property cenId: The ID of the CEN instance.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the flow log.
The description is optional. If you enter a description, it must be 1 to 256 characters in length, and cannot start with http:// or https://.
flowLogNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property flowLogName: The flow log name.
The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.
intervalOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property interval: The time window for collecting log data.
Unit: seconds. Valid values: 60 and 600. Default value: 600.
logFormatStringOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property logFormatString: The strings that define the fields in the flow log.
Format: ${Field 1}${Field 2}${Field 3}...{Field n} * If you do not configure this parameter, all fields are included in the flow log. * If you configure this parameter, start the string with ${srcaddr}${dstaddr}${bytes} because ${srcaddr}${dstaddr}${bytes} are required variables.
logStoreNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property logStoreName: The Logstore that stores the captured traffic data.
- If a Logstore is already created in the selected region, enter the name of the Logstore.
- If no Logstores are created in the selected region, enter a name and the system automatically creates a Logstore. The name of the Logstore. The name must meet the following requirements: ** The name must be unique in a project. ** The name can contain only lowercase letters, digits, hyphens (-), and underscores (_). ** The name must start and end with a lowercase letter or a digit. ** The name must be 3 to 63 characters in length.
projectNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property projectName: The project that stores the captured traffic data.
- If a project is already created in the selected region, enter the name of the project.
- If no projects are created in the selected region, enter a name and the system automatically creates a project. The project name must be unique in a region. You cannot change the name after the project is created. The name must meet the following requirements: ** The name must be globally unique. ** The name can contain only lowercase letters, digits, and hyphens (-). ** The name must start and end with a lowercase letter or a digit. ** The name must be 3 to 63 characters in length.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of flow log.
transitRouterAttachmentIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property transitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection.
If you create the flow log for a transfer router, skip this parameter.
transitRouterIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property transitRouterId: The ID of the transit router.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cen.Flowlog;
Flowlog.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrCenId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CenId: The ID of the CEN instance. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the flow log was created. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the flow log. |
attrFlowLogId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FlowLogId: The ID of the flow log. |
attrFlowLogName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FlowLogName: The flow log name. |
attrFlowLogVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FlowLogVersion: The flow log version. |
attrInterval | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Interval: The time window for collecting log data. |
attrLogFormatString | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LogFormatString: The strings that define the fields in the flow log. |
attrLogStoreName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LogStoreName: The Logstore that stores the captured traffic data. |
attrProjectName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ProjectName: The project that stores the captured traffic data. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tag of the flow log. |
attrTransitRouterAttachmentId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TransitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection. |
attrTransitRouterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TransitRouterId: The ID of the transit router. |
props | FlowlogProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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
attrCenIdRequired
public java.lang.Object getAttrCenId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CenId: The ID of the CEN instance.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the flow log was created.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the flow log.
attrFlowLogIdRequired
public java.lang.Object getAttrFlowLogId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FlowLogId: The ID of the flow log.
attrFlowLogNameRequired
public java.lang.Object getAttrFlowLogName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FlowLogName: The flow log name.
attrFlowLogVersionRequired
public java.lang.Object getAttrFlowLogVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FlowLogVersion: The flow log version.
attrIntervalRequired
public java.lang.Object getAttrInterval();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Interval: The time window for collecting log data.
attrLogFormatStringRequired
public java.lang.Object getAttrLogFormatString();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LogFormatString: The strings that define the fields in the flow log.
attrLogStoreNameRequired
public java.lang.Object getAttrLogStoreName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LogStoreName: The Logstore that stores the captured traffic data.
attrProjectNameRequired
public java.lang.Object getAttrProjectName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ProjectName: The project that stores the captured traffic data.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tag of the flow log.
attrTransitRouterAttachmentIdRequired
public java.lang.Object getAttrTransitRouterAttachmentId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TransitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection.
attrTransitRouterIdRequired
public java.lang.Object getAttrTransitRouterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TransitRouterId: The ID of the transit router.
propsRequired
public FlowlogProps getProps();
- Type: FlowlogProps