CfnJobTemplate

class aws_cdk.aws_emrcontainers.CfnJobTemplate(scope, id, *, job_template_data, name, tags=None)

Bases: CfnResource

Represents an Amazon EMR on EKS job template.

A job template stores the values of a StartJobRun API request in a reusable template, so they can be used to start a job run or to enforce certain values in a StartJobRun API request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-jobtemplate.html

CloudformationResource:

AWS::EMRContainers::JobTemplate

ExampleMetadata:

fixture=_generated

Example:

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

# configuration_property_: emrcontainers.CfnJobTemplate.ConfigurationProperty

cfn_job_template = emrcontainers.CfnJobTemplate(self, "MyCfnJobTemplate",
    job_template_data=emrcontainers.CfnJobTemplate.JobTemplateDataProperty(
        execution_role_arn="executionRoleArn",
        job_driver=emrcontainers.CfnJobTemplate.JobDriverProperty(
            spark_sql_job_driver=emrcontainers.CfnJobTemplate.SparkSqlJobDriverProperty(
                entry_point="entryPoint",
                spark_sql_parameters="sparkSqlParameters"
            ),
            spark_submit_job_driver=emrcontainers.CfnJobTemplate.SparkSubmitJobDriverProperty(
                entry_point="entryPoint",

                # the properties below are optional
                entry_point_arguments=["entryPointArguments"],
                spark_submit_parameters="sparkSubmitParameters"
            )
        ),
        release_label="releaseLabel",

        # the properties below are optional
        configuration_overrides=emrcontainers.CfnJobTemplate.ParametricConfigurationOverridesProperty(
            application_configuration=[emrcontainers.CfnJobTemplate.ConfigurationProperty(
                classification="classification",

                # the properties below are optional
                configurations=[configuration_property_],
                properties={
                    "properties_key": "properties"
                }
            )],
            monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricMonitoringConfigurationProperty(
                cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(
                    log_group_name="logGroupName",
                    log_stream_name_prefix="logStreamNamePrefix"
                ),
                persistent_app_ui="persistentAppUi",
                s3_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(
                    log_uri="logUri"
                )
            )
        ),
        job_tags={
            "job_tags_key": "jobTags"
        },
        parameter_configuration={
            "parameter_configuration_key": emrcontainers.CfnJobTemplate.TemplateParameterConfigurationProperty(
                default_value="defaultValue",
                type="type"
            )
        }
    ),
    name="name",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::EMRContainers::JobTemplate.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • job_template_data (Union[IResolvable, JobTemplateDataProperty, Dict[str, Any]]) – The values of a StartJobRun API request used in job runs started using the job template.

  • name (str) – The specified name of the job template.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags that are associated with the job template.

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)

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

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

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.

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

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

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

add_resource_dependency(target, reason=None)

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.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

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

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

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 and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, 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)

(deprecated) 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)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_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:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EMRContainers::JobTemplate'
attr_arn

The ARN of the job template.

CloudformationAttribute:

Arn

attr_created_at

The date and time when the job template was created.

CloudformationAttribute:

CreatedAt

attr_created_by

The user who created the job template.

CloudformationAttribute:

CreatedBy

attr_id

The ID of the job template.

CloudformationAttribute:

Id

cdk_tag_manager

Tag Manager which manages the tags for this resource.

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.

env
job_template_data

The values of a StartJobRun API request used in job runs started using the job template.

job_template_ref

A reference to a JobTemplate resource.

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.

name

The specified name of the job template.

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 }).

stack

The stack in which this element is defined.

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

tags

The tags that are associated with the job template.

Static Methods

classmethod arn_for_job_template(resource)
Parameters:

resource (IJobTemplateRef)

Return type:

str

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_job_template(x)

Checks whether the given object is a CfnJobTemplate.

Parameters:

x (Any)

Return type:

bool

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.

ConfigurationProperty

class CfnJobTemplate.ConfigurationProperty(*, classification, configurations=None, properties=None)

Bases: object

A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS.

Parameters:

  • classification (str) – The classification within a configuration.

  • configurations (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationProperty, Dict[str, Any]]], None])

  • 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-emrcontainers-jobtemplate-configuration.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_emrcontainers as emrcontainers

# configuration_property_: emrcontainers.CfnJobTemplate.ConfigurationProperty

