CfnApplication

class aws_cdk.aws_emrserverless.CfnApplication(scope, id, *, release_label, type, architecture=None, auto_start_configuration=None, auto_stop_configuration=None, image_configuration=None, initial_capacity=None, interactive_configuration=None, maximum_capacity=None, monitoring_configuration=None, name=None, network_configuration=None, runtime_configuration=None, scheduler_configuration=None, tags=None, worker_type_specifications=None)

Bases: CfnResource

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html
CloudformationResource:: AWS::EMRServerless::Application
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

# configuration_object_property_: emrserverless.CfnApplication.ConfigurationObjectProperty

cfn_application = emrserverless.CfnApplication(self, "MyCfnApplication",
    release_label="releaseLabel",
    type="type",

    # the properties below are optional
    architecture="architecture",
    auto_start_configuration=emrserverless.CfnApplication.AutoStartConfigurationProperty(
        enabled=False
    ),
    auto_stop_configuration=emrserverless.CfnApplication.AutoStopConfigurationProperty(
        enabled=False,
        idle_timeout_minutes=123
    ),
    image_configuration=emrserverless.CfnApplication.ImageConfigurationInputProperty(
        image_uri="imageUri"
    ),
    initial_capacity=[emrserverless.CfnApplication.InitialCapacityConfigKeyValuePairProperty(
        key="key",
        value=emrserverless.CfnApplication.InitialCapacityConfigProperty(
            worker_configuration=emrserverless.CfnApplication.WorkerConfigurationProperty(
                cpu="cpu",
                memory="memory",

                # the properties below are optional
                disk="disk",
                disk_type="diskType"
            ),
            worker_count=123
        )
    )],
    interactive_configuration=emrserverless.CfnApplication.InteractiveConfigurationProperty(
        livy_endpoint_enabled=False,
        studio_enabled=False
    ),
    maximum_capacity=emrserverless.CfnApplication.MaximumAllowedResourcesProperty(
        cpu="cpu",
        memory="memory",

        # the properties below are optional
        disk="disk"
    ),
    monitoring_configuration=emrserverless.CfnApplication.MonitoringConfigurationProperty(
        cloud_watch_logging_configuration=emrserverless.CfnApplication.CloudWatchLoggingConfigurationProperty(
            enabled=False,
            encryption_key_arn="encryptionKeyArn",
            log_group_name="logGroupName",
            log_stream_name_prefix="logStreamNamePrefix",
            log_type_map=[emrserverless.CfnApplication.LogTypeMapKeyValuePairProperty(
                key="key",
                value=["value"]
            )]
        ),
        managed_persistence_monitoring_configuration=emrserverless.CfnApplication.ManagedPersistenceMonitoringConfigurationProperty(
            enabled=False,
            encryption_key_arn="encryptionKeyArn"
        ),
        s3_monitoring_configuration=emrserverless.CfnApplication.S3MonitoringConfigurationProperty(
            encryption_key_arn="encryptionKeyArn",
            log_uri="logUri"
        )
    ),
    name="name",
    network_configuration=emrserverless.CfnApplication.NetworkConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    ),
    runtime_configuration=[emrserverless.CfnApplication.ConfigurationObjectProperty(
        classification="classification",

        # the properties below are optional
        configurations=[configuration_object_property_],
        properties={
            "properties_key": "properties"
        }
    )],
    scheduler_configuration=emrserverless.CfnApplication.SchedulerConfigurationProperty(
        max_concurrent_runs=123,
        queue_timeout_minutes=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    worker_type_specifications={
        "worker_type_specifications_key": emrserverless.CfnApplication.WorkerTypeSpecificationInputProperty(
            image_configuration=emrserverless.CfnApplication.ImageConfigurationInputProperty(
                image_uri="imageUri"
            )
        )
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
release_label (str) – The EMR release associated with the application.
type (str) – The type of application, such as Spark or Hive.
architecture (Optional[str]) – The CPU architecture of an application.
auto_start_configuration (Union[IResolvable, AutoStartConfigurationProperty, Dict[str, Any], None]) – The configuration for an application to automatically start on job submission.
auto_stop_configuration (Union[IResolvable, AutoStopConfigurationProperty, Dict[str, Any], None]) – The configuration for an application to automatically stop after a certain amount of time being idle.
image_configuration (Union[IResolvable, ImageConfigurationInputProperty, Dict[str, Any], None]) – The image configuration applied to all worker types.
initial_capacity (Union[IResolvable, Sequence[Union[IResolvable, InitialCapacityConfigKeyValuePairProperty, Dict[str, Any]]], None]) – The initial capacity of the application.
interactive_configuration (Union[IResolvable, InteractiveConfigurationProperty, Dict[str, Any], None]) – The interactive configuration object that enables the interactive use cases for an application.
maximum_capacity (Union[IResolvable, MaximumAllowedResourcesProperty, Dict[str, Any], None]) – 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.
monitoring_configuration (Union[IResolvable, MonitoringConfigurationProperty, Dict[str, Any], None]) – A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
name (Optional[str]) – The name of the application.
network_configuration (Union[IResolvable, NetworkConfigurationProperty, Dict[str, Any], None]) – The network configuration for customer VPC connectivity for the application.
runtime_configuration (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationObjectProperty, Dict[str, Any]]], None]) – The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.
scheduler_configuration (Union[IResolvable, SchedulerConfigurationProperty, Dict[str, Any], None]) – The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the application.
worker_type_specifications (Union[IResolvable, Mapping[str, Union[IResolvable, WorkerTypeSpecificationInputProperty, Dict[str, Any]]], None]) – The specification applied to each worker type.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EMRServerless::Application'

