Skip to content

Catalog

This class encapsulates and extends the ROS resource type ALIYUN::DLF::Catalog, which is used to create a catalog in Data Lake Formation (DLF).

Initializers

import ros_cdk_dlf
ros_cdk_dlf.Catalog(
  scope: Construct,
  id: str,
  catalog_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  location_uri: typing.Union[str, IResolvable] = None,
  owner: 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.
catalog_id typing.Union[str, ros_cdk_core.IResolvable] Property catalogId: Catalog ID.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description.
location_uri typing.Union[str, ros_cdk_core.IResolvable] Property locationUri: Location uri, for example: oss:\/\/dlf-test-oss-location\/.
owner typing.Union[str, ros_cdk_core.IResolvable] Property owner: Person in charge, principal format.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

catalog_idRequired

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

Property catalogId: Catalog ID.


descriptionOptional

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

Property description: Description.


location_uriOptional

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

Property locationUri: Location uri, for example: oss:\/\/dlf-test-oss-location\/.


ownerOptional

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

Property owner: Person in charge, principal format.

Empty auto-fill with current creator identity


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

import ros_cdk_dlf
ros_cdk_dlf.Catalog.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_catalog_id ros_cdk_core.IResolvable Attribute CatalogId: Catalog ID.

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_catalog_idRequired

attr_catalog_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CatalogId: Catalog ID.