RosRestoreTask
This class is a base encapsulation around the ROS resource type ALIYUN::DBS::RestoreTask
, which is used to create a restore task.
Initializers
import com.aliyun.ros.cdk.dbs.RosRestoreTask;
RosRestoreTask.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.backupPlanId(java.lang.String)
.backupPlanId(IResolvable)
.destinationEndpointInstanceType(java.lang.String)
.destinationEndpointInstanceType(IResolvable)
.restoreTaskName(java.lang.String)
.restoreTaskName(IResolvable)
// .backupGatewayId(java.lang.Number)
// .backupGatewayId(IResolvable)
// .backupSetId(java.lang.String)
// .backupSetId(IResolvable)
// .destinationEndpointDatabaseName(java.lang.String)
// .destinationEndpointDatabaseName(IResolvable)
// .destinationEndpointInstanceId(java.lang.String)
// .destinationEndpointInstanceId(IResolvable)
// .destinationEndpointIp(java.lang.String)
// .destinationEndpointIp(IResolvable)
// .destinationEndpointOracleSid(java.lang.String)
// .destinationEndpointOracleSid(IResolvable)
// .destinationEndpointPassword(java.lang.String)
// .destinationEndpointPassword(IResolvable)
// .destinationEndpointPort(java.lang.Number)
// .destinationEndpointPort(IResolvable)
// .destinationEndpointRegion(java.lang.String)
// .destinationEndpointRegion(IResolvable)
// .destinationEndpointUserName(java.lang.String)
// .destinationEndpointUserName(IResolvable)
// .duplicateConflict(java.lang.String)
// .duplicateConflict(IResolvable)
// .restoreDir(java.lang.String)
// .restoreDir(IResolvable)
// .restoreHome(java.lang.String)
// .restoreHome(IResolvable)
// .restoreObjects(java.lang.String)
// .restoreObjects(IResolvable)
// .restoreTime(java.lang.Number)
// .restoreTime(IResolvable)
// .startTask(java.lang.Boolean)
// .startTask(IResolvable)
.build();
Name | Type | Description |
---|---|---|
scope |
com.aliyun.ros.cdk.core.Construct |
- scope in which this resource is defined. |
id |
java.lang.String |
- scoped id of the resource. |
enableResourcePropertyConstraint |
java.lang.Boolean |
No description. |
backupPlanId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointInstanceType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreTaskName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
backupGatewayId |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
backupSetId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointDatabaseName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointIp |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointOracleSid |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointPassword |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointPort |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointRegion |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointUserName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
duplicateConflict |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreDir |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreHome |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreObjects |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreTime |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
startTask |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
scope in which this resource is defined.
id
Required
- Type: java.lang.String
scoped id of the resource.
enableResourcePropertyConstraint
Required
- Type: java.lang.Boolean
backupPlanId
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointInstanceType
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTaskName
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
backupGatewayId
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
backupSetId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointDatabaseName
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointInstanceId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointIp
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointOracleSid
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointPassword
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointPort
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointRegion
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointUserName
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
duplicateConflict
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreDir
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreHome
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreObjects
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTime
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
startTask
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Methods
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
addCondition |
No description. |
addCount |
No description. |
addDeletionOverride |
Syntactic sugar for addOverride(path, undefined) . |
addDependsOn |
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
addDesc |
No description. |
addMetaData |
No description. |
addOverride |
Adds an override to the synthesized ROS resource. |
addPropertyDeletionOverride |
Adds an override that deletes the value of a property from the resource definition. |
addPropertyOverride |
Adds an override to a resource property. |
addRosDependency |
No description. |
applyRemovalPolicy |
Sets the deletion policy of the resource based on the removal policy specified. |
getAtt |
Returns a token for an runtime attribute of this resource. |
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.
overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
addCondition
public void addCondition(RosCondition con)
- 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
addDeletionOverride
public void addDeletionOverride(java.lang.String path)
Syntactic sugar for addOverride(path, undefined)
.
- Type: java.lang.String
The path of the value to delete.
addDependsOn
public void addDependsOn(RosResource target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Type: com.aliyun.ros.cdk.core.RosResource
addDesc
public void addDesc(java.lang.String desc)
- Type: java.lang.String
addMetaData
public void addMetaData(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
Adds an override to the synthesized ROS resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
For example,
addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
- Type: java.lang.String
The path of the property, you can use dot notation to override values in complex types.
Any intermdediate keys will be created as needed.
- Type: java.lang.Object
The value.
Could be primitive or complex.
addPropertyDeletionOverride
public void addPropertyDeletionOverride(java.lang.String propertyPath)
Adds an override that deletes the value of a property from the resource definition.
- Type: java.lang.String
The path to the property.
addPropertyOverride
public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
- Type: java.lang.String
The path of the property.
- Type: java.lang.Object
The value.
addRosDependency
public void addRosDependency(java.lang.String target)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)
Sets the deletion policy of the resource based on the removal policy specified.
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
- Type: com.aliyun.ros.cdk.core.RemovalPolicyOptions
getAtt
public Reference getAtt(java.lang.String attributeName)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
- Type: java.lang.String
The name of the attribute.
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isRosElement |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
isRosResource |
Check whether the given construct is a RosResource. |
isConstruct
import com.aliyun.ros.cdk.dbs.RosRestoreTask;
RosRestoreTask.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
isRosElement
import com.aliyun.ros.cdk.dbs.RosRestoreTask;
RosRestoreTask.isRosElement(java.lang.Object x)
Returns true
if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of instanceof
to allow stack elements from different
versions of this library to be included in the same stack.
- Type: java.lang.Object
isRosResource
import com.aliyun.ros.cdk.dbs.RosRestoreTask;
RosRestoreTask.isRosResource(IConstruct construct)
Check whether the given construct is a RosResource.
- Type: com.aliyun.ros.cdk.core.IConstruct
Properties
Name | Type | Description |
---|---|---|
node |
com.aliyun.ros.cdk.core.ConstructNode |
The construct tree node associated with this construct. |
creationStack |
java.util.List |
No description. |
logicalId |
java.lang.String |
The logical ID for this stack element. |
stack |
com.aliyun.ros.cdk.core.Stack |
The stack in which this element is defined. |
ref |
java.lang.String |
Return a string that will be resolved to a RosTemplate { Ref } for this element. |
rosOptions |
com.aliyun.ros.cdk.core.IRosResourceOptions |
Options for this resource, such as condition, update policy etc. |
rosResourceType |
java.lang.String |
ROS resource type. |
attrRestoreTaskId |
com.aliyun.ros.cdk.core.IResolvable |
No description. |
backupPlanId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointInstanceType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
enableResourcePropertyConstraint |
java.lang.Boolean |
No description. |
restoreTaskName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
backupGatewayId |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
backupSetId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointDatabaseName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointIp |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointOracleSid |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointPassword |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointPort |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointRegion |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
destinationEndpointUserName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
duplicateConflict |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreDir |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreHome |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreObjects |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreTime |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
startTask |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
creationStack
Required
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List
logicalId
Required
public java.lang.String getLogicalId();
- Type: java.lang.String
The logical ID for this stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
Return a string that will be resolved to a RosTemplate { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
rosOptions
Required
public IRosResourceOptions getRosOptions();
- Type: com.aliyun.ros.cdk.core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
rosResourceType
Required
public java.lang.String getRosResourceType();
- Type: java.lang.String
ROS resource type.
attrRestoreTaskId
Required
public IResolvable getAttrRestoreTaskId();
- Type: com.aliyun.ros.cdk.core.IResolvable
backupPlanId
Required
public java.lang.Object getBackupPlanId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointInstanceType
Required
public java.lang.Object getDestinationEndpointInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
enableResourcePropertyConstraint
Required
public java.lang.Boolean getEnableResourcePropertyConstraint();
- Type: java.lang.Boolean
restoreTaskName
Required
public java.lang.Object getRestoreTaskName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
backupGatewayId
Optional
public java.lang.Object getBackupGatewayId();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
backupSetId
Optional
public java.lang.Object getBackupSetId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointDatabaseName
Optional
public java.lang.Object getDestinationEndpointDatabaseName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointInstanceId
Optional
public java.lang.Object getDestinationEndpointInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointIp
Optional
public java.lang.Object getDestinationEndpointIp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointOracleSid
Optional
public java.lang.Object getDestinationEndpointOracleSid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointPassword
Optional
public java.lang.Object getDestinationEndpointPassword();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointPort
Optional
public java.lang.Object getDestinationEndpointPort();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointRegion
Optional
public java.lang.Object getDestinationEndpointRegion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
destinationEndpointUserName
Optional
public java.lang.Object getDestinationEndpointUserName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
duplicateConflict
Optional
public java.lang.Object getDuplicateConflict();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreDir
Optional
public java.lang.Object getRestoreDir();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreHome
Optional
public java.lang.Object getRestoreHome();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreObjects
Optional
public java.lang.Object getRestoreObjects();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTime
Optional
public java.lang.Object getRestoreTime();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
startTask
Optional
public java.lang.Object getStartTask();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Constants
Name | Type | Description |
---|---|---|
ROS_RESOURCE_TYPE_NAME |
java.lang.String |
The resource type name for this resource class. |
ROS_RESOURCE_TYPE_NAME
Required
public java.lang.String getRosResourceTypeName();
- Type: java.lang.String
The resource type name for this resource class.