OssExport
This class encapsulates and extends the ROS resource type ALIYUN::SLS::OssExport
, which is used to create an Object Storage Service (OSS) data shipping job to manage Simple Log Service (SLS) data and ship Logstore data to OSS for storage.
Initializers
import ros_cdk_sls
ros_cdk_sls.OssExport(
scope: Construct,
id: str,
configuration: typing.Union[IResolvable, ConfigurationProperty],
display_name: typing.Union[str, IResolvable],
export_name: typing.Union[str, IResolvable],
project_name: typing.Union[str, IResolvable],
description: 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. |
configuration |
typing.Union[ros_cdk_core.IResolvable, ConfigurationProperty] |
Property configuration: The configuration of the export job. |
display_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property displayName: The display name of the export job. |
export_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property exportName: The name of the export job. |
project_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property projectName: The project name of SLS. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of the export job. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
configuration
Required
- Type: typing.Union[ros_cdk_core.IResolvable, ConfigurationProperty]
Property configuration: The configuration of the export job.
display_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property displayName: The display name of the export job.
It must be 4 to 100 characters in length.
export_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property exportName: The name of the export job.
This value should be unique. It must be 2 to 64 characters in length and can contain lowercase letters, digits, hyphens (-), and underscores (_). It must start and end with a lowercase letter or a digit.
project_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectName: The project name of SLS.
description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the export job.
It could be 0 to 256 characters in length.
enable_resource_property_constraint
Optional
- 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. |
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
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_sls
ros_cdk_sls.OssExport.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. |
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_export_name |
ros_cdk_core.IResolvable |
Attribute ExportName: The name of the export job. |
attr_project_name |
ros_cdk_core.IResolvable |
Attribute ProjectName: The project name of SLS. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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_export_name
Required
attr_export_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ExportName: The name of the export job.
attr_project_name
Required
attr_project_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ProjectName: The project name of SLS.