This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-glue

The CDK Construct Library for AWS Glue

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Glue" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Glue --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Glue" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:glue:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="glue" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>glue</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:glue:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='glue', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-glue@0.25.3

package.json:

{
  "@aws-cdk/aws-glue": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-glue@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-glue@0.25.3

package.json:

{
  "@aws-cdk/aws-glue": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-glue@0.25.3

CfnClassifier

class @aws-cdk/aws-glue.CfnClassifier(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnClassifier;
const { CfnClassifier } = require('@aws-cdk/aws-glue');
import { CfnClassifier } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
classifierName
Type:string (readonly)
propertyOverrides
Type:CfnClassifierProps (readonly)
class GrokClassifierProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnClassifier.GrokClassifierProperty;
// CfnClassifier.GrokClassifierProperty is an interface
import { CfnClassifier.GrokClassifierProperty } from '@aws-cdk/aws-glue';
classification

CfnClassifier.GrokClassifierProperty.Classification

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

Type:string
grokPattern

CfnClassifier.GrokClassifierProperty.GrokPattern

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

Type:string
customPatterns

CfnClassifier.GrokClassifierProperty.CustomPatterns

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

Type:string (optional)
name

CfnClassifier.GrokClassifierProperty.Name

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

Type:string (optional)
class JsonClassifierProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnClassifier.JsonClassifierProperty;
// CfnClassifier.JsonClassifierProperty is an interface
import { CfnClassifier.JsonClassifierProperty } from '@aws-cdk/aws-glue';
jsonPath

CfnClassifier.JsonClassifierProperty.JsonPath

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

Type:string
name

CfnClassifier.JsonClassifierProperty.Name

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

Type:string (optional)
class XMLClassifierProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnClassifier.XMLClassifierProperty;
// CfnClassifier.XMLClassifierProperty is an interface
import { CfnClassifier.XMLClassifierProperty } from '@aws-cdk/aws-glue';
classification

CfnClassifier.XMLClassifierProperty.Classification

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

Type:string
rowTag

CfnClassifier.XMLClassifierProperty.RowTag

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

Type:string
name

CfnClassifier.XMLClassifierProperty.Name

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

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnClassifierProps (interface)

class @aws-cdk/aws-glue.CfnClassifierProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnClassifierProps;
// CfnClassifierProps is an interface
import { CfnClassifierProps } from '@aws-cdk/aws-glue';
grokClassifier

AWS::Glue::Classifier.GrokClassifier

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

Type:GrokClassifierProperty or @aws-cdk/cdk.Token (optional)
jsonClassifier

AWS::Glue::Classifier.JsonClassifier

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

Type:@aws-cdk/cdk.Token or JsonClassifierProperty (optional)
xmlClassifier

AWS::Glue::Classifier.XMLClassifier

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

Type:@aws-cdk/cdk.Token or XMLClassifierProperty (optional)

CfnConnection

class @aws-cdk/aws-glue.CfnConnection(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnConnection;
const { CfnConnection } = require('@aws-cdk/aws-glue');
import { CfnConnection } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
connectionName
Type:string (readonly)
propertyOverrides
Type:CfnConnectionProps (readonly)
class ConnectionInputProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnConnection.ConnectionInputProperty;
// CfnConnection.ConnectionInputProperty is an interface
import { CfnConnection.ConnectionInputProperty } from '@aws-cdk/aws-glue';
connectionProperties

CfnConnection.ConnectionInputProperty.ConnectionProperties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties

Type:json or @aws-cdk/cdk.Token
connectionType

CfnConnection.ConnectionInputProperty.ConnectionType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype

Type:string
description

CfnConnection.ConnectionInputProperty.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description

Type:string (optional)
matchCriteria

CfnConnection.ConnectionInputProperty.MatchCriteria

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
name

CfnConnection.ConnectionInputProperty.Name

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

Type:string (optional)
physicalConnectionRequirements

CfnConnection.ConnectionInputProperty.PhysicalConnectionRequirements

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements

Type:@aws-cdk/cdk.Token or PhysicalConnectionRequirementsProperty (optional)
class PhysicalConnectionRequirementsProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnConnection.PhysicalConnectionRequirementsProperty;
// CfnConnection.PhysicalConnectionRequirementsProperty is an interface
import { CfnConnection.PhysicalConnectionRequirementsProperty } from '@aws-cdk/aws-glue';
availabilityZone

CfnConnection.PhysicalConnectionRequirementsProperty.AvailabilityZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-availabilityzone

Type:string (optional)
securityGroupIdList

CfnConnection.PhysicalConnectionRequirementsProperty.SecurityGroupIdList

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-securitygroupidlist

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
subnetId

CfnConnection.PhysicalConnectionRequirementsProperty.SubnetId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-subnetid

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnConnectionProps (interface)

class @aws-cdk/aws-glue.CfnConnectionProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnConnectionProps;
// CfnConnectionProps is an interface
import { CfnConnectionProps } from '@aws-cdk/aws-glue';
catalogId

AWS::Glue::Connection.CatalogId

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

Type:string
connectionInput

AWS::Glue::Connection.ConnectionInput

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

Type:@aws-cdk/cdk.Token or ConnectionInputProperty

CfnCrawler

class @aws-cdk/aws-glue.CfnCrawler(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler;
const { CfnCrawler } = require('@aws-cdk/aws-glue');
import { CfnCrawler } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
crawlerName
Type:string (readonly)
propertyOverrides
Type:CfnCrawlerProps (readonly)
class JdbcTargetProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler.JdbcTargetProperty;
// CfnCrawler.JdbcTargetProperty is an interface
import { CfnCrawler.JdbcTargetProperty } from '@aws-cdk/aws-glue';
connectionName

CfnCrawler.JdbcTargetProperty.ConnectionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname

Type:string (optional)
exclusions

CfnCrawler.JdbcTargetProperty.Exclusions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
path

CfnCrawler.JdbcTargetProperty.Path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path

Type:string (optional)
class S3TargetProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler.S3TargetProperty;
// CfnCrawler.S3TargetProperty is an interface
import { CfnCrawler.S3TargetProperty } from '@aws-cdk/aws-glue';
exclusions

CfnCrawler.S3TargetProperty.Exclusions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
path

CfnCrawler.S3TargetProperty.Path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path

Type:string (optional)
class ScheduleProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler.ScheduleProperty;
// CfnCrawler.ScheduleProperty is an interface
import { CfnCrawler.ScheduleProperty } from '@aws-cdk/aws-glue';
scheduleExpression

CfnCrawler.ScheduleProperty.ScheduleExpression

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html#cfn-glue-crawler-schedule-scheduleexpression

Type:string (optional)
class SchemaChangePolicyProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler.SchemaChangePolicyProperty;
// CfnCrawler.SchemaChangePolicyProperty is an interface
import { CfnCrawler.SchemaChangePolicyProperty } from '@aws-cdk/aws-glue';
deleteBehavior

CfnCrawler.SchemaChangePolicyProperty.DeleteBehavior

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-deletebehavior

Type:string (optional)
updateBehavior

CfnCrawler.SchemaChangePolicyProperty.UpdateBehavior

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-updatebehavior

Type:string (optional)
class TargetsProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawler.TargetsProperty;
// CfnCrawler.TargetsProperty is an interface
import { CfnCrawler.TargetsProperty } from '@aws-cdk/aws-glue';
jdbcTargets

CfnCrawler.TargetsProperty.JdbcTargets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-jdbctargets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or JdbcTargetProperty)[] (optional)
s3Targets

CfnCrawler.TargetsProperty.S3Targets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-s3targets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or S3TargetProperty)[] (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnCrawlerProps (interface)

class @aws-cdk/aws-glue.CfnCrawlerProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnCrawlerProps;
// CfnCrawlerProps is an interface
import { CfnCrawlerProps } from '@aws-cdk/aws-glue';
databaseName

AWS::Glue::Crawler.DatabaseName

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

Type:string
role

AWS::Glue::Crawler.Role

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

Type:string
targets

AWS::Glue::Crawler.Targets

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

Type:@aws-cdk/cdk.Token or TargetsProperty
classifiers

AWS::Glue::Crawler.Classifiers

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
configuration

AWS::Glue::Crawler.Configuration

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

Type:string (optional)
description

AWS::Glue::Crawler.Description

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

Type:string (optional)
name

AWS::Glue::Crawler.Name

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

Type:string (optional)
schedule

AWS::Glue::Crawler.Schedule

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

Type:@aws-cdk/cdk.Token or ScheduleProperty (optional)
schemaChangePolicy

AWS::Glue::Crawler.SchemaChangePolicy

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

Type:@aws-cdk/cdk.Token or SchemaChangePolicyProperty (optional)
tablePrefix

AWS::Glue::Crawler.TablePrefix

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

Type:string (optional)

CfnDatabase

class @aws-cdk/aws-glue.CfnDatabase(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnDatabase;
const { CfnDatabase } = require('@aws-cdk/aws-glue');
import { CfnDatabase } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
databaseName
Type:string (readonly)
propertyOverrides
Type:CfnDatabaseProps (readonly)
class DatabaseInputProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnDatabase.DatabaseInputProperty;
// CfnDatabase.DatabaseInputProperty is an interface
import { CfnDatabase.DatabaseInputProperty } from '@aws-cdk/aws-glue';
description

CfnDatabase.DatabaseInputProperty.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-description

Type:string (optional)
locationUri

CfnDatabase.DatabaseInputProperty.LocationUri

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-locationuri

Type:string (optional)
name

CfnDatabase.DatabaseInputProperty.Name

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

Type:string (optional)
parameters

CfnDatabase.DatabaseInputProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters

Type:json or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDatabaseProps (interface)

class @aws-cdk/aws-glue.CfnDatabaseProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnDatabaseProps;
// CfnDatabaseProps is an interface
import { CfnDatabaseProps } from '@aws-cdk/aws-glue';
catalogId

AWS::Glue::Database.CatalogId

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

Type:string
databaseInput

AWS::Glue::Database.DatabaseInput

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

Type:@aws-cdk/cdk.Token or DatabaseInputProperty

CfnDevEndpoint

class @aws-cdk/aws-glue.CfnDevEndpoint(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnDevEndpoint;
const { CfnDevEndpoint } = require('@aws-cdk/aws-glue');
import { CfnDevEndpoint } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
devEndpointId
Type:string (readonly)
propertyOverrides
Type:CfnDevEndpointProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDevEndpointProps (interface)

class @aws-cdk/aws-glue.CfnDevEndpointProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnDevEndpointProps;
// CfnDevEndpointProps is an interface
import { CfnDevEndpointProps } from '@aws-cdk/aws-glue';
publicKey

AWS::Glue::DevEndpoint.PublicKey

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

Type:string
roleArn

AWS::Glue::DevEndpoint.RoleArn

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

Type:string
endpointName

AWS::Glue::DevEndpoint.EndpointName

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

Type:string (optional)
extraJarsS3Path

AWS::Glue::DevEndpoint.ExtraJarsS3Path

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

Type:string (optional)
extraPythonLibsS3Path

AWS::Glue::DevEndpoint.ExtraPythonLibsS3Path

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

Type:string (optional)
numberOfNodes

AWS::Glue::DevEndpoint.NumberOfNodes

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

Type:number or @aws-cdk/cdk.Token (optional)
securityGroupIds

AWS::Glue::DevEndpoint.SecurityGroupIds

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
subnetId

AWS::Glue::DevEndpoint.SubnetId

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

Type:string (optional)

CfnJob

class @aws-cdk/aws-glue.CfnJob(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnJob;
const { CfnJob } = require('@aws-cdk/aws-glue');
import { CfnJob } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
jobName
Type:string (readonly)
propertyOverrides
Type:CfnJobProps (readonly)
class ConnectionsListProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnJob.ConnectionsListProperty;
// CfnJob.ConnectionsListProperty is an interface
import { CfnJob.ConnectionsListProperty } from '@aws-cdk/aws-glue';
connections

CfnJob.ConnectionsListProperty.Connections

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class ExecutionPropertyProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnJob.ExecutionPropertyProperty;
// CfnJob.ExecutionPropertyProperty is an interface
import { CfnJob.ExecutionPropertyProperty } from '@aws-cdk/aws-glue';
maxConcurrentRuns

CfnJob.ExecutionPropertyProperty.MaxConcurrentRuns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns

Type:number or @aws-cdk/cdk.Token (optional)
class JobCommandProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnJob.JobCommandProperty;
// CfnJob.JobCommandProperty is an interface
import { CfnJob.JobCommandProperty } from '@aws-cdk/aws-glue';
name

CfnJob.JobCommandProperty.Name

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

Type:string (optional)
scriptLocation

CfnJob.JobCommandProperty.ScriptLocation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnJobProps (interface)

class @aws-cdk/aws-glue.CfnJobProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnJobProps;
// CfnJobProps is an interface
import { CfnJobProps } from '@aws-cdk/aws-glue';
command

AWS::Glue::Job.Command

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

Type:@aws-cdk/cdk.Token or JobCommandProperty
role

AWS::Glue::Job.Role

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

Type:string
allocatedCapacity

AWS::Glue::Job.AllocatedCapacity

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

Type:number or @aws-cdk/cdk.Token (optional)
connections

AWS::Glue::Job.Connections

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

Type:@aws-cdk/cdk.Token or ConnectionsListProperty (optional)
defaultArguments

AWS::Glue::Job.DefaultArguments

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

Type:json or @aws-cdk/cdk.Token (optional)
description

AWS::Glue::Job.Description

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

Type:string (optional)
executionProperty

AWS::Glue::Job.ExecutionProperty

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

Type:@aws-cdk/cdk.Token or ExecutionPropertyProperty (optional)
logUri

AWS::Glue::Job.LogUri

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

Type:string (optional)
maxRetries

AWS::Glue::Job.MaxRetries

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

Type:number or @aws-cdk/cdk.Token (optional)
name

AWS::Glue::Job.Name

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

Type:string (optional)

CfnPartition

class @aws-cdk/aws-glue.CfnPartition(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition;
const { CfnPartition } = require('@aws-cdk/aws-glue');
import { CfnPartition } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
partitionId
Type:string (readonly)
propertyOverrides
Type:CfnPartitionProps (readonly)
class ColumnProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.ColumnProperty;
// CfnPartition.ColumnProperty is an interface
import { CfnPartition.ColumnProperty } from '@aws-cdk/aws-glue';
name

CfnPartition.ColumnProperty.Name

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

Type:string
comment

CfnPartition.ColumnProperty.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment

Type:string (optional)
type

CfnPartition.ColumnProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type

Type:string (optional)
class OrderProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.OrderProperty;
// CfnPartition.OrderProperty is an interface
import { CfnPartition.OrderProperty } from '@aws-cdk/aws-glue';
column

CfnPartition.OrderProperty.Column

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column

Type:string
sortOrder

CfnPartition.OrderProperty.SortOrder

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder

Type:number or @aws-cdk/cdk.Token (optional)
class PartitionInputProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.PartitionInputProperty;
// CfnPartition.PartitionInputProperty is an interface
import { CfnPartition.PartitionInputProperty } from '@aws-cdk/aws-glue';
values

CfnPartition.PartitionInputProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
parameters

CfnPartition.PartitionInputProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters

Type:json or @aws-cdk/cdk.Token (optional)
storageDescriptor

CfnPartition.PartitionInputProperty.StorageDescriptor

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor

Type:@aws-cdk/cdk.Token or StorageDescriptorProperty (optional)
class SerdeInfoProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.SerdeInfoProperty;
// CfnPartition.SerdeInfoProperty is an interface
import { CfnPartition.SerdeInfoProperty } from '@aws-cdk/aws-glue';
name

CfnPartition.SerdeInfoProperty.Name

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

Type:string (optional)
parameters

CfnPartition.SerdeInfoProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters

Type:json or @aws-cdk/cdk.Token (optional)
serializationLibrary

CfnPartition.SerdeInfoProperty.SerializationLibrary

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary

Type:string (optional)
class SkewedInfoProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.SkewedInfoProperty;
// CfnPartition.SkewedInfoProperty is an interface
import { CfnPartition.SkewedInfoProperty } from '@aws-cdk/aws-glue';
skewedColumnNames

CfnPartition.SkewedInfoProperty.SkewedColumnNames

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
skewedColumnValueLocationMaps

CfnPartition.SkewedInfoProperty.SkewedColumnValueLocationMaps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps

Type:json or @aws-cdk/cdk.Token (optional)
skewedColumnValues

CfnPartition.SkewedInfoProperty.SkewedColumnValues

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class StorageDescriptorProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartition.StorageDescriptorProperty;
// CfnPartition.StorageDescriptorProperty is an interface
import { CfnPartition.StorageDescriptorProperty } from '@aws-cdk/aws-glue';
bucketColumns

CfnPartition.StorageDescriptorProperty.BucketColumns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-bucketcolumns

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
columns

CfnPartition.StorageDescriptorProperty.Columns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-columns

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ColumnProperty)[] (optional)
compressed

CfnPartition.StorageDescriptorProperty.Compressed

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-compressed

Type:boolean or @aws-cdk/cdk.Token (optional)
inputFormat

CfnPartition.StorageDescriptorProperty.InputFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-inputformat

Type:string (optional)
location

CfnPartition.StorageDescriptorProperty.Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-location

Type:string (optional)
numberOfBuckets

CfnPartition.StorageDescriptorProperty.NumberOfBuckets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-numberofbuckets

Type:number or @aws-cdk/cdk.Token (optional)
outputFormat

CfnPartition.StorageDescriptorProperty.OutputFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-outputformat

Type:string (optional)
parameters

CfnPartition.StorageDescriptorProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-parameters

Type:json or @aws-cdk/cdk.Token (optional)
serdeInfo

CfnPartition.StorageDescriptorProperty.SerdeInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-serdeinfo

Type:@aws-cdk/cdk.Token or SerdeInfoProperty (optional)
skewedInfo

CfnPartition.StorageDescriptorProperty.SkewedInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-skewedinfo

Type:@aws-cdk/cdk.Token or SkewedInfoProperty (optional)
sortColumns

CfnPartition.StorageDescriptorProperty.SortColumns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-sortcolumns

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OrderProperty)[] (optional)
storedAsSubDirectories

CfnPartition.StorageDescriptorProperty.StoredAsSubDirectories

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-storedassubdirectories

Type:boolean or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnPartitionProps (interface)

class @aws-cdk/aws-glue.CfnPartitionProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnPartitionProps;
// CfnPartitionProps is an interface
import { CfnPartitionProps } from '@aws-cdk/aws-glue';
catalogId

AWS::Glue::Partition.CatalogId

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

Type:string
databaseName

AWS::Glue::Partition.DatabaseName

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

Type:string
partitionInput

AWS::Glue::Partition.PartitionInput

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

Type:@aws-cdk/cdk.Token or PartitionInputProperty
tableName

AWS::Glue::Partition.TableName

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

Type:string

CfnTable

class @aws-cdk/aws-glue.CfnTable(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable;
const { CfnTable } = require('@aws-cdk/aws-glue');
import { CfnTable } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnTableProps (readonly)
tableName
Type:string (readonly)
class ColumnProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.ColumnProperty;
// CfnTable.ColumnProperty is an interface
import { CfnTable.ColumnProperty } from '@aws-cdk/aws-glue';
name

CfnTable.ColumnProperty.Name

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

Type:string
comment

CfnTable.ColumnProperty.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment

Type:string (optional)
type

CfnTable.ColumnProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type

Type:string (optional)
class OrderProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.OrderProperty;
// CfnTable.OrderProperty is an interface
import { CfnTable.OrderProperty } from '@aws-cdk/aws-glue';
column

CfnTable.OrderProperty.Column

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column

Type:string
sortOrder

CfnTable.OrderProperty.SortOrder

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder

Type:number or @aws-cdk/cdk.Token
class SerdeInfoProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.SerdeInfoProperty;
// CfnTable.SerdeInfoProperty is an interface
import { CfnTable.SerdeInfoProperty } from '@aws-cdk/aws-glue';
name

CfnTable.SerdeInfoProperty.Name

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

Type:string (optional)
parameters

CfnTable.SerdeInfoProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters

Type:json or @aws-cdk/cdk.Token (optional)
serializationLibrary

CfnTable.SerdeInfoProperty.SerializationLibrary

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary

Type:string (optional)
class SkewedInfoProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.SkewedInfoProperty;
// CfnTable.SkewedInfoProperty is an interface
import { CfnTable.SkewedInfoProperty } from '@aws-cdk/aws-glue';
skewedColumnNames

CfnTable.SkewedInfoProperty.SkewedColumnNames

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
skewedColumnValueLocationMaps

CfnTable.SkewedInfoProperty.SkewedColumnValueLocationMaps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps

Type:json or @aws-cdk/cdk.Token (optional)
skewedColumnValues

CfnTable.SkewedInfoProperty.SkewedColumnValues

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class StorageDescriptorProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.StorageDescriptorProperty;
// CfnTable.StorageDescriptorProperty is an interface
import { CfnTable.StorageDescriptorProperty } from '@aws-cdk/aws-glue';
bucketColumns

CfnTable.StorageDescriptorProperty.BucketColumns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
columns

CfnTable.StorageDescriptorProperty.Columns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ColumnProperty)[] (optional)
compressed

CfnTable.StorageDescriptorProperty.Compressed

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed

Type:boolean or @aws-cdk/cdk.Token (optional)
inputFormat

CfnTable.StorageDescriptorProperty.InputFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat

Type:string (optional)
location

CfnTable.StorageDescriptorProperty.Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location

Type:string (optional)
numberOfBuckets

CfnTable.StorageDescriptorProperty.NumberOfBuckets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets

Type:number or @aws-cdk/cdk.Token (optional)
outputFormat

CfnTable.StorageDescriptorProperty.OutputFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat

Type:string (optional)
parameters

CfnTable.StorageDescriptorProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters

Type:json or @aws-cdk/cdk.Token (optional)
serdeInfo

CfnTable.StorageDescriptorProperty.SerdeInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo

Type:@aws-cdk/cdk.Token or SerdeInfoProperty (optional)
skewedInfo

CfnTable.StorageDescriptorProperty.SkewedInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo

Type:@aws-cdk/cdk.Token or SkewedInfoProperty (optional)
sortColumns

CfnTable.StorageDescriptorProperty.SortColumns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OrderProperty)[] (optional)
storedAsSubDirectories

CfnTable.StorageDescriptorProperty.StoredAsSubDirectories

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories

Type:boolean or @aws-cdk/cdk.Token (optional)
class TableInputProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTable.TableInputProperty;
// CfnTable.TableInputProperty is an interface
import { CfnTable.TableInputProperty } from '@aws-cdk/aws-glue';
description

CfnTable.TableInputProperty.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description

Type:string (optional)
name

CfnTable.TableInputProperty.Name

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

Type:string (optional)
owner

CfnTable.TableInputProperty.Owner

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner

Type:string (optional)
parameters

CfnTable.TableInputProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

Type:json or @aws-cdk/cdk.Token (optional)
partitionKeys

CfnTable.TableInputProperty.PartitionKeys

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ColumnProperty)[] (optional)
retention

CfnTable.TableInputProperty.Retention

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention

Type:number or @aws-cdk/cdk.Token (optional)
storageDescriptor

CfnTable.TableInputProperty.StorageDescriptor

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor

Type:@aws-cdk/cdk.Token or StorageDescriptorProperty (optional)
tableType

CfnTable.TableInputProperty.TableType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype

Type:string (optional)
viewExpandedText

CfnTable.TableInputProperty.ViewExpandedText

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext

Type:string (optional)
viewOriginalText

CfnTable.TableInputProperty.ViewOriginalText

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnTableProps (interface)

class @aws-cdk/aws-glue.CfnTableProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTableProps;
// CfnTableProps is an interface
import { CfnTableProps } from '@aws-cdk/aws-glue';
catalogId

AWS::Glue::Table.CatalogId

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

Type:string
databaseName

AWS::Glue::Table.DatabaseName

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

Type:string
tableInput

AWS::Glue::Table.TableInput

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

Type:@aws-cdk/cdk.Token or TableInputProperty

CfnTrigger

class @aws-cdk/aws-glue.CfnTrigger(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTrigger;
const { CfnTrigger } = require('@aws-cdk/aws-glue');
import { CfnTrigger } from '@aws-cdk/aws-glue';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnTriggerProps (readonly)
triggerName
Type:string (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTrigger.ActionProperty;
// CfnTrigger.ActionProperty is an interface
import { CfnTrigger.ActionProperty } from '@aws-cdk/aws-glue';
arguments

CfnTrigger.ActionProperty.Arguments

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-arguments

Type:json or @aws-cdk/cdk.Token (optional)
jobName

CfnTrigger.ActionProperty.JobName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-jobname

Type:string (optional)
class ConditionProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTrigger.ConditionProperty;
// CfnTrigger.ConditionProperty is an interface
import { CfnTrigger.ConditionProperty } from '@aws-cdk/aws-glue';
jobName

CfnTrigger.ConditionProperty.JobName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-jobname

Type:string (optional)
logicalOperator

CfnTrigger.ConditionProperty.LogicalOperator

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-logicaloperator

Type:string (optional)
state

CfnTrigger.ConditionProperty.State

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-state

Type:string (optional)
class PredicateProperty

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTrigger.PredicateProperty;
// CfnTrigger.PredicateProperty is an interface
import { CfnTrigger.PredicateProperty } from '@aws-cdk/aws-glue';
conditions

CfnTrigger.PredicateProperty.Conditions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-conditions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ConditionProperty)[] (optional)
logical

CfnTrigger.PredicateProperty.Logical

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-logical

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:
  • path (string) – 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.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnTriggerProps (interface)

class @aws-cdk/aws-glue.CfnTriggerProps

Language-specific names:

using Amazon.CDK.AWS.Glue;
import software.amazon.awscdk.services.glue.CfnTriggerProps;
// CfnTriggerProps is an interface
import { CfnTriggerProps } from '@aws-cdk/aws-glue';
actions

AWS::Glue::Trigger.Actions

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActionProperty)[]
type

AWS::Glue::Trigger.Type

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

Type:string
description

AWS::Glue::Trigger.Description

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

Type:string (optional)
name

AWS::Glue::Trigger.Name

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

Type:string (optional)
predicate

AWS::Glue::Trigger.Predicate

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

Type:@aws-cdk/cdk.Token or PredicateProperty (optional)
schedule

AWS::Glue::Trigger.Schedule

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

Type:string (optional)