Package software.amazon.awscdk.services.emr

Class CfnNotebookExecution

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.emr.CfnNotebookExecution
All Implemented Interfaces:
IInspectable, INotebookExecutionRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:03.718Z") @Stability(Stable) public class CfnNotebookExecution extends CfnResource implements IInspectable, INotebookExecutionRef, ITaggableV2
An Amazon EMR Notebook execution.

A notebook execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.

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.emr.*;
 CfnNotebookExecution cfnNotebookExecution = CfnNotebookExecution.Builder.create(this, "MyCfnNotebookExecution")
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .executionEngine(ExecutionEngineConfigProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .type("type")
                 .build())
         .notebookExecutionName("notebookExecutionName")
         .notebookParams("notebookParams")
         .notebookS3Location(NotebookS3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .outputNotebookFormat("outputNotebookFormat")
         .outputNotebookS3Location(OutputNotebookS3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .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

    • CfnNotebookExecution

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

    • CfnNotebookExecution

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

    • CfnNotebookExecution

      @Stability(Stable) public CfnNotebookExecution(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnNotebookExecutionProps props)
      Create a new AWS::EMR::NotebookExecution.

      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.

    • CfnNotebookExecution

      @Stability(Stable) public CfnNotebookExecution(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::EMR::NotebookExecution.

      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.

  • Method Details

    • arnForNotebookExecution

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

    • isCfnNotebookExecution

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

      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 notebook execution.

    • getAttrNotebookExecutionId

      @Stability(Stable) @NotNull public String getAttrNotebookExecutionId()
      The unique identifier of the notebook execution.

    • getAttrStartTime

      @Stability(Stable) @NotNull public String getAttrStartTime()
      The timestamp when notebook execution started.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the notebook execution.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getNotebookExecutionRef

      @Stability(Stable) @NotNull public NotebookExecutionReference getNotebookExecutionRef()
      A reference to a NotebookExecution resource.
      Specified by:
      getNotebookExecutionRef in interface INotebookExecutionRef

    • getEnvironmentVariables

      @Stability(Stable) @Nullable public Object getEnvironmentVariables()
      The environment variables associated with the notebook execution.

      Returns union: either IResolvable or Mapinvalid input: '<'String, String>

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable IResolvable value)
      The environment variables associated with the notebook execution.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable Map<String,String> value)
      The environment variables associated with the notebook execution.

    • getExecutionEngine

      @Stability(Stable) @Nullable public Object getExecutionEngine()
      Specifies the execution engine (cluster) to run the notebook and perform the notebook execution.

      Returns union: either IResolvable or CfnNotebookExecution.ExecutionEngineConfigProperty

    • setExecutionEngine

      @Stability(Stable) public void setExecutionEngine(@Nullable IResolvable value)
      Specifies the execution engine (cluster) to run the notebook and perform the notebook execution.

    • setExecutionEngine

      @Stability(Stable) public void setExecutionEngine(@Nullable CfnNotebookExecution.ExecutionEngineConfigProperty value)
      Specifies the execution engine (cluster) to run the notebook and perform the notebook execution.

    • getNotebookExecutionName

      @Stability(Stable) @Nullable public String getNotebookExecutionName()
      An optional name for the notebook execution.

    • setNotebookExecutionName

      @Stability(Stable) public void setNotebookExecutionName(@Nullable String value)
      An optional name for the notebook execution.

    • getNotebookParams

      @Stability(Stable) @Nullable public String getNotebookParams()
      Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

    • setNotebookParams

      @Stability(Stable) public void setNotebookParams(@Nullable String value)
      Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

    • getNotebookS3Location

      @Stability(Stable) @Nullable public Object getNotebookS3Location()
      The Amazon S3 location that stores the notebook execution input.

      Returns union: either IResolvable or CfnNotebookExecution.NotebookS3LocationProperty

    • setNotebookS3Location

      @Stability(Stable) public void setNotebookS3Location(@Nullable IResolvable value)
      The Amazon S3 location that stores the notebook execution input.

    • setNotebookS3Location

      @Stability(Stable) public void setNotebookS3Location(@Nullable CfnNotebookExecution.NotebookS3LocationProperty value)
      The Amazon S3 location that stores the notebook execution input.

    • getOutputNotebookFormat

      @Stability(Stable) @Nullable public String getOutputNotebookFormat()
      The output format for the notebook execution.

    • setOutputNotebookFormat

      @Stability(Stable) public void setOutputNotebookFormat(@Nullable String value)
      The output format for the notebook execution.

    • getOutputNotebookS3Location

      @Stability(Stable) @Nullable public Object getOutputNotebookS3Location()
      The Amazon S3 location for the notebook execution output.

      Returns union: either IResolvable or CfnNotebookExecution.OutputNotebookS3LocationProperty

    • setOutputNotebookS3Location

      @Stability(Stable) public void setOutputNotebookS3Location(@Nullable IResolvable value)
      The Amazon S3 location for the notebook execution output.

    • setOutputNotebookS3Location

      @Stability(Stable) public void setOutputNotebookS3Location(@Nullable CfnNotebookExecution.OutputNotebookS3LocationProperty value)
      The Amazon S3 location for the notebook execution output.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags associated with a notebook execution.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags associated with a notebook execution.