BucketDeployment

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

Initializers

import ros_cdk_ossdeployment
ros_cdk_ossdeployment.BucketDeployment(
  scope: Construct,
  id: str,
  destination_bucket: typing.Union[str, IResolvable, Bucket],
  sources: typing.List[ISource],
  log_monitoring: bool = None,
  retain_on_create: bool = None,
  role_arn: typing.Union[str, IResolvable] = None,
  timeout: typing.Union[int, float] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
destination_bucket	typing.Union[str, ros_cdk_core.IResolvable, ros_cdk_oss.Bucket]	The OSS bucket to sync the contents of the zip file to.
sources	typing.List[ISource]	The sources from which to deploy the contents of this bucket.
log_monitoring	bool	Whether log monitoring is enabled.
retain_on_create	bool	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.
role_arn	typing.Union[str, ros_cdk_core.IResolvable]	The ARN of the execution role associated with this function.
timeout	typing.Union[int, float]	The timeout period in seconds for the function to run.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

destination_bucket^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable, ros_cdk_oss.Bucket]

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

---

sources^Required

• Type: typing.List[ISource]

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

---

log_monitoring^Optional

• Type: bool
• 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.

---

retain_on_create^Optional

• Type: bool
• 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.

---

role_arn^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]
• Default: A role is automatically created

The ARN of the execution role associated with this function.

---

timeout^Optional

• Type: typing.Union[int, float]
• Default: 60

The timeout period in seconds for the function to run.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_ossdeployment
ros_cdk_ossdeployment.BucketDeployment.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
cr	ros_cdk_ros.RosCustomResource	Attribute cr: Custom resource to trigger the bucket deployment.
fc_function	ros_cdk_fc.Function	Attribute fcFunction: FC function to use to forward content to the destination bucket.
fc_service	ros_cdk_fc.Service	Attribute fcService: FC service to use to forward content to the destination bucket.
handler_role_arn	typing.Union[str, ros_cdk_core.IResolvable]	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

cr^Required

cr: RosCustomResource

• Type: ros_cdk_ros.RosCustomResource

Attribute cr: Custom resource to trigger the bucket deployment.

---

fc_function^Required

fc_function: Function

• Type: ros_cdk_fc.Function

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

---

fc_service^Required

fc_service: Service

• Type: ros_cdk_fc.Service

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

---

handler_role_arn^Required

handler_role_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

---

Structs