Package 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, IVirtualClusterRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:36.819Z") @Stability(Stable) public class CfnVirtualCluster extends CfnResource implements IInspectable, IVirtualClusterRef, ITaggable
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
         .securityConfigurationId("securityConfigurationId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVirtualCluster

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

    • CfnVirtualCluster

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

    • CfnVirtualCluster

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForVirtualCluster

      @Stability(Stable) @NotNull public static String arnForVirtualCluster(@NotNull IVirtualClusterRef resource)
      Parameters:
      resource - This parameter is required.

    • fromVirtualClusterArn

      @Stability(Stable) @NotNull public static IVirtualClusterRef fromVirtualClusterArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IVirtualClusterRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromVirtualClusterId

      @Stability(Stable) @NotNull public static IVirtualClusterRef fromVirtualClusterId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String virtualClusterId)
      Creates a new IVirtualClusterRef from a virtualClusterId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      virtualClusterId - This parameter is required.

    • isCfnVirtualCluster

      @Stability(Stable) @NotNull public static Boolean isCfnVirtualCluster(@NotNull Object x)
      Checks whether the given object is a CfnVirtualCluster.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(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(Stable) @NotNull public String getAttrId()
      The ID of the virtual cluster, such as ab4rp1abcs8xz47n3x0example .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getVirtualClusterRef

      @Stability(Stable) @NotNull public VirtualClusterReference getVirtualClusterRef()
      A reference to a VirtualCluster resource.
      Specified by:
      getVirtualClusterRef in interface IVirtualClusterRef

    • getContainerProvider

      @Stability(Stable) @NotNull public Object getContainerProvider()
      The container provider of the virtual cluster.

      Returns union: either IResolvable or CfnVirtualCluster.ContainerProviderProperty

    • setContainerProvider

      @Stability(Stable) public void setContainerProvider(@NotNull IResolvable value)
      The container provider of the virtual cluster.

    • setContainerProvider

      @Stability(Stable) public void setContainerProvider(@NotNull CfnVirtualCluster.ContainerProviderProperty value)
      The container provider of the virtual cluster.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the virtual cluster.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the virtual cluster.

    • getSecurityConfigurationId

      @Stability(Stable) @Nullable public String getSecurityConfigurationId()
      The ID of the security configuration.

    • setSecurityConfigurationId

      @Stability(Stable) public void setSecurityConfigurationId(@Nullable String value)
      The ID of the security configuration.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.