ExpressSync
- Implements: IExpressSync
This class encapsulates and extends the ROS resource type ALIYUN::CloudStorageGateway::ExpressSync.
Initializers
import com.aliyun.ros.cdk.cloudstoragegateway.ExpressSync;
ExpressSync.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.bucketName(java.lang.String)
.bucketName(IResolvable)
.bucketRegion(java.lang.String)
.bucketRegion(IResolvable)
.name(java.lang.String)
.name(IResolvable)
// .bucketPrefix(java.lang.String)
// .bucketPrefix(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. |
bucketName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property bucketName: The name of the bucket. |
bucketRegion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property bucketRegion: The region of the OSS bucket. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the express synchronization group. |
bucketPrefix | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property bucketPrefix: The prefix of the OSS bucket. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the express synchronization group. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
bucketNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property bucketName: The name of the bucket.
Note:
- You can specify only one OSS bucket for a synchronization group. All data changes in the bucket are synchronized to your on-premises environment.
- If you have not created a share for the OSS bucket, you must first create a share between the file gateway and the OSS bucket.
bucketRegionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property bucketRegion: The region of the OSS bucket.
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the express synchronization group.
The name must be 1 to 128 characters in length and can contain letters, Chinese characters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character.
bucketPrefixOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property bucketPrefix: The prefix of the OSS bucket.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the express synchronization group.
The description can be up to 255 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.cloudstoragegateway.ExpressSync;
ExpressSync.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. |
attrExpressSyncId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpressSyncId: The ID of the ExpressSync. |
props | ExpressSyncProps | 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
attrExpressSyncIdRequired
public java.lang.Object getAttrExpressSyncId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpressSyncId: The ID of the ExpressSync.
propsRequired
public ExpressSyncProps getProps();
- Type: ExpressSyncProps