SparkWorkspace

• Implements: ISparkWorkspace

This class encapsulates and extends the ROS resource type ALIYUN::EMR::SparkWorkspace.

Initializers

import ros_cdk_emr
ros_cdk_emr.SparkWorkspace(
  scope: Construct,
  id: str,
  oss_bucket: typing.Union[str, IResolvable],
  payment_type: typing.Union[str, IResolvable],
  ram_role_name: typing.Union[str, IResolvable],
  resource_spec: typing.Union[IResolvable, ResourceSpecProperty],
  workspace_name: typing.Union[str, IResolvable],
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[str, IResolvable] = None,
  auto_renew_period_unit: typing.Union[str, IResolvable] = None,
  auto_start_session_cluster: typing.Union[bool, IResolvable] = None,
  dlf_catalog_id: typing.Union[str, IResolvable] = None,
  dlf_type: typing.Union[str, IResolvable] = None,
  duration: typing.Union[str, IResolvable] = None,
  gpu_spec: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  gpu_subscription: typing.Union[IResolvable, GpuSubscriptionProperty] = None,
  ip_white_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  payment_duration_unit: typing.Union[str, IResolvable] = None,
  release_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  subscription: typing.Union[IResolvable, SubscriptionProperty] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

oss_bucket^Required

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

Property ossBucket: The OSS bucket path of the workspace.

The path must start with oss:///.

payment_type^Required

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

Property paymentType: The billing method of the workspace.

ram_role_name^Required

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

Property ramRoleName: The RAM role used to run Spark jobs.

resource_spec^Required

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

Property resourceSpec: The resource specifications of the workspace.

workspace_name^Required

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

Property workspaceName: The workspace name.

The name must be 1 to 64 characters in length and can contain Chinese characters, letters, digits, hyphens (-), and underscores (_).

auto_renew^Optional

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

Property autoRenew: Whether to enable automatic renewal for a subscription.

auto_renew_period^Optional

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

Property autoRenewPeriod: The automatic renewal duration.

auto_renew_period_unit^Optional

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

Property autoRenewPeriodUnit: The unit of the automatic renewal duration.

auto_start_session_cluster^Optional

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

Property autoStartSessionCluster: Whether to automatically start a session cluster.

dlf_catalog_id^Optional

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

Property dlfCatalogId: The ID of the DLF catalog.

dlf_type^Optional

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

Property dlfType: The DLF type bound to the workspace.

duration^Optional

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

Property duration: The subscription duration.

gpu_spec^Optional

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

Property gpuSpec: The GPU instance types of the workspace.

gpu_subscription^Optional

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

Property gpuSubscription: The GPU subscription configuration.

This configuration is applied after the workspace is created.

ip_white_list^Optional

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

Property ipWhiteList: The IP whitelist of the workspace.

This configuration is applied after the workspace is created.

payment_duration_unit^Optional

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

Property paymentDurationUnit: The unit of the subscription duration.

release_type^Optional

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

Property releaseType: The release type of the workspace.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

subscription^Optional

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

Property subscription: The configuration used to convert a pay-as-you-go workspace to a subscription workspace.

This configuration is applied after the workspace is created.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to workspace.

Max support 20 tags to add during create workspace. Each tag with two properties Key and Value, and Key is required.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_emr
ros_cdk_emr.SparkWorkspace.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attr_storage^Required

attr_storage: typing.Union[str, IResolvable]

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

Attribute Storage: The OSS storage path of the workspace.

attr_workspace_id^Required

attr_workspace_id: typing.Union[str, IResolvable]

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

Attribute WorkspaceId: The ID of the workspace.

props^Required

props: SparkWorkspaceProps

• Type: SparkWorkspaceProps