Skip to content

Bucket

This class encapsulates and extends the ROS resource type DATASOURCE::OSS::Bucket, which is used to query the information about an Object Storage Service (OSS) bucket.

Initializers 

from ros_cdk_oss import datasource
datasource.Bucket(
  scope: Construct,
  id: str,
  bucket_name: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
bucket_name typing.Union[str, ros_cdk_core.IResolvable] Property bucketName: Bucket name.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bucket_nameRequired

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

Property bucketName: Bucket name.

The naming conventions for buckets are as follows: Only lowercase letters, numbers, and dashes (-) can be included. Must start and end with lowercase letters or numbers. The length must be between 3 and 63 characters.

refresh_optionsOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

from ros_cdk_oss import datasource
datasource.Bucket.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the Bucket.
attr_extranet_endpoint ros_cdk_core.IResolvable Attribute ExtranetEndpoint: The domain name of the Bucket.
attr_intranet_endpoint ros_cdk_core.IResolvable Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region.
attr_location ros_cdk_core.IResolvable Attribute Location: The region where the Bucket is located.
attr_name ros_cdk_core.IResolvable Attribute Name: Bucket name.
attr_owner ros_cdk_core.IResolvable Attribute Owner: Container for storing Bucket owner information.
attr_storage_class ros_cdk_core.IResolvable Attribute StorageClass: The storage type of the Bucket.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the Bucket.

attr_extranet_endpointRequired 

attr_extranet_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExtranetEndpoint: The domain name of the Bucket.

attr_intranet_endpointRequired 

attr_intranet_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IntranetEndpoint: The intranet domain name of the ECS instance that accesses the Bucket in the same region.

attr_locationRequired 

attr_location: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Location: The region where the Bucket is located.

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: Bucket name.

attr_ownerRequired 

attr_owner: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Owner: Container for storing Bucket owner information.

attr_storage_classRequired 

attr_storage_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageClass: The storage type of the Bucket.