Package software.amazon.awscdk.services.emrcontainers

Class CfnVirtualCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.emrcontainers.CfnVirtualCluster
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.689Z") @Stability(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();

  • 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 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 Details

    • 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()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getContainerProvider

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

    • setContainerProvider

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

    • setContainerProvider

      @Stability(Stable) public void setContainerProvider(@NotNull IResolvable 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.