OssExport
- Implements: IOssExport
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 com.aliyun.ros.cdk.sls.OssExport;
OssExport.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.configuration(IResolvable)
.configuration(ConfigurationProperty)
.displayName(java.lang.String)
.displayName(IResolvable)
.exportName(java.lang.String)
.exportName(IResolvable)
.projectName(java.lang.String)
.projectName(IResolvable)
// .description(java.lang.String)
// .description(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. |
configuration | com.aliyun.ros.cdk.core.IResolvable OR ConfigurationProperty | Property configuration: The configuration of the export job. |
displayName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property displayName: The display name of the export job. |
exportName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property exportName: The name of the export job. |
projectName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property projectName: The project name of SLS. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the export job. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
configurationRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR ConfigurationProperty
Property configuration: The configuration of the export job.
displayNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property displayName: The display name of the export job.
It must be 4 to 100 characters in length.
exportNameRequired
- Type: java.lang.String OR com.aliyun.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.
projectNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property projectName: The project name of SLS.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the export job.
It could be 0 to 256 characters in length.
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.sls.OssExport;
OssExport.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. |
attrExportName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExportName: The name of the export job. |
attrProjectName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ProjectName: The project name of SLS. |
props | OssExportProps | 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
attrExportNameRequired
public java.lang.Object getAttrExportName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExportName: The name of the export job.
attrProjectNameRequired
public java.lang.Object getAttrProjectName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ProjectName: The project name of SLS.
propsRequired
public OssExportProps getProps();
- Type: OssExportProps