CfnJobTemplatePropsMixin
- class aws_cdk.cfn_property_mixins.aws_emrcontainers.CfnJobTemplatePropsMixin(props, *, strategy=None)
Bases:
MixinRepresents 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:
- CloudformationResource:
AWS::EMRContainers::JobTemplate
- Mixin:
true
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers import aws_cdk as cdk # configuration_property_: emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty # merge_strategy: cdk.IMergeStrategy cfn_job_template_props_mixin = emrcontainers.CfnJobTemplatePropsMixin(emrcontainers.CfnJobTemplateMixinProps( job_template_data=emrcontainers.CfnJobTemplatePropsMixin.JobTemplateDataProperty( configuration_overrides=emrcontainers.CfnJobTemplatePropsMixin.ParametricConfigurationOverridesProperty( application_configuration=[emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty( classification="classification", configurations=[configuration_property_], properties={ "properties_key": "properties" } )], monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricMonitoringConfigurationProperty( cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricCloudWatchMonitoringConfigurationProperty( log_group_name="logGroupName", log_stream_name_prefix="logStreamNamePrefix" ), persistent_app_ui="persistentAppUi", s3_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricS3MonitoringConfigurationProperty( log_uri="logUri" ) ) ), execution_role_arn="executionRoleArn", job_driver=emrcontainers.CfnJobTemplatePropsMixin.JobDriverProperty( spark_sql_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSqlJobDriverProperty( entry_point="entryPoint", spark_sql_parameters="sparkSqlParameters" ), spark_submit_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSubmitJobDriverProperty( entry_point="entryPoint", entry_point_arguments=["entryPointArguments"], spark_submit_parameters="sparkSubmitParameters" ) ), job_tags={ "job_tags_key": "jobTags" }, parameter_configuration={ "parameter_configuration_key": emrcontainers.CfnJobTemplatePropsMixin.TemplateParameterConfigurationProperty( default_value="defaultValue", type="type" ) }, release_label="releaseLabel" ), name="name", tags=[cdk.CfnTag( key="key", value="value" )] ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::EMRContainers::JobTemplate.- Parameters:
props (
Union[CfnJobTemplateMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['jobTemplateData', 'name', 'tags']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
ConfigurationProperty
- class CfnJobTemplatePropsMixin.ConfigurationProperty(*, classification=None, configurations=None, properties=None)
Bases:
objectA 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 (
Optional[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:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers # configuration_property_: emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty configuration_property = emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty( classification="classification", configurations=[configuration_property_], properties={ "properties_key": "properties" } )
Attributes
- classification
The classification within a configuration.
- configurations
-
- Type:
see
- properties
A set of properties specified within a configuration classification.
JobDriverProperty
- class CfnJobTemplatePropsMixin.JobDriverProperty(*, spark_sql_job_driver=None, spark_submit_job_driver=None)
Bases:
objectSpecify the driver that the job runs on.
Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.
- Parameters:
spark_sql_job_driver (
Union[IResolvable,SparkSqlJobDriverProperty,Dict[str,Any],None]) – The job driver for job type.spark_submit_job_driver (
Union[IResolvable,SparkSubmitJobDriverProperty,Dict[str,Any],None]) – The information about job driver for Spark submit.
- See:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers job_driver_property = emrcontainers.CfnJobTemplatePropsMixin.JobDriverProperty( spark_sql_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSqlJobDriverProperty( entry_point="entryPoint", spark_sql_parameters="sparkSqlParameters" ), spark_submit_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSubmitJobDriverProperty( entry_point="entryPoint", entry_point_arguments=["entryPointArguments"], spark_submit_parameters="sparkSubmitParameters" ) )
Attributes
- spark_sql_job_driver
The job driver for job type.
- spark_submit_job_driver
The information about job driver for Spark submit.
JobTemplateDataProperty
- class CfnJobTemplatePropsMixin.JobTemplateDataProperty(*, configuration_overrides=None, execution_role_arn=None, job_driver=None, job_tags=None, parameter_configuration=None, release_label=None)
Bases:
objectThe values of a StartJobRun API request used in job runs started using the job template.
- Parameters:
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.execution_role_arn (
Optional[str]) – The execution role ARN of the job run, or a template parameter reference.job_driver (
Union[IResolvable,JobDriverProperty,Dict[str,Any],None]) – Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.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.release_label (
Optional[str]) – The release version of Amazon EMR, or a template parameter reference.
- See:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers # configuration_property_: emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty job_template_data_property = emrcontainers.CfnJobTemplatePropsMixin.JobTemplateDataProperty( configuration_overrides=emrcontainers.CfnJobTemplatePropsMixin.ParametricConfigurationOverridesProperty( application_configuration=[emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty( classification="classification", configurations=[configuration_property_], properties={ "properties_key": "properties" } )], monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricMonitoringConfigurationProperty( cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricCloudWatchMonitoringConfigurationProperty( log_group_name="logGroupName", log_stream_name_prefix="logStreamNamePrefix" ), persistent_app_ui="persistentAppUi", s3_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricS3MonitoringConfigurationProperty( log_uri="logUri" ) ) ), execution_role_arn="executionRoleArn", job_driver=emrcontainers.CfnJobTemplatePropsMixin.JobDriverProperty( spark_sql_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSqlJobDriverProperty( entry_point="entryPoint", spark_sql_parameters="sparkSqlParameters" ), spark_submit_job_driver=emrcontainers.CfnJobTemplatePropsMixin.SparkSubmitJobDriverProperty( entry_point="entryPoint", entry_point_arguments=["entryPointArguments"], spark_submit_parameters="sparkSubmitParameters" ) ), job_tags={ "job_tags_key": "jobTags" }, parameter_configuration={ "parameter_configuration_key": emrcontainers.CfnJobTemplatePropsMixin.TemplateParameterConfigurationProperty( default_value="defaultValue", type="type" ) }, release_label="releaseLabel" )
Attributes
- configuration_overrides
A configuration specification to be used to override existing configurations.
This data type allows job template parameters to be specified within.
- execution_role_arn
The execution role ARN of the job run, or a template parameter reference.
- job_driver
Specify the driver that the job runs on.
Exactly one of the two available job drivers is required, either SparkSqlJobDriver or SparkSubmitJobDriver.
- job_tags
The tags assigned to jobs started using the job template.
- parameter_configuration
The configuration of parameters existing in the job template.
- release_label
The release version of Amazon EMR, or a template parameter reference.
ParametricCloudWatchMonitoringConfigurationProperty
- class CfnJobTemplatePropsMixin.ParametricCloudWatchMonitoringConfigurationProperty(*, log_group_name=None, log_stream_name_prefix=None)
Bases:
objectA 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:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers parametric_cloud_watch_monitoring_configuration_property = emrcontainers.CfnJobTemplatePropsMixin.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.
- log_stream_name_prefix
The specified name prefix for log streams.
ParametricConfigurationOverridesProperty
- class CfnJobTemplatePropsMixin.ParametricConfigurationOverridesProperty(*, application_configuration=None, monitoring_configuration=None)
Bases:
objectA configuration specification to be used to override existing configurations.
This data type allows job template parameters to be specified within.
- Parameters:
application_configuration (
Union[IResolvable,Sequence[Union[IResolvable,ConfigurationProperty,Dict[str,Any]]],None])monitoring_configuration (
Union[IResolvable,ParametricMonitoringConfigurationProperty,Dict[str,Any],None]) – Configuration setting for monitoring. This data type allows job template parameters to be specified within.
- See:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers # configuration_property_: emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty parametric_configuration_overrides_property = emrcontainers.CfnJobTemplatePropsMixin.ParametricConfigurationOverridesProperty( application_configuration=[emrcontainers.CfnJobTemplatePropsMixin.ConfigurationProperty( classification="classification", configurations=[configuration_property_], properties={ "properties_key": "properties" } )], monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricMonitoringConfigurationProperty( cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricCloudWatchMonitoringConfigurationProperty( log_group_name="logGroupName", log_stream_name_prefix="logStreamNamePrefix" ), persistent_app_ui="persistentAppUi", s3_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricS3MonitoringConfigurationProperty( log_uri="logUri" ) ) )
Attributes
- application_configuration
-
- Type:
see
- monitoring_configuration
Configuration setting for monitoring.
This data type allows job template parameters to be specified within.
ParametricMonitoringConfigurationProperty
- class CfnJobTemplatePropsMixin.ParametricMonitoringConfigurationProperty(*, cloud_watch_monitoring_configuration=None, persistent_app_ui=None, s3_monitoring_configuration=None)
Bases:
objectConfiguration 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:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers parametric_monitoring_configuration_property = emrcontainers.CfnJobTemplatePropsMixin.ParametricMonitoringConfigurationProperty( cloud_watch_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.ParametricCloudWatchMonitoringConfigurationProperty( log_group_name="logGroupName", log_stream_name_prefix="logStreamNamePrefix" ), persistent_app_ui="persistentAppUi", s3_monitoring_configuration=emrcontainers.CfnJobTemplatePropsMixin.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.
- persistent_app_ui
Monitoring configurations for the persistent application UI, or a template parameter reference.
- s3_monitoring_configuration
Amazon S3 configuration for monitoring log publishing.
This data type allows job template parameters to be specified within.
ParametricS3MonitoringConfigurationProperty
- class CfnJobTemplatePropsMixin.ParametricS3MonitoringConfigurationProperty(*, log_uri=None)
Bases:
objectAmazon 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:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers parametric_s3_monitoring_configuration_property = emrcontainers.CfnJobTemplatePropsMixin.ParametricS3MonitoringConfigurationProperty( log_uri="logUri" )
Attributes
- log_uri
Amazon S3 destination URI for log publishing.
SparkSqlJobDriverProperty
- class CfnJobTemplatePropsMixin.SparkSqlJobDriverProperty(*, entry_point=None, spark_sql_parameters=None)
Bases:
objectThe job driver for job type.
- Parameters:
entry_point (
Optional[str])spark_sql_parameters (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers spark_sql_job_driver_property = emrcontainers.CfnJobTemplatePropsMixin.SparkSqlJobDriverProperty( entry_point="entryPoint", spark_sql_parameters="sparkSqlParameters" )
Attributes
- entry_point
-
- Type:
see
SparkSubmitJobDriverProperty
- class CfnJobTemplatePropsMixin.SparkSubmitJobDriverProperty(*, entry_point=None, entry_point_arguments=None, spark_submit_parameters=None)
Bases:
objectThe information about job driver for Spark submit.
- Parameters:
entry_point (
Optional[str])entry_point_arguments (
Optional[Sequence[str]])spark_submit_parameters (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers spark_submit_job_driver_property = emrcontainers.CfnJobTemplatePropsMixin.SparkSubmitJobDriverProperty( entry_point="entryPoint", entry_point_arguments=["entryPointArguments"], spark_submit_parameters="sparkSubmitParameters" )
Attributes
- entry_point
-
- Type:
see
- entry_point_arguments
-
- Type:
see
TemplateParameterConfigurationProperty
- class CfnJobTemplatePropsMixin.TemplateParameterConfigurationProperty(*, default_value=None, type=None)
Bases:
objectThe 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:
- 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.cfn_property_mixins import aws_emrcontainers as emrcontainers template_parameter_configuration_property = emrcontainers.CfnJobTemplatePropsMixin.TemplateParameterConfigurationProperty( default_value="defaultValue", type="type" )
Attributes
- default_value
The default value for the job template parameter.