Skip to content

BucketDeploymentProps

Initializer

import ros_cdk_ossdeployment
ros_cdk_ossdeployment.BucketDeploymentProps(
  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
)

Properties

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

destination_bucketRequired

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

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


sourcesRequired

sources: typing.List[ISource]

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


log_monitoringOptional

log_monitoring: bool
  • 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_createOptional

retain_on_create: bool
  • 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_arnOptional

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

The ARN of the execution role associated with this function.


timeoutOptional

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

The timeout period in seconds for the function to run.