Skip to content

Snapshot

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.
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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • 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.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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 com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The create time.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description.
attrDiskId com.aliyun.ros.cdk.core.IResolvable Attribute DiskId: The source disk id.
attrEncrypted com.aliyun.ros.cdk.core.IResolvable Attribute Encrypted: Whether the snapshot is encrypted.
attrInstantAccess com.aliyun.ros.cdk.core.IResolvable Attribute InstantAccess: Whether snapshot speed availability is enabled.
attrInstantAccessRetentionDays com.aliyun.ros.cdk.core.IResolvable Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.
attrProductCode com.aliyun.ros.cdk.core.IResolvable Attribute ProductCode: The product number inherited from the mirror market.
attrProgress com.aliyun.ros.cdk.core.IResolvable Attribute Progress: Snapshot creation progress, in percentage.
attrRemainTime com.aliyun.ros.cdk.core.IResolvable Attribute RemainTime: Remaining completion time for the snapshot being created.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The resource group id.
attrRetentionDays com.aliyun.ros.cdk.core.IResolvable Attribute RetentionDays: Automatic snapshot retention days.
attrSnapshotId com.aliyun.ros.cdk.core.IResolvable Attribute SnapshotId: The snapshot id.
attrSnapshotName com.aliyun.ros.cdk.core.IResolvable Attribute SnapshotName: Snapshot Display Name.
attrSnapshotSn com.aliyun.ros.cdk.core.IResolvable Attribute SnapshotSN: Snapshot serial number.
attrSnapshotType com.aliyun.ros.cdk.core.IResolvable Attribute SnapshotType: Snapshot creation type.
attrSourceDiskSize com.aliyun.ros.cdk.core.IResolvable Attribute SourceDiskSize: Source disk capacity.
attrSourceDiskType com.aliyun.ros.cdk.core.IResolvable Attribute SourceDiskType: Source disk attributes.
attrSourceStorageType com.aliyun.ros.cdk.core.IResolvable Attribute SourceStorageType: Original disk type.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags.
attrUsage com.aliyun.ros.cdk.core.IResolvable Attribute Usage: A resource type that has a reference relationship.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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 IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The create time.

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description.

attrDiskIdRequired 

public IResolvable getAttrDiskId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DiskId: The source disk id.

attrEncryptedRequired 

public IResolvable getAttrEncrypted();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Encrypted: Whether the snapshot is encrypted.

attrInstantAccessRequired 

public IResolvable getAttrInstantAccess();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstantAccess: Whether snapshot speed availability is enabled.

attrInstantAccessRetentionDaysRequired 

public IResolvable getAttrInstantAccessRetentionDays();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.

attrProductCodeRequired 

public IResolvable getAttrProductCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProductCode: The product number inherited from the mirror market.

attrProgressRequired 

public IResolvable getAttrProgress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Progress: Snapshot creation progress, in percentage.

attrRemainTimeRequired 

public IResolvable getAttrRemainTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RemainTime: Remaining completion time for the snapshot being created.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The resource group id.

attrRetentionDaysRequired 

public IResolvable getAttrRetentionDays();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RetentionDays: Automatic snapshot retention days.

attrSnapshotIdRequired 

public IResolvable getAttrSnapshotId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotId: The snapshot id.

attrSnapshotNameRequired 

public IResolvable getAttrSnapshotName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotName: Snapshot Display Name.

attrSnapshotSnRequired 

public IResolvable getAttrSnapshotSn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotSN: Snapshot serial number.

attrSnapshotTypeRequired 

public IResolvable getAttrSnapshotType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotType: Snapshot creation type.

attrSourceDiskSizeRequired 

public IResolvable getAttrSourceDiskSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceDiskSize: Source disk capacity.

attrSourceDiskTypeRequired 

public IResolvable getAttrSourceDiskType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceDiskType: Source disk attributes.

attrSourceStorageTypeRequired 

public IResolvable getAttrSourceStorageType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceStorageType: Original disk type.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags.

attrUsageRequired 

public IResolvable getAttrUsage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Usage: A resource type that has a reference relationship.