CfnClassifier

class aws_cdk.aws_glue.CfnClassifier(scope, id, *, csv_classifier=None, grok_classifier=None, json_classifier=None, xml_classifier=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Glue::Classifier.

The AWS::Glue::Classifier resource creates an AWS Glue classifier that categorizes data sources and specifies schemas. For more information, see Adding Classifiers to a Crawler and Classifier Structure in the AWS Glue Developer Guide .

CloudformationResource

AWS::Glue::Classifier

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html

ExampleMetadata

fixture=_generated

Example:

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

cfn_classifier = glue.CfnClassifier(self, "MyCfnClassifier",
    csv_classifier=glue.CfnClassifier.CsvClassifierProperty(
        allow_single_column=False,
        contains_header="containsHeader",
        delimiter="delimiter",
        disable_value_trimming=False,
        header=["header"],
        name="name",
        quote_symbol="quoteSymbol"
    ),
    grok_classifier=glue.CfnClassifier.GrokClassifierProperty(
        classification="classification",
        grok_pattern="grokPattern",

        # the properties below are optional
        custom_patterns="customPatterns",
        name="name"
    ),
    json_classifier=glue.CfnClassifier.JsonClassifierProperty(
        json_path="jsonPath",

        # the properties below are optional
        name="name"
    ),
    xml_classifier=glue.CfnClassifier.XMLClassifierProperty(
        classification="classification",
        row_tag="rowTag",

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

Create a new AWS::Glue::Classifier.

Parameters

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate 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).

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

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

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::Glue::Classifier'
cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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.

Return type

List[str]

csv_classifier

A classifier for comma-separated values (CSV).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-csvclassifier

Return type

Union[CsvClassifierProperty, IResolvable, None]

grok_classifier

A classifier that uses grok .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-grokclassifier

Return type

Union[IResolvable, GrokClassifierProperty, None]

json_classifier

A classifier for JSON content.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-jsonclassifier

Return type

Union[IResolvable, JsonClassifierProperty, None]

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

Return type

str

Returns

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

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

xml_classifier

A classifier for XML content.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-xmlclassifier

Return type

Union[IResolvable, XMLClassifierProperty, None]

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

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

CsvClassifierProperty

class CfnClassifier.CsvClassifierProperty(*, allow_single_column=None, contains_header=None, delimiter=None, disable_value_trimming=None, header=None, name=None, quote_symbol=None)

Bases: object

A classifier for custom CSV content.

Parameters
  • allow_single_column (Union[bool, IResolvable, None]) – Enables the processing of files that contain only one column.

  • contains_header (Optional[str]) – Indicates whether the CSV file contains a header.

  • delimiter (Optional[str]) – A custom symbol to denote what separates each column entry in the row.

  • disable_value_trimming (Union[bool, IResolvable, None]) – Specifies not to trim values before identifying the type of column values. The default value is true .

  • header (Optional[Sequence[str]]) – A list of strings representing column names.

  • name (Optional[str]) – The name of the classifier.

  • quote_symbol (Optional[str]) – A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html

ExampleMetadata

fixture=_generated

Example:

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

csv_classifier_property = glue.CfnClassifier.CsvClassifierProperty(
    allow_single_column=False,
    contains_header="containsHeader",
    delimiter="delimiter",
    disable_value_trimming=False,
    header=["header"],
    name="name",
    quote_symbol="quoteSymbol"
)

Attributes

allow_single_column

Enables the processing of files that contain only one column.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-allowsinglecolumn

Return type

Union[bool, IResolvable, None]

contains_header

Indicates whether the CSV file contains a header.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containsheader

Return type

Optional[str]

delimiter

A custom symbol to denote what separates each column entry in the row.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-delimiter

Return type

Optional[str]

disable_value_trimming

Specifies not to trim values before identifying the type of column values.

The default value is true .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-disablevaluetrimming

Return type

Union[bool, IResolvable, None]

header

A list of strings representing column names.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-header

Return type

Optional[List[str]]

name

The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-name

Return type

Optional[str]

quote_symbol

A custom symbol to denote what combines content into a single column value.

It must be different from the column delimiter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-quotesymbol

Return type

Optional[str]

GrokClassifierProperty

class CfnClassifier.GrokClassifierProperty(*, classification, grok_pattern, custom_patterns=None, name=None)

Bases: object

A classifier that uses grok patterns.

Parameters
  • classification (str) – An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

  • grok_pattern (str) – The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers .

  • custom_patterns (Optional[str]) –

    Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers .

  • name (Optional[str]) – The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html

ExampleMetadata

fixture=_generated

Example:

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

grok_classifier_property = glue.CfnClassifier.GrokClassifierProperty(
    classification="classification",
    grok_pattern="grokPattern",

    # the properties below are optional
    custom_patterns="customPatterns",
    name="name"
)

Attributes

classification

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-classification

Return type

str

custom_patterns

Optional custom grok patterns defined by this classifier.

For more information, see custom patterns in Writing Custom Classifiers .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-custompatterns

Return type

Optional[str]

grok_pattern

The grok pattern applied to a data store by this classifier.

For more information, see built-in patterns in Writing Custom Classifiers .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-grokpattern

Return type

str

name

The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-name

Return type

Optional[str]

JsonClassifierProperty

class CfnClassifier.JsonClassifierProperty(*, json_path, name=None)

Bases: object

A classifier for JSON content.

Parameters
  • json_path (str) – A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

  • name (Optional[str]) – The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html

ExampleMetadata

fixture=_generated

Example:

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

json_classifier_property = glue.CfnClassifier.JsonClassifierProperty(
    json_path="jsonPath",

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

Attributes

json_path

A JsonPath string defining the JSON data for the classifier to classify.

AWS Glue supports a subset of JsonPath , as described in Writing JsonPath Custom Classifiers .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-jsonpath

Return type

str

name

The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-name

Return type

Optional[str]

XMLClassifierProperty

class CfnClassifier.XMLClassifierProperty(*, classification, row_tag, name=None)

Bases: object

A classifier for XML content.

Parameters
  • classification (str) – An identifier of the data format that the classifier matches.

  • row_tag (str) – The XML tag designating the element that contains each record in an XML document being parsed. This can’t identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

  • name (Optional[str]) – The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html

ExampleMetadata

fixture=_generated

Example:

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

x_mLClassifier_property = glue.CfnClassifier.XMLClassifierProperty(
    classification="classification",
    row_tag="rowTag",

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

Attributes

classification

An identifier of the data format that the classifier matches.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-classification

Return type

str

name

The name of the classifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-name

Return type

Optional[str]

row_tag

The XML tag designating the element that contains each record in an XML document being parsed.

This can’t identify a self-closing element (closed by /> ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-rowtag

Return type

str