software.amazon.awscdk.services.emrserverless

Class CfnApplication

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.emrserverless.CfnApplication

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.242Z")
 @Stability(value=Stable)
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EMRServerless::Application`.

The AWS::EMRServerless::Application resource specifies an EMR Serverless application. An application uses open source analytics frameworks to run jobs that process data. To create an application, you must specify the release version for the open source framework version you want to use and the type of application you want, such as Apache Spark or Apache Hive. After you create an application, you can submit data processing jobs or interactive requests to it.

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.emrserverless.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .releaseLabel("releaseLabel")
         .type("type")
         // the properties below are optional
         .autoStartConfiguration(AutoStartConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .autoStopConfiguration(AutoStopConfigurationProperty.builder()
                 .enabled(false)
                 .idleTimeoutMinutes(123)
                 .build())
         .initialCapacity(List.of(InitialCapacityConfigKeyValuePairProperty.builder()
                 .key("key")
                 .value(InitialCapacityConfigProperty.builder()
                         .workerConfiguration(WorkerConfigurationProperty.builder()
                                 .cpu("cpu")
                                 .memory("memory")
                                 // the properties below are optional
                                 .disk("disk")
                                 .build())
                         .workerCount(123)
                         .build())
                 .build()))
         .maximumCapacity(MaximumAllowedResourcesProperty.builder()
                 .cpu("cpu")
                 .memory("memory")
                 // the properties below are optional
                 .disk("disk")
                 .build())
         .name("name")
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnApplication.AutoStartConfigurationProperty The configuration for an application to automatically start on job submission.
static interface	CfnApplication.AutoStopConfigurationProperty The configuration for an application to automatically stop after a certain amount of time being idle.
static class	CfnApplication.Builder A fluent builder for CfnApplication.
static interface	CfnApplication.InitialCapacityConfigKeyValuePairProperty The initial capacity configuration per worker.
static interface	CfnApplication.InitialCapacityConfigProperty The initial capacity configuration per worker.
static interface	CfnApplication.MaximumAllowedResourcesProperty The maximum allowed cumulative resources for an application.
static interface	CfnApplication.NetworkConfigurationProperty The network configuration for customer VPC connectivity.
static interface	CfnApplication.WorkerConfigurationProperty The resource configuration of the initial capacity configuration.

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
	CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) Create a new `AWS::EMRServerless::Application`.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrApplicationId() The ID of the application, such as `ab4rp1abcs8xz47n3x0example` .
String	getAttrArn() The Amazon Resource Name (ARN) of the project.
Object	getAutoStartConfiguration() The configuration for an application to automatically start on job submission.
Object	getAutoStopConfiguration() The configuration for an application to automatically stop after a certain amount of time being idle.
protected Map<String,Object>	getCfnProperties()
Object	getInitialCapacity() The initial capacity of the application.
Object	getMaximumCapacity() The maximum capacity of the application.
String	getName() The name of the application.
Object	getNetworkConfiguration() The network configuration for customer VPC connectivity for the application.
String	getReleaseLabel() The EMR release version associated with the application.
TagManager	getTags() The tags assigned to the application.
String	getType() The type of application, such as Spark or Hive.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoStartConfiguration(CfnApplication.AutoStartConfigurationProperty value) The configuration for an application to automatically start on job submission.
void	setAutoStartConfiguration(IResolvable value) The configuration for an application to automatically start on job submission.
void	setAutoStopConfiguration(CfnApplication.AutoStopConfigurationProperty value) The configuration for an application to automatically stop after a certain amount of time being idle.
void	setAutoStopConfiguration(IResolvable value) The configuration for an application to automatically stop after a certain amount of time being idle.
void	setInitialCapacity(IResolvable value) The initial capacity of the application.
void	setInitialCapacity(List<Object> value) The initial capacity of the application.
void	setMaximumCapacity(CfnApplication.MaximumAllowedResourcesProperty value) The maximum capacity of the application.
void	setMaximumCapacity(IResolvable value) The maximum capacity of the application.
void	setName(String value) The name of the application.
void	setNetworkConfiguration(CfnApplication.NetworkConfigurationProperty value) The network configuration for customer VPC connectivity for the application.
void	setNetworkConfiguration(IResolvable value) The network configuration for customer VPC connectivity for the application.
void	setReleaseLabel(String value) The EMR release version associated with the application.
void	setType(String value) The type of application, such as Spark or Hive.

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

CfnApplication

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

CfnApplication

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

CfnApplication

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

Create a new `AWS::EMRServerless::Application`.

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.

getAttrApplicationId

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

The ID of the application, such as `ab4rp1abcs8xz47n3x0example` .

getAttrArn

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

The Amazon Resource Name (ARN) of the project.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags assigned to the application.

getReleaseLabel

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

The EMR release version associated with the application.

Minimum : 1

Maximum : 64

Pattern : ^[A-Za-z0-9._/-]+$

setReleaseLabel

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

The EMR release version associated with the application.

Minimum : 1

Maximum : 64

Pattern : ^[A-Za-z0-9._/-]+$

getType

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

The type of application, such as Spark or Hive.

setType

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

The type of application, such as Spark or Hive.

getAutoStartConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAutoStartConfiguration()

The configuration for an application to automatically start on job submission.

setAutoStartConfiguration

@Stability(value=Stable)
public void setAutoStartConfiguration(@Nullable
                                                               CfnApplication.AutoStartConfigurationProperty value)

The configuration for an application to automatically start on job submission.

setAutoStartConfiguration

@Stability(value=Stable)
public void setAutoStartConfiguration(@Nullable
                                                               IResolvable value)

The configuration for an application to automatically start on job submission.

getAutoStopConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAutoStopConfiguration()

The configuration for an application to automatically stop after a certain amount of time being idle.

setAutoStopConfiguration

@Stability(value=Stable)
public void setAutoStopConfiguration(@Nullable
                                                              CfnApplication.AutoStopConfigurationProperty value)

The configuration for an application to automatically stop after a certain amount of time being idle.

setAutoStopConfiguration

@Stability(value=Stable)
public void setAutoStopConfiguration(@Nullable
                                                              IResolvable value)

The configuration for an application to automatically stop after a certain amount of time being idle.

getInitialCapacity

@Stability(value=Stable)
 @Nullable
public Object getInitialCapacity()

The initial capacity of the application.

setInitialCapacity

@Stability(value=Stable)
public void setInitialCapacity(@Nullable
                                                        IResolvable value)

The initial capacity of the application.

setInitialCapacity

@Stability(value=Stable)
public void setInitialCapacity(@Nullable
                                                        List<Object> value)

The initial capacity of the application.

getMaximumCapacity

@Stability(value=Stable)
 @Nullable
public Object getMaximumCapacity()

The maximum capacity of the application.

This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

setMaximumCapacity

@Stability(value=Stable)
public void setMaximumCapacity(@Nullable
                                                        CfnApplication.MaximumAllowedResourcesProperty value)

The maximum capacity of the application.

This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

setMaximumCapacity

@Stability(value=Stable)
public void setMaximumCapacity(@Nullable
                                                        IResolvable value)

The maximum capacity of the application.

This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

getName

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

The name of the application.

Minimum : 1

Maximum : 64

Pattern : ^[A-Za-z0-9._\\/#-]+$

setName

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

The name of the application.

Minimum : 1

Maximum : 64

Pattern : ^[A-Za-z0-9._\\/#-]+$

getNetworkConfiguration

@Stability(value=Stable)
 @Nullable
public Object getNetworkConfiguration()

The network configuration for customer VPC connectivity for the application.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             CfnApplication.NetworkConfigurationProperty value)

The network configuration for customer VPC connectivity for the application.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             IResolvable value)

The network configuration for customer VPC connectivity for the application.