software.amazon.awscdk.services.emrcontainers

Class CfnVirtualCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.emrcontainers.CfnVirtualCluster

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.240Z")
 @Stability(value=Stable)
public class CfnVirtualCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EMRContainers::VirtualCluster`.

The AWS::EMRContainers::VirtualCluster resource specifies a virtual cluster. A virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list, and delete virtual clusters. They do not consume any additional resources in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emrcontainers.*;
 CfnVirtualCluster cfnVirtualCluster = CfnVirtualCluster.Builder.create(this, "MyCfnVirtualCluster")
         .containerProvider(ContainerProviderProperty.builder()
                 .id("id")
                 .info(ContainerInfoProperty.builder()
                         .eksInfo(EksInfoProperty.builder()
                                 .namespace("namespace")
                                 .build())
                         .build())
                 .type("type")
                 .build())
         .name("name")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVirtualCluster.Builder A fluent builder for CfnVirtualCluster.
static interface	CfnVirtualCluster.ContainerInfoProperty The information about the container used for a job run or a managed endpoint.
static interface	CfnVirtualCluster.ContainerProviderProperty The information about the container provider.
static interface	CfnVirtualCluster.EksInfoProperty The information about the EKS cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVirtualCluster(software.constructs.Construct scope, String id, CfnVirtualClusterProps props) Create a new `AWS::EMRContainers::VirtualCluster`.
protected	CfnVirtualCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the project, such as `arn:aws:emr-containers:us-east-1:123456789012:/virtualclusters/ab4rp1abcs8xz47n3x0example` .
String	getAttrId() The ID of the virtual cluster, such as `ab4rp1abcs8xz47n3x0example` .
protected Map<String,Object>	getCfnProperties()
Object	getContainerProvider() The container provider of the virtual cluster.
String	getName() The name of the virtual cluster.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerProvider(CfnVirtualCluster.ContainerProviderProperty value) The container provider of the virtual cluster.
void	setContainerProvider(IResolvable value) The container provider of the virtual cluster.
void	setName(String value) The name of the virtual cluster.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVirtualCluster

protected CfnVirtualCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnVirtualCluster

protected CfnVirtualCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVirtualCluster

@Stability(value=Stable)
public CfnVirtualCluster(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnVirtualClusterProps props)

Create a new `AWS::EMRContainers::VirtualCluster`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the project, such as `arn:aws:emr-containers:us-east-1:123456789012:/virtualclusters/ab4rp1abcs8xz47n3x0example` .

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the virtual cluster, such as `ab4rp1abcs8xz47n3x0example` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getContainerProvider

@Stability(value=Stable)
 @NotNull
public Object getContainerProvider()

The container provider of the virtual cluster.

setContainerProvider

@Stability(value=Stable)
public void setContainerProvider(@NotNull
                                                          CfnVirtualCluster.ContainerProviderProperty value)

The container provider of the virtual cluster.

setContainerProvider

@Stability(value=Stable)
public void setContainerProvider(@NotNull
                                                          IResolvable value)

The container provider of the virtual cluster.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the virtual cluster.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the virtual cluster.