Flowlog
- Implements: IFlowlog
This class encapsulates and extends the ROS resource type ALIYUN::CEN::Flowlog.
Initializers
import ros_cdk_cen
ros_cdk_cen.Flowlog(
scope: Construct,
id: str,
cen_id: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
flow_log_name: typing.Union[str, IResolvable] = None,
interval: typing.Union[typing.Union[int, float], IResolvable] = None,
log_format_string: typing.Union[str, IResolvable] = None,
log_store_name: typing.Union[str, IResolvable] = None,
project_name: typing.Union[str, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
transit_router_attachment_id: typing.Union[str, IResolvable] = None,
transit_router_id: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
cen_id | typing.Union[str, ros_cdk_core.IResolvable] | Property cenId: The ID of the CEN instance. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the flow log. |
flow_log_name | typing.Union[str, ros_cdk_core.IResolvable] | Property flowLogName: The flow log name. |
interval | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property interval: The time window for collecting log data. |
log_format_string | typing.Union[str, ros_cdk_core.IResolvable] | Property logFormatString: The strings that define the fields in the flow log. |
log_store_name | typing.Union[str, ros_cdk_core.IResolvable] | Property logStoreName: The Logstore that stores the captured traffic data. |
project_name | typing.Union[str, ros_cdk_core.IResolvable] | Property projectName: The project that stores the captured traffic data. |
tags | typing.List[TagsProperty] | Property tags: Tags of flow log. |
transit_router_attachment_id | typing.Union[str, ros_cdk_core.IResolvable] | Property transitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection. |
transit_router_id | typing.Union[str, ros_cdk_core.IResolvable] | Property transitRouterId: The ID of the transit router. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
cen_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property cenId: The ID of the CEN instance.
descriptionOptional
- Type: typing.Union[str, 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://.
flow_log_nameOptional
- Type: typing.Union[str, 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: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property interval: The time window for collecting log data.
Unit: seconds. Valid values: 60 and 600. Default value: 600.
log_format_stringOptional
- Type: typing.Union[str, 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.
log_store_nameOptional
- Type: typing.Union[str, 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.
project_nameOptional
- Type: typing.Union[str, 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: typing.List[TagsProperty]
Property tags: Tags of flow log.
transit_router_attachment_idOptional
- Type: typing.Union[str, 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.
transit_router_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property transitRouterId: The ID of the transit router.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_cen
ros_cdk_cen.Flowlog.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_cen_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CenId: The ID of the CEN instance. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The time when the flow log was created. |
attr_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Description: The description of the flow log. |
attr_flow_log_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FlowLogId: The ID of the flow log. |
attr_flow_log_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FlowLogName: The flow log name. |
attr_flow_log_version | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FlowLogVersion: The flow log version. |
attr_interval | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Interval: The time window for collecting log data. |
attr_log_format_string | typing.Union[str, ros_cdk_core.IResolvable] | Attribute LogFormatString: The strings that define the fields in the flow log. |
attr_log_store_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute LogStoreName: The Logstore that stores the captured traffic data. |
attr_project_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProjectName: The project that stores the captured traffic data. |
attr_tags | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Tags: The tag of the flow log. |
attr_transit_router_attachment_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TransitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection. |
attr_transit_router_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TransitRouterId: The ID of the transit router. |
props | FlowlogProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_cen_idRequired
attr_cen_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CenId: The ID of the CEN instance.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The time when the flow log was created.
attr_descriptionRequired
attr_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Description: The description of the flow log.
attr_flow_log_idRequired
attr_flow_log_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FlowLogId: The ID of the flow log.
attr_flow_log_nameRequired
attr_flow_log_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FlowLogName: The flow log name.
attr_flow_log_versionRequired
attr_flow_log_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FlowLogVersion: The flow log version.
attr_intervalRequired
attr_interval: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Interval: The time window for collecting log data.
attr_log_format_stringRequired
attr_log_format_string: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute LogFormatString: The strings that define the fields in the flow log.
attr_log_store_nameRequired
attr_log_store_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute LogStoreName: The Logstore that stores the captured traffic data.
attr_project_nameRequired
attr_project_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProjectName: The project that stores the captured traffic data.
attr_tagsRequired
attr_tags: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Tags: The tag of the flow log.
attr_transit_router_attachment_idRequired
attr_transit_router_attachment_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TransitRouterAttachmentId: The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection.
attr_transit_router_idRequired
attr_transit_router_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TransitRouterId: The ID of the transit router.
propsRequired
props: FlowlogProps
- Type: FlowlogProps