architecture: The CPU architecture of an application.

attr_application_id

The ID of the application, such as ab4rp1abcs8xz47n3x0example .

CloudformationAttribute:: ApplicationId

attr_arn

The Amazon Resource Name (ARN) of the project.

CloudformationAttribute:: Arn

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

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

image_configuration: The image configuration applied to all worker types.

initial_capacity: The initial capacity of the application.

interactive_configuration: The interactive configuration object that enables the interactive use cases for an application.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

maximum_capacity: The maximum capacity of the application.

monitoring_configuration: A configuration specification to be used when provisioning an application.

name: The name of the application.

network_configuration: The network configuration for customer VPC connectivity for the application.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

release_label: The EMR release associated with the application.

runtime_configuration

//docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html>`_ API operation.

Type:: The `Configuration <https
Type:: //docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html>`_ specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the `GetApplication <https

scheduler_configuration: The scheduler configuration for batch and streaming jobs running on this application.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags assigned to the application.

type: The type of application, such as Spark or Hive.

worker_type_specifications: The specification applied to each worker type.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AutoStartConfigurationProperty

class CfnApplication.AutoStartConfigurationProperty(*, enabled=None)

Bases: object

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

Parameters:: enabled (Union[bool, IResolvable, None]) – Enables the application to automatically start on job submission. Default: - true
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

auto_start_configuration_property = emrserverless.CfnApplication.AutoStartConfigurationProperty(
    enabled=False
)

Attributes

enabled

Enables the application to automatically start on job submission.

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html#cfn-emrserverless-application-autostartconfiguration-enabled

AutoStopConfigurationProperty

class CfnApplication.AutoStopConfigurationProperty(*, enabled=None, idle_timeout_minutes=None)

Bases: object

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

Parameters:

enabled (Union[bool, IResolvable, None]) – Enables the application to automatically stop after a certain amount of time being idle. Defaults to true. Default: - true
idle_timeout_minutes (Union[int, float, None]) – The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

auto_stop_configuration_property = emrserverless.CfnApplication.AutoStopConfigurationProperty(
    enabled=False,
    idle_timeout_minutes=123
)

Attributes

enabled

Enables the application to automatically stop after a certain amount of time being idle.

Defaults to true.

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html#cfn-emrserverless-application-autostopconfiguration-enabled

idle_timeout_minutes

The amount of idle time in minutes after which your application will automatically stop.

Defaults to 15 minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html#cfn-emrserverless-application-autostopconfiguration-idletimeoutminutes

CloudWatchLoggingConfigurationProperty

class CfnApplication.CloudWatchLoggingConfigurationProperty(*, enabled=None, encryption_key_arn=None, log_group_name=None, log_stream_name_prefix=None, log_type_map=None)

Bases: object

The Amazon CloudWatch configuration for monitoring logs.

You can configure your jobs to send log information to CloudWatch.

Parameters:

enabled (Union[bool, IResolvable, None]) – Enables CloudWatch logging. Default: - false
encryption_key_arn (Optional[str]) – The AWS Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.
log_group_name (Optional[str]) – The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
log_stream_name_prefix (Optional[str]) – Prefix for the CloudWatch log stream name.
log_type_map (Union[IResolvable, Sequence[Union[IResolvable, LogTypeMapKeyValuePairProperty, Dict[str, Any]]], None]) – The specific log-streams which need to be uploaded to CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

cloud_watch_logging_configuration_property = emrserverless.CfnApplication.CloudWatchLoggingConfigurationProperty(
    enabled=False,
    encryption_key_arn="encryptionKeyArn",
    log_group_name="logGroupName",
    log_stream_name_prefix="logStreamNamePrefix",
    log_type_map=[emrserverless.CfnApplication.LogTypeMapKeyValuePairProperty(
        key="key",
        value=["value"]
    )]
)

Attributes

enabled

Enables CloudWatch logging.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-enabled

encryption_key_arn

The AWS Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-encryptionkeyarn

log_group_name

The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-loggroupname

log_stream_name_prefix

Prefix for the CloudWatch log stream name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-logstreamnameprefix

log_type_map

The specific log-streams which need to be uploaded to CloudWatch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-logtypemap

ConfigurationObjectProperty

class CfnApplication.ConfigurationObjectProperty(*, classification, configurations=None, properties=None)

Bases: object

A configuration specification to be used when provisioning an application.

A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

Parameters:

classification (str) – The classification within a configuration.
configurations (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationObjectProperty, Dict[str, Any]]], None]) – A list of additional configurations to apply within a configuration object.
properties (Union[IResolvable, Mapping[str, str], None]) – A set of properties specified within a configuration classification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

# configuration_object_property_: emrserverless.CfnApplication.ConfigurationObjectProperty

configuration_object_property = emrserverless.CfnApplication.ConfigurationObjectProperty(
    classification="classification",

    # the properties below are optional
    configurations=[configuration_object_property_],
    properties={
        "properties_key": "properties"
    }
)

Attributes

classification

The classification within a configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-classification

configurations

A list of additional configurations to apply within a configuration object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-configurations

properties

A set of properties specified within a configuration classification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-properties

ImageConfigurationInputProperty

class CfnApplication.ImageConfigurationInputProperty(*, image_uri=None)

Bases: object

The image configuration.

Parameters:: image_uri (Optional[str]) – The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

image_configuration_input_property = emrserverless.CfnApplication.ImageConfigurationInputProperty(
    image_uri="imageUri"
)

Attributes

image_uri

The URI of an image in the Amazon ECR registry.

This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html#cfn-emrserverless-application-imageconfigurationinput-imageuri

InitialCapacityConfigKeyValuePairProperty

class CfnApplication.InitialCapacityConfigKeyValuePairProperty(*, key, value)

Bases: object

Parameters:

key (str) – Worker type for an analytics framework.
value (Union[IResolvable, InitialCapacityConfigProperty, Dict[str, Any]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

initial_capacity_config_key_value_pair_property = emrserverless.CfnApplication.InitialCapacityConfigKeyValuePairProperty(
    key="key",
    value=emrserverless.CfnApplication.InitialCapacityConfigProperty(
        worker_configuration=emrserverless.CfnApplication.WorkerConfigurationProperty(
            cpu="cpu",
            memory="memory",

            # the properties below are optional
            disk="disk",
            disk_type="diskType"
        ),
        worker_count=123
    )
)

Attributes

key

Worker type for an analytics framework.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html#cfn-emrserverless-application-initialcapacityconfigkeyvaluepair-key

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html#cfn-emrserverless-application-initialcapacityconfigkeyvaluepair-value

Type:: see

InitialCapacityConfigProperty

class CfnApplication.InitialCapacityConfigProperty(*, worker_configuration, worker_count)

Bases: object

The initial capacity configuration per worker.

Parameters:

worker_configuration (Union[IResolvable, WorkerConfigurationProperty, Dict[str, Any]]) – The resource configuration of the initial capacity configuration.
worker_count (Union[int, float]) – The number of workers in the initial capacity configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

initial_capacity_config_property = emrserverless.CfnApplication.InitialCapacityConfigProperty(
    worker_configuration=emrserverless.CfnApplication.WorkerConfigurationProperty(
        cpu="cpu",
        memory="memory",

        # the properties below are optional
        disk="disk",
        disk_type="diskType"
    ),
    worker_count=123
)

Attributes

worker_configuration

The resource configuration of the initial capacity configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html#cfn-emrserverless-application-initialcapacityconfig-workerconfiguration

worker_count

The number of workers in the initial capacity configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html#cfn-emrserverless-application-initialcapacityconfig-workercount

InteractiveConfigurationProperty

class CfnApplication.InteractiveConfigurationProperty(*, livy_endpoint_enabled=None, studio_enabled=None)

Bases: object

The configuration to use to enable the different types of interactive use cases in an application.

Parameters:

livy_endpoint_enabled (Union[bool, IResolvable, None]) – Enables an Apache Livy endpoint that you can connect to and run interactive jobs. Default: - false
studio_enabled (Union[bool, IResolvable, None]) – Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

interactive_configuration_property = emrserverless.CfnApplication.InteractiveConfigurationProperty(
    livy_endpoint_enabled=False,
    studio_enabled=False
)

Attributes

livy_endpoint_enabled

Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html#cfn-emrserverless-application-interactiveconfiguration-livyendpointenabled

studio_enabled

Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html#cfn-emrserverless-application-interactiveconfiguration-studioenabled

LogTypeMapKeyValuePairProperty

class CfnApplication.LogTypeMapKeyValuePairProperty(*, key, value)

Bases: object

Parameters:

key (str) –
value (Sequence[str]) – List of Applicable values: [STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS].

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

log_type_map_key_value_pair_property = emrserverless.CfnApplication.LogTypeMapKeyValuePairProperty(
    key="key",
    value=["value"]
)

Attributes

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html#cfn-emrserverless-application-logtypemapkeyvaluepair-key

Type:: see

value

[STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS].

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html#cfn-emrserverless-application-logtypemapkeyvaluepair-value
Type:: List of Applicable values

ManagedPersistenceMonitoringConfigurationProperty

class CfnApplication.ManagedPersistenceMonitoringConfigurationProperty(*, enabled=None, encryption_key_arn=None)

Bases: object

The managed log persistence configuration for a job run.

Parameters:

enabled (Union[bool, IResolvable, None]) – Enables managed logging and defaults to true. If set to false, managed logging will be turned off. Default: - true
encryption_key_arn (Optional[str]) – The KMS key ARN to encrypt the logs stored in managed log persistence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

managed_persistence_monitoring_configuration_property = emrserverless.CfnApplication.ManagedPersistenceMonitoringConfigurationProperty(
    enabled=False,
    encryption_key_arn="encryptionKeyArn"
)

Attributes

enabled

Enables managed logging and defaults to true.

If set to false, managed logging will be turned off.

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html#cfn-emrserverless-application-managedpersistencemonitoringconfiguration-enabled

encryption_key_arn

The KMS key ARN to encrypt the logs stored in managed log persistence.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html#cfn-emrserverless-application-managedpersistencemonitoringconfiguration-encryptionkeyarn

MaximumAllowedResourcesProperty

class CfnApplication.MaximumAllowedResourcesProperty(*, cpu, memory, disk=None)

Bases: object

The maximum allowed cumulative resources for an application.

No new resources will be created once the limit is hit.

Parameters:

cpu (str) – The maximum allowed CPU for an application.
memory (str) – The maximum allowed resources for an application.
disk (Optional[str]) – The maximum allowed disk for an application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

maximum_allowed_resources_property = emrserverless.CfnApplication.MaximumAllowedResourcesProperty(
    cpu="cpu",
    memory="memory",

    # the properties below are optional
    disk="disk"
)

Attributes

cpu

The maximum allowed CPU for an application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-cpu

disk

The maximum allowed disk for an application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-disk

memory

The maximum allowed resources for an application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-memory

MonitoringConfigurationProperty

class CfnApplication.MonitoringConfigurationProperty(*, cloud_watch_logging_configuration=None, managed_persistence_monitoring_configuration=None, s3_monitoring_configuration=None)

Bases: object

The configuration setting for monitoring logs.

Parameters:

cloud_watch_logging_configuration (Union[IResolvable, CloudWatchLoggingConfigurationProperty, Dict[str, Any], None]) – The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.
managed_persistence_monitoring_configuration (Union[IResolvable, ManagedPersistenceMonitoringConfigurationProperty, Dict[str, Any], None]) – The managed log persistence configuration for a job run.
s3_monitoring_configuration (Union[IResolvable, S3MonitoringConfigurationProperty, Dict[str, Any], None]) – The Amazon S3 configuration for monitoring log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

monitoring_configuration_property = emrserverless.CfnApplication.MonitoringConfigurationProperty(
    cloud_watch_logging_configuration=emrserverless.CfnApplication.CloudWatchLoggingConfigurationProperty(
        enabled=False,
        encryption_key_arn="encryptionKeyArn",
        log_group_name="logGroupName",
        log_stream_name_prefix="logStreamNamePrefix",
        log_type_map=[emrserverless.CfnApplication.LogTypeMapKeyValuePairProperty(
            key="key",
            value=["value"]
        )]
    ),
    managed_persistence_monitoring_configuration=emrserverless.CfnApplication.ManagedPersistenceMonitoringConfigurationProperty(
        enabled=False,
        encryption_key_arn="encryptionKeyArn"
    ),
    s3_monitoring_configuration=emrserverless.CfnApplication.S3MonitoringConfigurationProperty(
        encryption_key_arn="encryptionKeyArn",
        log_uri="logUri"
    )
)

Attributes

cloud_watch_logging_configuration

The Amazon CloudWatch configuration for monitoring logs.

You can configure your jobs to send log information to CloudWatch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-cloudwatchloggingconfiguration

managed_persistence_monitoring_configuration

The managed log persistence configuration for a job run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-managedpersistencemonitoringconfiguration

s3_monitoring_configuration

The Amazon S3 configuration for monitoring log publishing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-s3monitoringconfiguration

NetworkConfigurationProperty

class CfnApplication.NetworkConfigurationProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

The network configuration for customer VPC connectivity.

Parameters:

security_group_ids (Optional[Sequence[str]]) – The array of security group Ids for customer VPC connectivity.
subnet_ids (Optional[Sequence[str]]) – The array of subnet Ids for customer VPC connectivity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

network_configuration_property = emrserverless.CfnApplication.NetworkConfigurationProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

The array of security group Ids for customer VPC connectivity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html#cfn-emrserverless-application-networkconfiguration-securitygroupids

subnet_ids

The array of subnet Ids for customer VPC connectivity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html#cfn-emrserverless-application-networkconfiguration-subnetids

S3MonitoringConfigurationProperty

class CfnApplication.S3MonitoringConfigurationProperty(*, encryption_key_arn=None, log_uri=None)

Bases: object

The Amazon S3 configuration for monitoring log publishing.

You can configure your jobs to send log information to Amazon S3.

Parameters:

encryption_key_arn (Optional[str]) – The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
log_uri (Optional[str]) – The Amazon S3 destination URI for log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

s3_monitoring_configuration_property = emrserverless.CfnApplication.S3MonitoringConfigurationProperty(
    encryption_key_arn="encryptionKeyArn",
    log_uri="logUri"
)

Attributes

encryption_key_arn

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html#cfn-emrserverless-application-s3monitoringconfiguration-encryptionkeyarn

log_uri

The Amazon S3 destination URI for log publishing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html#cfn-emrserverless-application-s3monitoringconfiguration-loguri

SchedulerConfigurationProperty

class CfnApplication.SchedulerConfigurationProperty(*, max_concurrent_runs=None, queue_timeout_minutes=None)

Bases: object

The scheduler configuration for batch and streaming jobs running on this application.

Supported with release labels emr-7.0.0 and above.

Parameters:

max_concurrent_runs (Union[int, float, None]) – The maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000.
queue_timeout_minutes (Union[int, float, None]) – The maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

scheduler_configuration_property = emrserverless.CfnApplication.SchedulerConfigurationProperty(
    max_concurrent_runs=123,
    queue_timeout_minutes=123
)

Attributes

max_concurrent_runs

The maximum concurrent job runs on this application.

If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html#cfn-emrserverless-application-schedulerconfiguration-maxconcurrentruns

queue_timeout_minutes

The maximum duration in minutes for the job in QUEUED state.

If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html#cfn-emrserverless-application-schedulerconfiguration-queuetimeoutminutes

WorkerConfigurationProperty

class CfnApplication.WorkerConfigurationProperty(*, cpu, memory, disk=None, disk_type=None)

Bases: object

The configuration of a worker.

For more information, see Supported worker configurations .

Parameters:

cpu (str) – The CPU requirements of the worker configuration. Each worker can have 1, 2, 4, 8, or 16 vCPUs.
memory (str) – The memory requirements of the worker configuration.
disk (Optional[str]) – The disk requirements of the worker configuration.
disk_type (Optional[str]) – The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

worker_configuration_property = emrserverless.CfnApplication.WorkerConfigurationProperty(
    cpu="cpu",
    memory="memory",

    # the properties below are optional
    disk="disk",
    disk_type="diskType"
)

Attributes

cpu

The CPU requirements of the worker configuration.

Each worker can have 1, 2, 4, 8, or 16 vCPUs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-cpu

disk

The disk requirements of the worker configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-disk

disk_type

The disk type for every worker instance of the work type.

Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-disktype

memory

The memory requirements of the worker configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-memory

WorkerTypeSpecificationInputProperty

class CfnApplication.WorkerTypeSpecificationInputProperty(*, image_configuration=None)

Bases: object

The specifications for a worker type.

Parameters:: image_configuration (Union[IResolvable, ImageConfigurationInputProperty, Dict[str, Any], None]) – The image configuration for a worker type.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emrserverless as emrserverless

worker_type_specification_input_property = emrserverless.CfnApplication.WorkerTypeSpecificationInputProperty(
    image_configuration=emrserverless.CfnApplication.ImageConfigurationInputProperty(
        image_uri="imageUri"
    )
)

Attributes

image_configuration

The image configuration for a worker type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html#cfn-emrserverless-application-workertypespecificationinput-imageconfiguration