SparkWorkspace

• Implements: ISparkWorkspace

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

Initializers

import com.aliyun.ros.cdk.emr.SparkWorkspace;
SparkWorkspace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ossBucket(java.lang.String)
    .ossBucket(IResolvable)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .ramRoleName(java.lang.String)
    .ramRoleName(IResolvable)
    .resourceSpec(IResolvable)
    .resourceSpec(ResourceSpecProperty)
    .workspaceName(java.lang.String)
    .workspaceName(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.String)
//  .autoRenewPeriod(IResolvable)
//  .autoRenewPeriodUnit(java.lang.String)
//  .autoRenewPeriodUnit(IResolvable)
//  .autoStartSessionCluster(java.lang.Boolean)
//  .autoStartSessionCluster(IResolvable)
//  .dlfCatalogId(java.lang.String)
//  .dlfCatalogId(IResolvable)
//  .dlfType(java.lang.String)
//  .dlfType(IResolvable)
//  .duration(java.lang.String)
//  .duration(IResolvable)
//  .gpuSpec(IResolvable)
//  .gpuSpec(java.util.List<java.lang.String)
//  .gpuSpec(IResolvable>)
//  .gpuSubscription(IResolvable)
//  .gpuSubscription(GpuSubscriptionProperty)
//  .ipWhiteList(IResolvable)
//  .ipWhiteList(java.util.List<java.lang.String)
//  .ipWhiteList(IResolvable>)
//  .paymentDurationUnit(java.lang.String)
//  .paymentDurationUnit(IResolvable)
//  .releaseType(java.lang.String)
//  .releaseType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .subscription(IResolvable)
//  .subscription(SubscriptionProperty)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

ossBucket^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ossBucket: The OSS bucket path of the workspace.

The path must start with oss:///.

paymentType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The billing method of the workspace.

ramRoleName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

resourceSpec^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR ResourceSpecProperty

Property resourceSpec: The resource specifications of the workspace.

workspaceName^Required

• Type: java.lang.String OR com.aliyun.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 (_).

autoRenew^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

autoRenewPeriod^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: The automatic renewal duration.

autoRenewPeriodUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriodUnit: The unit of the automatic renewal duration.

autoStartSessionCluster^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoStartSessionCluster: Whether to automatically start a session cluster.

dlfCatalogId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dlfCatalogId: The ID of the DLF catalog.

dlfType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dlfType: The DLF type bound to the workspace.

duration^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property duration: The subscription duration.

gpuSpec^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property gpuSpec: The GPU instance types of the workspace.

gpuSubscription^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR GpuSubscriptionProperty

Property gpuSubscription: The GPU subscription configuration.

This configuration is applied after the workspace is created.

ipWhiteList^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property ipWhiteList: The IP whitelist of the workspace.

This configuration is applied after the workspace is created.

paymentDurationUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentDurationUnit: The unit of the subscription duration.

releaseType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property releaseType: The release type of the workspace.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

subscription^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR 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: java.util.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.emr.SparkWorkspace;
SparkWorkspace.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrStorage^Required

public java.lang.Object getAttrStorage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Storage: The OSS storage path of the workspace.

attrWorkspaceId^Required

public java.lang.Object getAttrWorkspaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkspaceId: The ID of the workspace.

props^Required

public SparkWorkspaceProps getProps();

• Type: SparkWorkspaceProps