Class CfnJobTemplate

Represents an Amazon EMR on EKS job template.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnJobTemplate

Implements

IInspectable

IJobTemplateRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EMRContainers

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJobTemplate : CfnResource, IInspectable, IJobTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnJobTemplate Inherits CfnResource Implements IInspectable, IJobTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EMRContainers;

             ConfigurationProperty configurationProperty_;

             var cfnJobTemplate = new CfnJobTemplate(this, "MyCfnJobTemplate", new CfnJobTemplateProps {
                 JobTemplateData = new JobTemplateDataProperty {
                     ExecutionRoleArn = "executionRoleArn",
                     JobDriver = new JobDriverProperty {
                         SparkSqlJobDriver = new SparkSqlJobDriverProperty {
                             EntryPoint = "entryPoint",
                             SparkSqlParameters = "sparkSqlParameters"
                         },
                         SparkSubmitJobDriver = new SparkSubmitJobDriverProperty {
                             EntryPoint = "entryPoint",

                             // the properties below are optional
                             EntryPointArguments = new [] { "entryPointArguments" },
                             SparkSubmitParameters = "sparkSubmitParameters"
                         }
                     },
                     ReleaseLabel = "releaseLabel",

                     // the properties below are optional
                     ConfigurationOverrides = new ParametricConfigurationOverridesProperty {
                         ApplicationConfiguration = new [] { new ConfigurationProperty {
                             Classification = "classification",

                             // the properties below are optional
                             Configurations = new [] { configurationProperty_ },
                             Properties = new Dictionary<string, string> {
                                 { "propertiesKey", "properties" }
                             }
                         } },
                         MonitoringConfiguration = new ParametricMonitoringConfigurationProperty {
                             CloudWatchMonitoringConfiguration = new ParametricCloudWatchMonitoringConfigurationProperty {
                                 LogGroupName = "logGroupName",
                                 LogStreamNamePrefix = "logStreamNamePrefix"
                             },
                             PersistentAppUi = "persistentAppUi",
                             S3MonitoringConfiguration = new ParametricS3MonitoringConfigurationProperty {
                                 LogUri = "logUri"
                             }
                         }
                     },
                     JobTags = new Dictionary<string, string> {
                         { "jobTagsKey", "jobTags" }
                     },
                     ParameterConfiguration = new Dictionary<string, object> {
                         { "parameterConfigurationKey", new TemplateParameterConfigurationProperty {
                             DefaultValue = "defaultValue",
                             Type = "type"
                         } }
                     }
                 },
                 Name = "name",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnJobTemplate(Construct, string, ICfnJobTemplateProps)

Create a new AWS::EMRContainers::JobTemplate.

Properties

AttrArn	The ARN of the job template.
AttrCreatedAt	The date and time when the job template was created.
AttrCreatedBy	The user who created the job template.
AttrId	The ID of the job template.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Represents an Amazon EMR on EKS job template.
CfnPropertyNames	Represents an Amazon EMR on EKS job template.
JobTemplateData	The values of a StartJobRun API request used in job runs started using the job template.
JobTemplateRef	A reference to a JobTemplate resource.
Name	The specified name of the job template.
Tags	The tags that are associated with the job template.

Methods

ArnForJobTemplate(IJobTemplateRef)	Represents an Amazon EMR on EKS job template.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnJobTemplate(object)	Checks whether the given object is a CfnJobTemplate.
RenderProperties(IDictionary<string, object>)	Represents an Amazon EMR on EKS job template.

Constructors

CfnJobTemplate(Construct, string, ICfnJobTemplateProps)

Create a new AWS::EMRContainers::JobTemplate.

public CfnJobTemplate(Construct scope, string id, ICfnJobTemplateProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnJobTemplateProps: Resource properties.

Remarks

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

Properties

AttrArn

The ARN of the job template.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedAt

The date and time when the job template was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrCreatedBy

The user who created the job template.

public virtual string AttrCreatedBy { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedBy

AttrId

The ID of the job template.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

CfnProperties

Represents an Amazon EMR on EKS job template.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CfnPropertyNames

Represents an Amazon EMR on EKS job template.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

JobTemplateData

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

public virtual object JobTemplateData { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobTemplate.IJobTemplateDataProperty

JobTemplateRef

A reference to a JobTemplate resource.

public virtual IJobTemplateReference JobTemplateRef { get; }

Property Value

IJobTemplateReference

Remarks

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

Name

The specified name of the job template.

public virtual string Name { get; set; }

Property Value

string

Remarks

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

Methods

ArnForJobTemplate(IJobTemplateRef)

Represents an Amazon EMR on EKS job template.

public static string ArnForJobTemplate(IJobTemplateRef resource)

Parameters

resource IJobTemplateRef

Returns

string

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EMRContainers;

             ConfigurationProperty configurationProperty_;

             var cfnJobTemplate = new CfnJobTemplate(this, "MyCfnJobTemplate", new CfnJobTemplateProps {
                 JobTemplateData = new JobTemplateDataProperty {
                     ExecutionRoleArn = "executionRoleArn",
                     JobDriver = new JobDriverProperty {
                         SparkSqlJobDriver = new SparkSqlJobDriverProperty {
                             EntryPoint = "entryPoint",
                             SparkSqlParameters = "sparkSqlParameters"
                         },
                         SparkSubmitJobDriver = new SparkSubmitJobDriverProperty {
                             EntryPoint = "entryPoint",

                             // the properties below are optional
                             EntryPointArguments = new [] { "entryPointArguments" },
                             SparkSubmitParameters = "sparkSubmitParameters"
                         }
                     },
                     ReleaseLabel = "releaseLabel",

                     // the properties below are optional
                     ConfigurationOverrides = new ParametricConfigurationOverridesProperty {
                         ApplicationConfiguration = new [] { new ConfigurationProperty {
                             Classification = "classification",

                             // the properties below are optional
                             Configurations = new [] { configurationProperty_ },
                             Properties = new Dictionary<string, string> {
                                 { "propertiesKey", "properties" }
                             }
                         } },
                         MonitoringConfiguration = new ParametricMonitoringConfigurationProperty {
                             CloudWatchMonitoringConfiguration = new ParametricCloudWatchMonitoringConfigurationProperty {
                                 LogGroupName = "logGroupName",
                                 LogStreamNamePrefix = "logStreamNamePrefix"
                             },
                             PersistentAppUi = "persistentAppUi",
                             S3MonitoringConfiguration = new ParametricS3MonitoringConfigurationProperty {
                                 LogUri = "logUri"
                             }
                         }
                     },
                     JobTags = new Dictionary<string, string> {
                         { "jobTagsKey", "jobTags" }
                     },
                     ParameterConfiguration = new Dictionary<string, object> {
                         { "parameterConfigurationKey", new TemplateParameterConfigurationProperty {
                             DefaultValue = "defaultValue",
                             Type = "type"
                         } }
                     }
                 },
                 Name = "name",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

IsCfnJobTemplate(object)

Checks whether the given object is a CfnJobTemplate.

public static bool IsCfnJobTemplate(object x)

Parameters

x object

Returns

bool

Remarks

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

RenderProperties(IDictionary<string, object>)

Represents an Amazon EMR on EKS job template.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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

Implements

IInspectable

IJobTemplateRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2