Class CfnJob
The AWS::Glue::Job
resource specifies an AWS Glue job in the data catalog.
Inherited Members
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJob : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnJob
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Adding Jobs in AWS Glue and Job Structure in the AWS Glue Developer Guide.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html
CloudformationResource: AWS::Glue::Job
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.Glue;
var defaultArguments;
var nonOverridableArguments;
var tags;
var cfnJob = new CfnJob(this, "MyCfnJob", new CfnJobProps {
Command = new JobCommandProperty {
Name = "name",
PythonVersion = "pythonVersion",
Runtime = "runtime",
ScriptLocation = "scriptLocation"
},
Role = "role",
// the properties below are optional
AllocatedCapacity = 123,
Connections = new ConnectionsListProperty {
Connections = new [] { "connections" }
},
DefaultArguments = defaultArguments,
Description = "description",
ExecutionClass = "executionClass",
ExecutionProperty = new ExecutionPropertyProperty {
MaxConcurrentRuns = 123
},
GlueVersion = "glueVersion",
LogUri = "logUri",
MaxCapacity = 123,
MaxRetries = 123,
Name = "name",
NonOverridableArguments = nonOverridableArguments,
NotificationProperty = new NotificationPropertyProperty {
NotifyDelayAfter = 123
},
NumberOfWorkers = 123,
SecurityConfiguration = "securityConfiguration",
Tags = tags,
Timeout = 123,
WorkerType = "workerType"
});
Synopsis
Constructors
CfnJob(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnJob(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnJob(Construct, String, ICfnJobProps) |
Properties
AllocatedCapacity | This parameter is no longer supported. |
AttrId | The ID of this job run. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Command | The code that executes a job. |
Connections | The connections used for this job. |
DefaultArguments | The default arguments for this job, specified as name-value pairs. |
Description | A description of the job. |
ExecutionClass | Indicates whether the job is run with a standard or flexible execution class. |
ExecutionProperty | The maximum number of concurrent runs that are allowed for this job. |
GlueVersion | Glue version determines the versions of Apache Spark and Python that AWS Glue supports. |
LogUri | This field is reserved for future use. |
MaxCapacity | The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. |
MaxRetries | The maximum number of times to retry this job after a JobRun fails. |
Name | The name you assign to this job definition. |
NonOverridableArguments | Non-overridable arguments for this job, specified as name-value pairs. |
NotificationProperty | Specifies configuration properties of a notification. |
NumberOfWorkers | The number of workers of a defined |
Role | The name or Amazon Resource Name (ARN) of the IAM role associated with this job. |
SecurityConfiguration | The name of the |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to use with this job. |
Timeout | The job timeout in minutes. |
WorkerType | The type of predefined worker that is allocated when a job runs. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnJob(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnJob(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnJob(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnJob(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnJob(Construct, String, ICfnJobProps)
public CfnJob(Construct scope, string id, ICfnJobProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnJobProps
Resource properties.
Properties
AllocatedCapacity
This parameter is no longer supported.
public virtual Nullable<double> AllocatedCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Use MaxCapacity
instead.
AttrId
The ID of this job run.
public virtual string AttrId { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Command
The code that executes a job.
public virtual object Command { get; set; }
Property Value
System.Object
Connections
The connections used for this job.
public virtual object Connections { get; set; }
Property Value
System.Object
DefaultArguments
The default arguments for this job, specified as name-value pairs.
public virtual object DefaultArguments { get; set; }
Property Value
System.Object
Description
A description of the job.
public virtual string Description { get; set; }
Property Value
System.String
ExecutionClass
Indicates whether the job is run with a standard or flexible execution class.
public virtual string ExecutionClass { get; set; }
Property Value
System.String
ExecutionProperty
The maximum number of concurrent runs that are allowed for this job.
public virtual object ExecutionProperty { get; set; }
Property Value
System.Object
GlueVersion
Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
public virtual string GlueVersion { get; set; }
Property Value
System.String
LogUri
This field is reserved for future use.
public virtual string LogUri { get; set; }
Property Value
System.String
MaxCapacity
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
public virtual Nullable<double> MaxCapacity { get; set; }
Property Value
System.Nullable<System.Double>
MaxRetries
The maximum number of times to retry this job after a JobRun fails.
public virtual Nullable<double> MaxRetries { get; set; }
Property Value
System.Nullable<System.Double>
Name
The name you assign to this job definition.
public virtual string Name { get; set; }
Property Value
System.String
NonOverridableArguments
Non-overridable arguments for this job, specified as name-value pairs.
public virtual object NonOverridableArguments { get; set; }
Property Value
System.Object
NotificationProperty
Specifies configuration properties of a notification.
public virtual object NotificationProperty { get; set; }
Property Value
System.Object
NumberOfWorkers
The number of workers of a defined workerType
that are allocated when a job runs.
public virtual Nullable<double> NumberOfWorkers { get; set; }
Property Value
System.Nullable<System.Double>
Role
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
public virtual string Role { get; set; }
Property Value
System.String
SecurityConfiguration
The name of the SecurityConfiguration
structure to be used with this job.
public virtual string SecurityConfiguration { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to use with this job.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Timeout
The job timeout in minutes.
public virtual Nullable<double> Timeout { get; set; }
Property Value
System.Nullable<System.Double>
WorkerType
The type of predefined worker that is allocated when a job runs.
public virtual string WorkerType { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>