Snapshot
- Implements: com.aliyun.ros.cdk.ecs.datasource.ISnapshot
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Snapshot.
Initializers
import com.aliyun.ros.cdk.ecs.datasource.Snapshot;
Snapshot.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.snapshotId(java.lang.String)
.snapshotId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
snapshotId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property snapshotId: The snapshot id. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
snapshotIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property snapshotId: The snapshot id.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.ecs.datasource.Snapshot;
Snapshot.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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The create time. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description. |
attrDiskId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DiskId: The source disk id. |
attrEncrypted | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Encrypted: Whether the snapshot is encrypted. |
attrInstantAccess | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstantAccess: Whether snapshot speed availability is enabled. |
attrInstantAccessRetentionDays | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstantAccessRetentionDays: InstantAccessRetentionDays. |
attrProductCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ProductCode: The product number inherited from the mirror market. |
attrProgress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Progress: Snapshot creation progress, in percentage. |
attrRemainTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RemainTime: Remaining completion time for the snapshot being created. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The resource group id. |
attrRetentionDays | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RetentionDays: Automatic snapshot retention days. |
attrSnapshotId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SnapshotId: The snapshot id. |
attrSnapshotName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SnapshotName: Snapshot Display Name. |
attrSnapshotSn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SnapshotSN: Snapshot serial number. |
attrSnapshotType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SnapshotType: Snapshot creation type. |
attrSourceDiskSize | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceDiskSize: Source disk capacity. |
attrSourceDiskType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceDiskType: Source disk attributes. |
attrSourceStorageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceStorageType: Original disk type. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags. |
attrUsage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Usage: A resource type that has a reference relationship. |
props | SnapshotProps | 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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The create time.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description.
attrDiskIdRequired
public java.lang.Object getAttrDiskId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DiskId: The source disk id.
attrEncryptedRequired
public java.lang.Object getAttrEncrypted();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Encrypted: Whether the snapshot is encrypted.
attrInstantAccessRequired
public java.lang.Object getAttrInstantAccess();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstantAccess: Whether snapshot speed availability is enabled.
attrInstantAccessRetentionDaysRequired
public java.lang.Object getAttrInstantAccessRetentionDays();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.
attrProductCodeRequired
public java.lang.Object getAttrProductCode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ProductCode: The product number inherited from the mirror market.
attrProgressRequired
public java.lang.Object getAttrProgress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Progress: Snapshot creation progress, in percentage.
attrRemainTimeRequired
public java.lang.Object getAttrRemainTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RemainTime: Remaining completion time for the snapshot being created.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The resource group id.
attrRetentionDaysRequired
public java.lang.Object getAttrRetentionDays();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RetentionDays: Automatic snapshot retention days.
attrSnapshotIdRequired
public java.lang.Object getAttrSnapshotId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SnapshotId: The snapshot id.
attrSnapshotNameRequired
public java.lang.Object getAttrSnapshotName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SnapshotName: Snapshot Display Name.
attrSnapshotSnRequired
public java.lang.Object getAttrSnapshotSn();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SnapshotSN: Snapshot serial number.
attrSnapshotTypeRequired
public java.lang.Object getAttrSnapshotType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SnapshotType: Snapshot creation type.
attrSourceDiskSizeRequired
public java.lang.Object getAttrSourceDiskSize();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceDiskSize: Source disk capacity.
attrSourceDiskTypeRequired
public java.lang.Object getAttrSourceDiskType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceDiskType: Source disk attributes.
attrSourceStorageTypeRequired
public java.lang.Object getAttrSourceStorageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceStorageType: Original disk type.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags.
attrUsageRequired
public java.lang.Object getAttrUsage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Usage: A resource type that has a reference relationship.
propsRequired
public SnapshotProps getProps();
- Type: SnapshotProps