BucketDeployment

BucketDeployment populates an OSS bucket with the contents of .zip files from other OSS buckets or from local disk.

Initializers

import com.aliyun.ros.cdk.ossdeployment.BucketDeployment;
BucketDeployment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .destinationBucket(java.lang.String)
    .destinationBucket(IResolvable)
    .destinationBucket(Bucket)
    .sources(java.util.List<ISource>)
//  .logMonitoring(java.lang.Boolean)
//  .retainOnCreate(java.lang.Boolean)
//  .roleArn(java.lang.String)
//  .roleArn(IResolvable)
//  .timeout(java.lang.Number)
    .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.
destinationBucket	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable OR com.aliyun.ros.cdk.oss.Bucket	The OSS bucket to sync the contents of the zip file to.
sources	java.util.List<ISource>	The sources from which to deploy the contents of this bucket.
logMonitoring	java.lang.Boolean	Whether log monitoring is enabled.
retainOnCreate	java.lang.Boolean	If this is set to false, the bucket temporarily storing the asset or data will be deleted after the asset or data is deployed to the destination bucket.
roleArn	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	The ARN of the execution role associated with this function.
timeout	java.lang.Number	The timeout period in seconds for the function to run.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

destinationBucket^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable OR com.aliyun.ros.cdk.oss.Bucket

The OSS bucket to sync the contents of the zip file to.

---

sources^Required

• Type: java.util.List<ISource>

The sources from which to deploy the contents of this bucket.

---

logMonitoring^Optional

• Type: java.lang.Boolean
• Default: false

Whether log monitoring is enabled.

Enabling log monitoring allows you to record the details of your deployment, which makes it easier to troubleshoot when something goes wrong.

Enabling logging monitoring incurs an additional logging service fee.

---

retainOnCreate^Optional

• Type: java.lang.Boolean
• Default: false

If this is set to false, the bucket temporarily storing the asset or data will be deleted after the asset or data is deployed to the destination bucket.

Otherwise, the temporary bucket will be deleted when the stack is destroyed.

---

roleArn^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
• Default: A role is automatically created

The ARN of the execution role associated with this function.

---

timeout^Optional

• Type: java.lang.Number
• Default: 60

The timeout period in seconds for the function to run.

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.ossdeployment.BucketDeployment;
BucketDeployment.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
cr	com.aliyun.ros.cdk.ros.RosCustomResource	Attribute cr: Custom resource to trigger the bucket deployment.
fcFunction	com.aliyun.ros.cdk.fc.Function	Attribute fcFunction: FC function to use to forward content to the destination bucket.
fcService	com.aliyun.ros.cdk.fc.Service	Attribute fcService: FC service to use to forward content to the destination bucket.
handlerRoleArn	java.lang.String 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.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

cr^Required

public RosCustomResource getCr();

• Type: com.aliyun.ros.cdk.ros.RosCustomResource

Attribute cr: Custom resource to trigger the bucket deployment.

---

fcFunction^Required

public Function getFcFunction();

• Type: com.aliyun.ros.cdk.fc.Function

Attribute fcFunction: FC function to use to forward content to the destination bucket.

---

fcService^Required

public Service getFcService();

• Type: com.aliyun.ros.cdk.fc.Service

Attribute fcService: FC service to use to forward content to the destination bucket.

---

handlerRoleArn^Required

public java.lang.Object getHandlerRoleArn();

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

---

Structs