configuration_property = emrcontainers.CfnJobTemplate.ConfigurationProperty(
    classification="classification",

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

Attributes

classification

The classification within a configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-configuration.html#cfn-emrcontainers-jobtemplate-configuration-classification

configurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-configuration.html#cfn-emrcontainers-jobtemplate-configuration-configurations

Type:

see

properties

A set of properties specified within a configuration classification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-configuration.html#cfn-emrcontainers-jobtemplate-configuration-properties

JobDriverProperty

class CfnJobTemplate.JobDriverProperty(*, spark_sql_job_driver=None, spark_submit_job_driver=None)

Bases: object

Specify the driver that the job runs on.

Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobdriver.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_emrcontainers as emrcontainers

job_driver_property = emrcontainers.CfnJobTemplate.JobDriverProperty(
    spark_sql_job_driver=emrcontainers.CfnJobTemplate.SparkSqlJobDriverProperty(
        entry_point="entryPoint",
        spark_sql_parameters="sparkSqlParameters"
    ),
    spark_submit_job_driver=emrcontainers.CfnJobTemplate.SparkSubmitJobDriverProperty(
        entry_point="entryPoint",

        # the properties below are optional
        entry_point_arguments=["entryPointArguments"],
        spark_submit_parameters="sparkSubmitParameters"
    )
)

Attributes

spark_sql_job_driver

The job driver for job type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobdriver.html#cfn-emrcontainers-jobtemplate-jobdriver-sparksqljobdriver

spark_submit_job_driver

The information about job driver for Spark submit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobdriver.html#cfn-emrcontainers-jobtemplate-jobdriver-sparksubmitjobdriver

JobTemplateDataProperty

class CfnJobTemplate.JobTemplateDataProperty(*, execution_role_arn, job_driver, release_label, configuration_overrides=None, job_tags=None, parameter_configuration=None)

Bases: object

The values of a StartJobRun API request used in job runs started using the job template.

Parameters:

  • execution_role_arn (str) – The execution role ARN of the job run, or a template parameter reference.

  • job_driver (Union[IResolvable, JobDriverProperty, Dict[str, Any]]) – Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.

  • release_label (str) – The release version of Amazon EMR, or a template parameter reference.

  • configuration_overrides (Union[IResolvable, ParametricConfigurationOverridesProperty, Dict[str, Any], None]) – A configuration specification to be used to override existing configurations. This data type allows job template parameters to be specified within.

  • job_tags (Union[IResolvable, Mapping[str, str], None]) – The tags assigned to jobs started using the job template.

  • parameter_configuration (Union[IResolvable, Mapping[str, Union[IResolvable, TemplateParameterConfigurationProperty, Dict[str, Any]]], None]) – The configuration of parameters existing in the job template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.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_emrcontainers as emrcontainers

# configuration_property_: emrcontainers.CfnJobTemplate.ConfigurationProperty

job_template_data_property = emrcontainers.CfnJobTemplate.JobTemplateDataProperty(
    execution_role_arn="executionRoleArn",
    job_driver=emrcontainers.CfnJobTemplate.JobDriverProperty(
        spark_sql_job_driver=emrcontainers.CfnJobTemplate.SparkSqlJobDriverProperty(
            entry_point="entryPoint",
            spark_sql_parameters="sparkSqlParameters"
        ),
        spark_submit_job_driver=emrcontainers.CfnJobTemplate.SparkSubmitJobDriverProperty(
            entry_point="entryPoint",

            # the properties below are optional
            entry_point_arguments=["entryPointArguments"],
            spark_submit_parameters="sparkSubmitParameters"
        )
    ),
    release_label="releaseLabel",

    # the properties below are optional
    configuration_overrides=emrcontainers.CfnJobTemplate.ParametricConfigurationOverridesProperty(
        application_configuration=[emrcontainers.CfnJobTemplate.ConfigurationProperty(
            classification="classification",

            # the properties below are optional
            configurations=[configuration_property_],
            properties={
                "properties_key": "properties"
            }
        )],
        monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricMonitoringConfigurationProperty(
            cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(
                log_group_name="logGroupName",
                log_stream_name_prefix="logStreamNamePrefix"
            ),
            persistent_app_ui="persistentAppUi",
            s3_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(
                log_uri="logUri"
            )
        )
    ),
    job_tags={
        "job_tags_key": "jobTags"
    },
    parameter_configuration={
        "parameter_configuration_key": emrcontainers.CfnJobTemplate.TemplateParameterConfigurationProperty(
            default_value="defaultValue",
            type="type"
        )
    }
)

Attributes

configuration_overrides

A configuration specification to be used to override existing configurations.

This data type allows job template parameters to be specified within.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-configurationoverrides

execution_role_arn

The execution role ARN of the job run, or a template parameter reference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-executionrolearn

job_driver

Specify the driver that the job runs on.

Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-jobdriver

job_tags

The tags assigned to jobs started using the job template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-jobtags

parameter_configuration

The configuration of parameters existing in the job template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-parameterconfiguration

release_label

The release version of Amazon EMR, or a template parameter reference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-jobtemplatedata.html#cfn-emrcontainers-jobtemplate-jobtemplatedata-releaselabel

ParametricCloudWatchMonitoringConfigurationProperty

class CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(*, log_group_name=None, log_stream_name_prefix=None)

Bases: object

A configuration for CloudWatch monitoring.

This data type allows job template parameters to be specified within.

Parameters:

  • log_group_name (Optional[str]) – The name of the log group for log publishing, or a template parameter reference.

  • log_stream_name_prefix (Optional[str]) – The specified name prefix for log streams.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametriccloudwatchmonitoringconfiguration.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_emrcontainers as emrcontainers

parametric_cloud_watch_monitoring_configuration_property = emrcontainers.CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(
    log_group_name="logGroupName",
    log_stream_name_prefix="logStreamNamePrefix"
)

Attributes

log_group_name

The name of the log group for log publishing, or a template parameter reference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametriccloudwatchmonitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametriccloudwatchmonitoringconfiguration-loggroupname

log_stream_name_prefix

The specified name prefix for log streams.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametriccloudwatchmonitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametriccloudwatchmonitoringconfiguration-logstreamnameprefix

ParametricConfigurationOverridesProperty

class CfnJobTemplate.ParametricConfigurationOverridesProperty(*, application_configuration=None, monitoring_configuration=None)

Bases: object

A configuration specification to be used to override existing configurations.

This data type allows job template parameters to be specified within.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricconfigurationoverrides.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_emrcontainers as emrcontainers

# configuration_property_: emrcontainers.CfnJobTemplate.ConfigurationProperty

parametric_configuration_overrides_property = emrcontainers.CfnJobTemplate.ParametricConfigurationOverridesProperty(
    application_configuration=[emrcontainers.CfnJobTemplate.ConfigurationProperty(
        classification="classification",

        # the properties below are optional
        configurations=[configuration_property_],
        properties={
            "properties_key": "properties"
        }
    )],
    monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricMonitoringConfigurationProperty(
        cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(
            log_group_name="logGroupName",
            log_stream_name_prefix="logStreamNamePrefix"
        ),
        persistent_app_ui="persistentAppUi",
        s3_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(
            log_uri="logUri"
        )
    )
)

Attributes

application_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricconfigurationoverrides.html#cfn-emrcontainers-jobtemplate-parametricconfigurationoverrides-applicationconfiguration

Type:

see

monitoring_configuration

Configuration setting for monitoring.

This data type allows job template parameters to be specified within.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricconfigurationoverrides.html#cfn-emrcontainers-jobtemplate-parametricconfigurationoverrides-monitoringconfiguration

ParametricMonitoringConfigurationProperty

class CfnJobTemplate.ParametricMonitoringConfigurationProperty(*, cloud_watch_monitoring_configuration=None, persistent_app_ui=None, s3_monitoring_configuration=None)

Bases: object

Configuration setting for monitoring.

This data type allows job template parameters to be specified within.

Parameters:

  • cloud_watch_monitoring_configuration (Union[IResolvable, ParametricCloudWatchMonitoringConfigurationProperty, Dict[str, Any], None]) – A configuration for CloudWatch monitoring. This data type allows job template parameters to be specified within.

  • persistent_app_ui (Optional[str]) – Monitoring configurations for the persistent application UI, or a template parameter reference.

  • s3_monitoring_configuration (Union[IResolvable, ParametricS3MonitoringConfigurationProperty, Dict[str, Any], None]) – Amazon S3 configuration for monitoring log publishing. This data type allows job template parameters to be specified within.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricmonitoringconfiguration.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_emrcontainers as emrcontainers

parametric_monitoring_configuration_property = emrcontainers.CfnJobTemplate.ParametricMonitoringConfigurationProperty(
    cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricCloudWatchMonitoringConfigurationProperty(
        log_group_name="logGroupName",
        log_stream_name_prefix="logStreamNamePrefix"
    ),
    persistent_app_ui="persistentAppUi",
    s3_monitoring_configuration=emrcontainers.CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(
        log_uri="logUri"
    )
)

Attributes

cloud_watch_monitoring_configuration

A configuration for CloudWatch monitoring.

This data type allows job template parameters to be specified within.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricmonitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametricmonitoringconfiguration-cloudwatchmonitoringconfiguration

persistent_app_ui

Monitoring configurations for the persistent application UI, or a template parameter reference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricmonitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametricmonitoringconfiguration-persistentappui

s3_monitoring_configuration

Amazon S3 configuration for monitoring log publishing.

This data type allows job template parameters to be specified within.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametricmonitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametricmonitoringconfiguration-s3monitoringconfiguration

ParametricS3MonitoringConfigurationProperty

class CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(*, log_uri=None)

Bases: object

Amazon S3 configuration for monitoring log publishing.

This data type allows job template parameters to be specified within.

Parameters:

log_uri (Optional[str]) – Amazon S3 destination URI for log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametrics3monitoringconfiguration.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_emrcontainers as emrcontainers

parametric_s3_monitoring_configuration_property = emrcontainers.CfnJobTemplate.ParametricS3MonitoringConfigurationProperty(
    log_uri="logUri"
)

Attributes

log_uri

Amazon S3 destination URI for log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-parametrics3monitoringconfiguration.html#cfn-emrcontainers-jobtemplate-parametrics3monitoringconfiguration-loguri

SparkSqlJobDriverProperty

class CfnJobTemplate.SparkSqlJobDriverProperty(*, entry_point=None, spark_sql_parameters=None)

Bases: object

The job driver for job type.

Parameters:

  • entry_point (Optional[str])

  • spark_sql_parameters (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksqljobdriver.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_emrcontainers as emrcontainers

spark_sql_job_driver_property = emrcontainers.CfnJobTemplate.SparkSqlJobDriverProperty(
    entry_point="entryPoint",
    spark_sql_parameters="sparkSqlParameters"
)

Attributes

entry_point

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksqljobdriver.html#cfn-emrcontainers-jobtemplate-sparksqljobdriver-entrypoint

Type:

see

spark_sql_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksqljobdriver.html#cfn-emrcontainers-jobtemplate-sparksqljobdriver-sparksqlparameters

Type:

see

SparkSubmitJobDriverProperty

class CfnJobTemplate.SparkSubmitJobDriverProperty(*, entry_point, entry_point_arguments=None, spark_submit_parameters=None)

Bases: object

The information about job driver for Spark submit.

Parameters:

  • entry_point (str)

  • entry_point_arguments (Optional[Sequence[str]])

  • spark_submit_parameters (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksubmitjobdriver.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_emrcontainers as emrcontainers

spark_submit_job_driver_property = emrcontainers.CfnJobTemplate.SparkSubmitJobDriverProperty(
    entry_point="entryPoint",

    # the properties below are optional
    entry_point_arguments=["entryPointArguments"],
    spark_submit_parameters="sparkSubmitParameters"
)

Attributes

entry_point

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksubmitjobdriver.html#cfn-emrcontainers-jobtemplate-sparksubmitjobdriver-entrypoint

Type:

see

entry_point_arguments

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksubmitjobdriver.html#cfn-emrcontainers-jobtemplate-sparksubmitjobdriver-entrypointarguments

Type:

see

spark_submit_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-sparksubmitjobdriver.html#cfn-emrcontainers-jobtemplate-sparksubmitjobdriver-sparksubmitparameters

Type:

see

TemplateParameterConfigurationProperty

class CfnJobTemplate.TemplateParameterConfigurationProperty(*, default_value=None, type=None)

Bases: object

The configuration of a job template parameter.

Parameters:

  • default_value (Optional[str]) – The default value for the job template parameter.

  • type (Optional[str]) – The type of the job template parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-templateparameterconfiguration.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_emrcontainers as emrcontainers

template_parameter_configuration_property = emrcontainers.CfnJobTemplate.TemplateParameterConfigurationProperty(
    default_value="defaultValue",
    type="type"
)

Attributes

default_value

The default value for the job template parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-templateparameterconfiguration.html#cfn-emrcontainers-jobtemplate-templateparameterconfiguration-defaultvalue

type

The type of the job template parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-jobtemplate-templateparameterconfiguration.html#cfn-emrcontainers-jobtemplate-templateparameterconfiguration-type