Documentation
¶
Index ¶
- func CfnDataset_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataset_IsCfnElement(x interface{}) *bool
- func CfnDataset_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataset_IsConstruct(x interface{}) *bool
- func CfnJob_CFN_RESOURCE_TYPE_NAME() *string
- func CfnJob_IsCfnElement(x interface{}) *bool
- func CfnJob_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnJob_IsConstruct(x interface{}) *bool
- func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProject_IsCfnElement(x interface{}) *bool
- func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnProject_IsConstruct(x interface{}) *bool
- func CfnRecipe_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRecipe_IsCfnElement(x interface{}) *bool
- func CfnRecipe_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRecipe_IsConstruct(x interface{}) *bool
- func CfnRuleset_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRuleset_IsCfnElement(x interface{}) *bool
- func CfnRuleset_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRuleset_IsConstruct(x interface{}) *bool
- func CfnSchedule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchedule_IsCfnElement(x interface{}) *bool
- func CfnSchedule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSchedule_IsConstruct(x interface{}) *bool
- func NewCfnDataset_Override(c CfnDataset, scope awscdk.Construct, id *string, props *CfnDatasetProps)
- func NewCfnJob_Override(c CfnJob, scope awscdk.Construct, id *string, props *CfnJobProps)
- func NewCfnProject_Override(c CfnProject, scope awscdk.Construct, id *string, props *CfnProjectProps)
- func NewCfnRecipe_Override(c CfnRecipe, scope awscdk.Construct, id *string, props *CfnRecipeProps)
- func NewCfnRuleset_Override(c CfnRuleset, scope awscdk.Construct, id *string, props *CfnRulesetProps)
- func NewCfnSchedule_Override(c CfnSchedule, scope awscdk.Construct, id *string, props *CfnScheduleProps)
- type CfnDataset
- type CfnDatasetProps
- type CfnDataset_CsvOptionsProperty
- type CfnDataset_DataCatalogInputDefinitionProperty
- type CfnDataset_DatabaseInputDefinitionProperty
- type CfnDataset_DatasetParameterProperty
- type CfnDataset_DatetimeOptionsProperty
- type CfnDataset_ExcelOptionsProperty
- type CfnDataset_FilesLimitProperty
- type CfnDataset_FilterExpressionProperty
- type CfnDataset_FilterValueProperty
- type CfnDataset_FormatOptionsProperty
- type CfnDataset_InputProperty
- type CfnDataset_JsonOptionsProperty
- type CfnDataset_MetadataProperty
- type CfnDataset_PathOptionsProperty
- type CfnDataset_PathParameterProperty
- type CfnDataset_S3LocationProperty
- type CfnJob
- type CfnJobProps
- type CfnJob_AllowedStatisticsProperty
- type CfnJob_ColumnSelectorProperty
- type CfnJob_ColumnStatisticsConfigurationProperty
- type CfnJob_CsvOutputOptionsProperty
- type CfnJob_DataCatalogOutputProperty
- type CfnJob_DatabaseOutputProperty
- type CfnJob_DatabaseTableOutputOptionsProperty
- type CfnJob_EntityDetectorConfigurationProperty
- type CfnJob_JobSampleProperty
- type CfnJob_OutputFormatOptionsProperty
- type CfnJob_OutputLocationProperty
- type CfnJob_OutputProperty
- type CfnJob_ProfileConfigurationProperty
- type CfnJob_RecipeProperty
- type CfnJob_S3LocationProperty
- type CfnJob_S3TableOutputOptionsProperty
- type CfnJob_StatisticOverrideProperty
- type CfnJob_StatisticsConfigurationProperty
- type CfnJob_ValidationConfigurationProperty
- type CfnProject
- type CfnProjectProps
- type CfnProject_SampleProperty
- type CfnRecipe
- type CfnRecipeProps
- type CfnRecipe_ActionProperty
- type CfnRecipe_ConditionExpressionProperty
- type CfnRecipe_DataCatalogInputDefinitionProperty
- type CfnRecipe_RecipeParametersProperty
- type CfnRecipe_RecipeStepProperty
- type CfnRecipe_S3LocationProperty
- type CfnRecipe_SecondaryInputProperty
- type CfnRuleset
- type CfnRulesetProps
- type CfnRuleset_ColumnSelectorProperty
- type CfnRuleset_RuleProperty
- type CfnRuleset_SubstitutionValueProperty
- type CfnRuleset_ThresholdProperty
- type CfnSchedule
- type CfnScheduleProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDataset_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataset_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataset_IsCfnElement ¶
func CfnDataset_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnDataset_IsCfnResource ¶
func CfnDataset_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataset_IsConstruct ¶
func CfnDataset_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnJob_CFN_RESOURCE_TYPE_NAME ¶
func CfnJob_CFN_RESOURCE_TYPE_NAME() *string
func CfnJob_IsCfnElement ¶
func CfnJob_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnJob_IsCfnResource ¶
func CfnJob_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnJob_IsConstruct ¶
func CfnJob_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnProject_CFN_RESOURCE_TYPE_NAME ¶
func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
func CfnProject_IsCfnElement ¶
func CfnProject_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnProject_IsCfnResource ¶
func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnProject_IsConstruct ¶
func CfnProject_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnRecipe_CFN_RESOURCE_TYPE_NAME ¶
func CfnRecipe_CFN_RESOURCE_TYPE_NAME() *string
func CfnRecipe_IsCfnElement ¶
func CfnRecipe_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnRecipe_IsCfnResource ¶
func CfnRecipe_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRecipe_IsConstruct ¶
func CfnRecipe_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnRuleset_CFN_RESOURCE_TYPE_NAME ¶
func CfnRuleset_CFN_RESOURCE_TYPE_NAME() *string
func CfnRuleset_IsCfnElement ¶
func CfnRuleset_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnRuleset_IsCfnResource ¶
func CfnRuleset_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRuleset_IsConstruct ¶
func CfnRuleset_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSchedule_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchedule_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchedule_IsCfnElement ¶
func CfnSchedule_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnSchedule_IsCfnResource ¶
func CfnSchedule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSchedule_IsConstruct ¶
func CfnSchedule_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDataset_Override ¶
func NewCfnDataset_Override(c CfnDataset, scope awscdk.Construct, id *string, props *CfnDatasetProps)
Create a new `AWS::DataBrew::Dataset`.
func NewCfnJob_Override ¶
func NewCfnJob_Override(c CfnJob, scope awscdk.Construct, id *string, props *CfnJobProps)
Create a new `AWS::DataBrew::Job`.
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope awscdk.Construct, id *string, props *CfnProjectProps)
Create a new `AWS::DataBrew::Project`.
func NewCfnRecipe_Override ¶
func NewCfnRecipe_Override(c CfnRecipe, scope awscdk.Construct, id *string, props *CfnRecipeProps)
Create a new `AWS::DataBrew::Recipe`.
func NewCfnRuleset_Override ¶
func NewCfnRuleset_Override(c CfnRuleset, scope awscdk.Construct, id *string, props *CfnRulesetProps)
Create a new `AWS::DataBrew::Ruleset`.
func NewCfnSchedule_Override ¶
func NewCfnSchedule_Override(c CfnSchedule, scope awscdk.Construct, id *string, props *CfnScheduleProps)
Create a new `AWS::DataBrew::Schedule`.
Types ¶
type CfnDataset ¶
type CfnDataset interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Dataset.Format`.
Format() *string
SetFormat(val *string)
// `AWS::DataBrew::Dataset.FormatOptions`.
FormatOptions() interface{}
SetFormatOptions(val interface{})
// `AWS::DataBrew::Dataset.Input`.
Input() interface{}
SetInput(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Dataset.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::DataBrew::Dataset.PathOptions`.
PathOptions() interface{}
SetPathOptions(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Dataset.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Dataset`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnDataset := databrew.NewCfnDataset(this, jsii.String("MyCfnDataset"), &cfnDatasetProps{
input: &inputProperty{
databaseInputDefinition: &databaseInputDefinitionProperty{
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseTableName: jsii.String("databaseTableName"),
queryString: jsii.String("queryString"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
dataCatalogInputDefinition: &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
metadata: &metadataProperty{
sourceArn: jsii.String("sourceArn"),
},
s3InputDefinition: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
name: jsii.String("name"),
// the properties below are optional
format: jsii.String("format"),
formatOptions: &formatOptionsProperty{
csv: &csvOptionsProperty{
delimiter: jsii.String("delimiter"),
headerRow: jsii.Boolean(false),
},
excel: &excelOptionsProperty{
headerRow: jsii.Boolean(false),
sheetIndexes: []interface{}{
jsii.Number(123),
},
sheetNames: []*string{
jsii.String("sheetNames"),
},
},
json: &jsonOptionsProperty{
multiLine: jsii.Boolean(false),
},
},
pathOptions: &pathOptionsProperty{
filesLimit: &filesLimitProperty{
maxFiles: jsii.Number(123),
// the properties below are optional
order: jsii.String("order"),
orderedBy: jsii.String("orderedBy"),
},
lastModifiedDateCondition: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
parameters: []interface{}{
&pathParameterProperty{
datasetParameter: &datasetParameterProperty{
name: jsii.String("name"),
type: jsii.String("type"),
// the properties below are optional
createColumn: jsii.Boolean(false),
datetimeOptions: &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
},
filter: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
},
pathParameterName: jsii.String("pathParameterName"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnDataset ¶
func NewCfnDataset(scope awscdk.Construct, id *string, props *CfnDatasetProps) CfnDataset
Create a new `AWS::DataBrew::Dataset`.
type CfnDatasetProps ¶
type CfnDatasetProps struct {
// `AWS::DataBrew::Dataset.Input`.
Input interface{} `json:"input" yaml:"input"`
// `AWS::DataBrew::Dataset.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Dataset.Format`.
Format *string `json:"format" yaml:"format"`
// `AWS::DataBrew::Dataset.FormatOptions`.
FormatOptions interface{} `json:"formatOptions" yaml:"formatOptions"`
// `AWS::DataBrew::Dataset.PathOptions`.
PathOptions interface{} `json:"pathOptions" yaml:"pathOptions"`
// `AWS::DataBrew::Dataset.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDataset`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnDatasetProps := &cfnDatasetProps{
input: &inputProperty{
databaseInputDefinition: &databaseInputDefinitionProperty{
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseTableName: jsii.String("databaseTableName"),
queryString: jsii.String("queryString"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
dataCatalogInputDefinition: &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
metadata: &metadataProperty{
sourceArn: jsii.String("sourceArn"),
},
s3InputDefinition: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
name: jsii.String("name"),
// the properties below are optional
format: jsii.String("format"),
formatOptions: &formatOptionsProperty{
csv: &csvOptionsProperty{
delimiter: jsii.String("delimiter"),
headerRow: jsii.Boolean(false),
},
excel: &excelOptionsProperty{
headerRow: jsii.Boolean(false),
sheetIndexes: []interface{}{
jsii.Number(123),
},
sheetNames: []*string{
jsii.String("sheetNames"),
},
},
json: &jsonOptionsProperty{
multiLine: jsii.Boolean(false),
},
},
pathOptions: &pathOptionsProperty{
filesLimit: &filesLimitProperty{
maxFiles: jsii.Number(123),
// the properties below are optional
order: jsii.String("order"),
orderedBy: jsii.String("orderedBy"),
},
lastModifiedDateCondition: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
parameters: []interface{}{
&pathParameterProperty{
datasetParameter: &datasetParameterProperty{
name: jsii.String("name"),
type: jsii.String("type"),
// the properties below are optional
createColumn: jsii.Boolean(false),
datetimeOptions: &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
},
filter: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
},
pathParameterName: jsii.String("pathParameterName"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnDataset_CsvOptionsProperty ¶
type CfnDataset_CsvOptionsProperty struct {
// `CfnDataset.CsvOptionsProperty.Delimiter`.
Delimiter *string `json:"delimiter" yaml:"delimiter"`
// `CfnDataset.CsvOptionsProperty.HeaderRow`.
HeaderRow interface{} `json:"headerRow" yaml:"headerRow"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
csvOptionsProperty := &csvOptionsProperty{
delimiter: jsii.String("delimiter"),
headerRow: jsii.Boolean(false),
}
type CfnDataset_DataCatalogInputDefinitionProperty ¶
type CfnDataset_DataCatalogInputDefinitionProperty struct {
// `CfnDataset.DataCatalogInputDefinitionProperty.CatalogId`.
CatalogId *string `json:"catalogId" yaml:"catalogId"`
// `CfnDataset.DataCatalogInputDefinitionProperty.DatabaseName`.
DatabaseName *string `json:"databaseName" yaml:"databaseName"`
// `CfnDataset.DataCatalogInputDefinitionProperty.TableName`.
TableName *string `json:"tableName" yaml:"tableName"`
// `CfnDataset.DataCatalogInputDefinitionProperty.TempDirectory`.
TempDirectory interface{} `json:"tempDirectory" yaml:"tempDirectory"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
dataCatalogInputDefinitionProperty := &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
}
type CfnDataset_DatabaseInputDefinitionProperty ¶
type CfnDataset_DatabaseInputDefinitionProperty struct {
// `CfnDataset.DatabaseInputDefinitionProperty.GlueConnectionName`.
GlueConnectionName *string `json:"glueConnectionName" yaml:"glueConnectionName"`
// `CfnDataset.DatabaseInputDefinitionProperty.DatabaseTableName`.
DatabaseTableName *string `json:"databaseTableName" yaml:"databaseTableName"`
// `CfnDataset.DatabaseInputDefinitionProperty.QueryString`.
QueryString *string `json:"queryString" yaml:"queryString"`
// `CfnDataset.DatabaseInputDefinitionProperty.TempDirectory`.
TempDirectory interface{} `json:"tempDirectory" yaml:"tempDirectory"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
databaseInputDefinitionProperty := &databaseInputDefinitionProperty{
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseTableName: jsii.String("databaseTableName"),
queryString: jsii.String("queryString"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
}
type CfnDataset_DatasetParameterProperty ¶
type CfnDataset_DatasetParameterProperty struct {
// `CfnDataset.DatasetParameterProperty.Name`.
Name *string `json:"name" yaml:"name"`
// `CfnDataset.DatasetParameterProperty.Type`.
Type *string `json:"type" yaml:"type"`
// `CfnDataset.DatasetParameterProperty.CreateColumn`.
CreateColumn interface{} `json:"createColumn" yaml:"createColumn"`
// `CfnDataset.DatasetParameterProperty.DatetimeOptions`.
DatetimeOptions interface{} `json:"datetimeOptions" yaml:"datetimeOptions"`
// `CfnDataset.DatasetParameterProperty.Filter`.
Filter interface{} `json:"filter" yaml:"filter"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
datasetParameterProperty := &datasetParameterProperty{
name: jsii.String("name"),
type: jsii.String("type"),
// the properties below are optional
createColumn: jsii.Boolean(false),
datetimeOptions: &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
},
filter: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
}
type CfnDataset_DatetimeOptionsProperty ¶
type CfnDataset_DatetimeOptionsProperty struct {
// `CfnDataset.DatetimeOptionsProperty.Format`.
Format *string `json:"format" yaml:"format"`
// `CfnDataset.DatetimeOptionsProperty.LocaleCode`.
LocaleCode *string `json:"localeCode" yaml:"localeCode"`
// `CfnDataset.DatetimeOptionsProperty.TimezoneOffset`.
TimezoneOffset *string `json:"timezoneOffset" yaml:"timezoneOffset"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
datetimeOptionsProperty := &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
}
type CfnDataset_ExcelOptionsProperty ¶
type CfnDataset_ExcelOptionsProperty struct {
// `CfnDataset.ExcelOptionsProperty.HeaderRow`.
HeaderRow interface{} `json:"headerRow" yaml:"headerRow"`
// `CfnDataset.ExcelOptionsProperty.SheetIndexes`.
SheetIndexes interface{} `json:"sheetIndexes" yaml:"sheetIndexes"`
// `CfnDataset.ExcelOptionsProperty.SheetNames`.
SheetNames *[]*string `json:"sheetNames" yaml:"sheetNames"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
excelOptionsProperty := &excelOptionsProperty{
headerRow: jsii.Boolean(false),
sheetIndexes: []interface{}{
jsii.Number(123),
},
sheetNames: []*string{
jsii.String("sheetNames"),
},
}
type CfnDataset_FilesLimitProperty ¶
type CfnDataset_FilesLimitProperty struct {
// `CfnDataset.FilesLimitProperty.MaxFiles`.
MaxFiles *float64 `json:"maxFiles" yaml:"maxFiles"`
// `CfnDataset.FilesLimitProperty.Order`.
Order *string `json:"order" yaml:"order"`
// `CfnDataset.FilesLimitProperty.OrderedBy`.
OrderedBy *string `json:"orderedBy" yaml:"orderedBy"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
filesLimitProperty := &filesLimitProperty{
maxFiles: jsii.Number(123),
// the properties below are optional
order: jsii.String("order"),
orderedBy: jsii.String("orderedBy"),
}
type CfnDataset_FilterExpressionProperty ¶
type CfnDataset_FilterExpressionProperty struct {
// `CfnDataset.FilterExpressionProperty.Expression`.
Expression *string `json:"expression" yaml:"expression"`
// `CfnDataset.FilterExpressionProperty.ValuesMap`.
ValuesMap interface{} `json:"valuesMap" yaml:"valuesMap"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
filterExpressionProperty := &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
}
type CfnDataset_FilterValueProperty ¶
type CfnDataset_FilterValueProperty struct {
// `CfnDataset.FilterValueProperty.Value`.
Value *string `json:"value" yaml:"value"`
// `CfnDataset.FilterValueProperty.ValueReference`.
ValueReference *string `json:"valueReference" yaml:"valueReference"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
filterValueProperty := &filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
}
type CfnDataset_FormatOptionsProperty ¶
type CfnDataset_FormatOptionsProperty struct {
// `CfnDataset.FormatOptionsProperty.Csv`.
Csv interface{} `json:"csv" yaml:"csv"`
// `CfnDataset.FormatOptionsProperty.Excel`.
Excel interface{} `json:"excel" yaml:"excel"`
// `CfnDataset.FormatOptionsProperty.Json`.
Json interface{} `json:"json" yaml:"json"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
formatOptionsProperty := &formatOptionsProperty{
csv: &csvOptionsProperty{
delimiter: jsii.String("delimiter"),
headerRow: jsii.Boolean(false),
},
excel: &excelOptionsProperty{
headerRow: jsii.Boolean(false),
sheetIndexes: []interface{}{
jsii.Number(123),
},
sheetNames: []*string{
jsii.String("sheetNames"),
},
},
json: &jsonOptionsProperty{
multiLine: jsii.Boolean(false),
},
}
type CfnDataset_InputProperty ¶
type CfnDataset_InputProperty struct {
// `CfnDataset.InputProperty.DatabaseInputDefinition`.
DatabaseInputDefinition interface{} `json:"databaseInputDefinition" yaml:"databaseInputDefinition"`
// `CfnDataset.InputProperty.DataCatalogInputDefinition`.
DataCatalogInputDefinition interface{} `json:"dataCatalogInputDefinition" yaml:"dataCatalogInputDefinition"`
// `CfnDataset.InputProperty.Metadata`.
Metadata interface{} `json:"metadata" yaml:"metadata"`
// `CfnDataset.InputProperty.S3InputDefinition`.
S3InputDefinition interface{} `json:"s3InputDefinition" yaml:"s3InputDefinition"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
inputProperty := &inputProperty{
databaseInputDefinition: &databaseInputDefinitionProperty{
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseTableName: jsii.String("databaseTableName"),
queryString: jsii.String("queryString"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
dataCatalogInputDefinition: &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
metadata: &metadataProperty{
sourceArn: jsii.String("sourceArn"),
},
s3InputDefinition: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
}
type CfnDataset_JsonOptionsProperty ¶
type CfnDataset_JsonOptionsProperty struct {
// `CfnDataset.JsonOptionsProperty.MultiLine`.
MultiLine interface{} `json:"multiLine" yaml:"multiLine"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
jsonOptionsProperty := &jsonOptionsProperty{
multiLine: jsii.Boolean(false),
}
type CfnDataset_MetadataProperty ¶
type CfnDataset_MetadataProperty struct {
// `CfnDataset.MetadataProperty.SourceArn`.
SourceArn *string `json:"sourceArn" yaml:"sourceArn"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
metadataProperty := &metadataProperty{
sourceArn: jsii.String("sourceArn"),
}
type CfnDataset_PathOptionsProperty ¶
type CfnDataset_PathOptionsProperty struct {
// `CfnDataset.PathOptionsProperty.FilesLimit`.
FilesLimit interface{} `json:"filesLimit" yaml:"filesLimit"`
// `CfnDataset.PathOptionsProperty.LastModifiedDateCondition`.
LastModifiedDateCondition interface{} `json:"lastModifiedDateCondition" yaml:"lastModifiedDateCondition"`
// `CfnDataset.PathOptionsProperty.Parameters`.
Parameters interface{} `json:"parameters" yaml:"parameters"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
pathOptionsProperty := &pathOptionsProperty{
filesLimit: &filesLimitProperty{
maxFiles: jsii.Number(123),
// the properties below are optional
order: jsii.String("order"),
orderedBy: jsii.String("orderedBy"),
},
lastModifiedDateCondition: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
parameters: []interface{}{
&pathParameterProperty{
datasetParameter: &datasetParameterProperty{
name: jsii.String("name"),
type: jsii.String("type"),
// the properties below are optional
createColumn: jsii.Boolean(false),
datetimeOptions: &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
},
filter: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
},
pathParameterName: jsii.String("pathParameterName"),
},
},
}
type CfnDataset_PathParameterProperty ¶
type CfnDataset_PathParameterProperty struct {
// `CfnDataset.PathParameterProperty.DatasetParameter`.
DatasetParameter interface{} `json:"datasetParameter" yaml:"datasetParameter"`
// `CfnDataset.PathParameterProperty.PathParameterName`.
PathParameterName *string `json:"pathParameterName" yaml:"pathParameterName"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
pathParameterProperty := &pathParameterProperty{
datasetParameter: &datasetParameterProperty{
name: jsii.String("name"),
type: jsii.String("type"),
// the properties below are optional
createColumn: jsii.Boolean(false),
datetimeOptions: &datetimeOptionsProperty{
format: jsii.String("format"),
// the properties below are optional
localeCode: jsii.String("localeCode"),
timezoneOffset: jsii.String("timezoneOffset"),
},
filter: &filterExpressionProperty{
expression: jsii.String("expression"),
valuesMap: []interface{}{
&filterValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
},
},
pathParameterName: jsii.String("pathParameterName"),
}
type CfnDataset_S3LocationProperty ¶
type CfnDataset_S3LocationProperty struct {
// `CfnDataset.S3LocationProperty.Bucket`.
Bucket *string `json:"bucket" yaml:"bucket"`
// `CfnDataset.S3LocationProperty.Key`.
Key *string `json:"key" yaml:"key"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
s3LocationProperty := &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
}
type CfnJob ¶
type CfnJob interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Job.DatabaseOutputs`.
DatabaseOutputs() interface{}
SetDatabaseOutputs(val interface{})
// `AWS::DataBrew::Job.DataCatalogOutputs`.
DataCatalogOutputs() interface{}
SetDataCatalogOutputs(val interface{})
// `AWS::DataBrew::Job.DatasetName`.
DatasetName() *string
SetDatasetName(val *string)
// `AWS::DataBrew::Job.EncryptionKeyArn`.
EncryptionKeyArn() *string
SetEncryptionKeyArn(val *string)
// `AWS::DataBrew::Job.EncryptionMode`.
EncryptionMode() *string
SetEncryptionMode(val *string)
// `AWS::DataBrew::Job.JobSample`.
JobSample() interface{}
SetJobSample(val interface{})
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Job.LogSubscription`.
LogSubscription() *string
SetLogSubscription(val *string)
// `AWS::DataBrew::Job.MaxCapacity`.
MaxCapacity() *float64
SetMaxCapacity(val *float64)
// `AWS::DataBrew::Job.MaxRetries`.
MaxRetries() *float64
SetMaxRetries(val *float64)
// `AWS::DataBrew::Job.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::DataBrew::Job.OutputLocation`.
OutputLocation() interface{}
SetOutputLocation(val interface{})
// `AWS::DataBrew::Job.Outputs`.
Outputs() interface{}
SetOutputs(val interface{})
// `AWS::DataBrew::Job.ProfileConfiguration`.
ProfileConfiguration() interface{}
SetProfileConfiguration(val interface{})
// `AWS::DataBrew::Job.ProjectName`.
ProjectName() *string
SetProjectName(val *string)
// `AWS::DataBrew::Job.Recipe`.
Recipe() interface{}
SetRecipe(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// `AWS::DataBrew::Job.RoleArn`.
RoleArn() *string
SetRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Job.Tags`.
Tags() awscdk.TagManager
// `AWS::DataBrew::Job.Timeout`.
Timeout() *float64
SetTimeout(val *float64)
// `AWS::DataBrew::Job.Type`.
Type() *string
SetType(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// `AWS::DataBrew::Job.ValidationConfigurations`.
ValidationConfigurations() interface{}
SetValidationConfigurations(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Job`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
cfnJob := databrew.NewCfnJob(this, jsii.String("MyCfnJob"), &cfnJobProps{
name: jsii.String("name"),
roleArn: jsii.String("roleArn"),
type: jsii.String("type"),
// the properties below are optional
databaseOutputs: []interface{}{
&databaseOutputProperty{
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseOutputMode: jsii.String("databaseOutputMode"),
},
},
dataCatalogOutputs: []interface{}{
&dataCatalogOutputProperty{
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
// the properties below are optional
catalogId: jsii.String("catalogId"),
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
overwrite: jsii.Boolean(false),
s3Options: &s3TableOutputOptionsProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
},
},
datasetName: jsii.String("datasetName"),
encryptionKeyArn: jsii.String("encryptionKeyArn"),
encryptionMode: jsii.String("encryptionMode"),
jobSample: &jobSampleProperty{
mode: jsii.String("mode"),
size: jsii.Number(123),
},
logSubscription: jsii.String("logSubscription"),
maxCapacity: jsii.Number(123),
maxRetries: jsii.Number(123),
outputLocation: &outputLocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
outputs: []interface{}{
&outputProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
// the properties below are optional
compressionFormat: jsii.String("compressionFormat"),
format: jsii.String("format"),
formatOptions: &outputFormatOptionsProperty{
csv: &csvOutputOptionsProperty{
delimiter: jsii.String("delimiter"),
},
},
maxOutputFiles: jsii.Number(123),
overwrite: jsii.Boolean(false),
partitionColumns: []*string{
jsii.String("partitionColumns"),
},
},
},
profileConfiguration: &profileConfigurationProperty{
columnStatisticsConfigurations: []interface{}{
&columnStatisticsConfigurationProperty{
statistics: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
// the properties below are optional
selectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
},
},
datasetStatisticsConfiguration: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
entityDetectorConfiguration: &entityDetectorConfigurationProperty{
entityTypes: []*string{
jsii.String("entityTypes"),
},
// the properties below are optional
allowedStatistics: &allowedStatisticsProperty{
statistics: []*string{
jsii.String("statistics"),
},
},
},
profileColumns: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
},
projectName: jsii.String("projectName"),
recipe: &recipeProperty{
name: jsii.String("name"),
// the properties below are optional
version: jsii.String("version"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
timeout: jsii.Number(123),
validationConfigurations: []interface{}{
&validationConfigurationProperty{
rulesetArn: jsii.String("rulesetArn"),
// the properties below are optional
validationMode: jsii.String("validationMode"),
},
},
})
type CfnJobProps ¶
type CfnJobProps struct {
// `AWS::DataBrew::Job.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Job.RoleArn`.
RoleArn *string `json:"roleArn" yaml:"roleArn"`
// `AWS::DataBrew::Job.Type`.
Type *string `json:"type" yaml:"type"`
// `AWS::DataBrew::Job.DatabaseOutputs`.
DatabaseOutputs interface{} `json:"databaseOutputs" yaml:"databaseOutputs"`
// `AWS::DataBrew::Job.DataCatalogOutputs`.
DataCatalogOutputs interface{} `json:"dataCatalogOutputs" yaml:"dataCatalogOutputs"`
// `AWS::DataBrew::Job.DatasetName`.
DatasetName *string `json:"datasetName" yaml:"datasetName"`
// `AWS::DataBrew::Job.EncryptionKeyArn`.
EncryptionKeyArn *string `json:"encryptionKeyArn" yaml:"encryptionKeyArn"`
// `AWS::DataBrew::Job.EncryptionMode`.
EncryptionMode *string `json:"encryptionMode" yaml:"encryptionMode"`
// `AWS::DataBrew::Job.JobSample`.
JobSample interface{} `json:"jobSample" yaml:"jobSample"`
// `AWS::DataBrew::Job.LogSubscription`.
LogSubscription *string `json:"logSubscription" yaml:"logSubscription"`
// `AWS::DataBrew::Job.MaxCapacity`.
MaxCapacity *float64 `json:"maxCapacity" yaml:"maxCapacity"`
// `AWS::DataBrew::Job.MaxRetries`.
MaxRetries *float64 `json:"maxRetries" yaml:"maxRetries"`
// `AWS::DataBrew::Job.OutputLocation`.
OutputLocation interface{} `json:"outputLocation" yaml:"outputLocation"`
// `AWS::DataBrew::Job.Outputs`.
Outputs interface{} `json:"outputs" yaml:"outputs"`
// `AWS::DataBrew::Job.ProfileConfiguration`.
ProfileConfiguration interface{} `json:"profileConfiguration" yaml:"profileConfiguration"`
// `AWS::DataBrew::Job.ProjectName`.
ProjectName *string `json:"projectName" yaml:"projectName"`
// `AWS::DataBrew::Job.Recipe`.
Recipe interface{} `json:"recipe" yaml:"recipe"`
// `AWS::DataBrew::Job.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
// `AWS::DataBrew::Job.Timeout`.
Timeout *float64 `json:"timeout" yaml:"timeout"`
// `AWS::DataBrew::Job.ValidationConfigurations`.
ValidationConfigurations interface{} `json:"validationConfigurations" yaml:"validationConfigurations"`
}
Properties for defining a `CfnJob`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
cfnJobProps := &cfnJobProps{
name: jsii.String("name"),
roleArn: jsii.String("roleArn"),
type: jsii.String("type"),
// the properties below are optional
databaseOutputs: []interface{}{
&databaseOutputProperty{
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseOutputMode: jsii.String("databaseOutputMode"),
},
},
dataCatalogOutputs: []interface{}{
&dataCatalogOutputProperty{
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
// the properties below are optional
catalogId: jsii.String("catalogId"),
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
overwrite: jsii.Boolean(false),
s3Options: &s3TableOutputOptionsProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
},
},
datasetName: jsii.String("datasetName"),
encryptionKeyArn: jsii.String("encryptionKeyArn"),
encryptionMode: jsii.String("encryptionMode"),
jobSample: &jobSampleProperty{
mode: jsii.String("mode"),
size: jsii.Number(123),
},
logSubscription: jsii.String("logSubscription"),
maxCapacity: jsii.Number(123),
maxRetries: jsii.Number(123),
outputLocation: &outputLocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
outputs: []interface{}{
&outputProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
// the properties below are optional
compressionFormat: jsii.String("compressionFormat"),
format: jsii.String("format"),
formatOptions: &outputFormatOptionsProperty{
csv: &csvOutputOptionsProperty{
delimiter: jsii.String("delimiter"),
},
},
maxOutputFiles: jsii.Number(123),
overwrite: jsii.Boolean(false),
partitionColumns: []*string{
jsii.String("partitionColumns"),
},
},
},
profileConfiguration: &profileConfigurationProperty{
columnStatisticsConfigurations: []interface{}{
&columnStatisticsConfigurationProperty{
statistics: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
// the properties below are optional
selectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
},
},
datasetStatisticsConfiguration: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
entityDetectorConfiguration: &entityDetectorConfigurationProperty{
entityTypes: []*string{
jsii.String("entityTypes"),
},
// the properties below are optional
allowedStatistics: &allowedStatisticsProperty{
statistics: []*string{
jsii.String("statistics"),
},
},
},
profileColumns: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
},
projectName: jsii.String("projectName"),
recipe: &recipeProperty{
name: jsii.String("name"),
// the properties below are optional
version: jsii.String("version"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
timeout: jsii.Number(123),
validationConfigurations: []interface{}{
&validationConfigurationProperty{
rulesetArn: jsii.String("rulesetArn"),
// the properties below are optional
validationMode: jsii.String("validationMode"),
},
},
}
type CfnJob_AllowedStatisticsProperty ¶
type CfnJob_AllowedStatisticsProperty struct {
// `CfnJob.AllowedStatisticsProperty.Statistics`.
Statistics *[]*string `json:"statistics" yaml:"statistics"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
allowedStatisticsProperty := &allowedStatisticsProperty{
statistics: []*string{
jsii.String("statistics"),
},
}
type CfnJob_ColumnSelectorProperty ¶
type CfnJob_ColumnSelectorProperty struct {
// `CfnJob.ColumnSelectorProperty.Name`.
Name *string `json:"name" yaml:"name"`
// `CfnJob.ColumnSelectorProperty.Regex`.
Regex *string `json:"regex" yaml:"regex"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
columnSelectorProperty := &columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
}
type CfnJob_ColumnStatisticsConfigurationProperty ¶
type CfnJob_ColumnStatisticsConfigurationProperty struct {
// `CfnJob.ColumnStatisticsConfigurationProperty.Statistics`.
Statistics interface{} `json:"statistics" yaml:"statistics"`
// `CfnJob.ColumnStatisticsConfigurationProperty.Selectors`.
Selectors interface{} `json:"selectors" yaml:"selectors"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
columnStatisticsConfigurationProperty := &columnStatisticsConfigurationProperty{
statistics: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
// the properties below are optional
selectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
}
type CfnJob_CsvOutputOptionsProperty ¶
type CfnJob_CsvOutputOptionsProperty struct {
// `CfnJob.CsvOutputOptionsProperty.Delimiter`.
Delimiter *string `json:"delimiter" yaml:"delimiter"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
csvOutputOptionsProperty := &csvOutputOptionsProperty{
delimiter: jsii.String("delimiter"),
}
type CfnJob_DataCatalogOutputProperty ¶
type CfnJob_DataCatalogOutputProperty struct {
// `CfnJob.DataCatalogOutputProperty.DatabaseName`.
DatabaseName *string `json:"databaseName" yaml:"databaseName"`
// `CfnJob.DataCatalogOutputProperty.TableName`.
TableName *string `json:"tableName" yaml:"tableName"`
// `CfnJob.DataCatalogOutputProperty.CatalogId`.
CatalogId *string `json:"catalogId" yaml:"catalogId"`
// `CfnJob.DataCatalogOutputProperty.DatabaseOptions`.
DatabaseOptions interface{} `json:"databaseOptions" yaml:"databaseOptions"`
// `CfnJob.DataCatalogOutputProperty.Overwrite`.
Overwrite interface{} `json:"overwrite" yaml:"overwrite"`
// `CfnJob.DataCatalogOutputProperty.S3Options`.
S3Options interface{} `json:"s3Options" yaml:"s3Options"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
dataCatalogOutputProperty := &dataCatalogOutputProperty{
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
// the properties below are optional
catalogId: jsii.String("catalogId"),
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
overwrite: jsii.Boolean(false),
s3Options: &s3TableOutputOptionsProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
}
type CfnJob_DatabaseOutputProperty ¶
type CfnJob_DatabaseOutputProperty struct {
// `CfnJob.DatabaseOutputProperty.DatabaseOptions`.
DatabaseOptions interface{} `json:"databaseOptions" yaml:"databaseOptions"`
// `CfnJob.DatabaseOutputProperty.GlueConnectionName`.
GlueConnectionName *string `json:"glueConnectionName" yaml:"glueConnectionName"`
// `CfnJob.DatabaseOutputProperty.DatabaseOutputMode`.
DatabaseOutputMode *string `json:"databaseOutputMode" yaml:"databaseOutputMode"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
databaseOutputProperty := &databaseOutputProperty{
databaseOptions: &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
},
glueConnectionName: jsii.String("glueConnectionName"),
// the properties below are optional
databaseOutputMode: jsii.String("databaseOutputMode"),
}
type CfnJob_DatabaseTableOutputOptionsProperty ¶
type CfnJob_DatabaseTableOutputOptionsProperty struct {
// `CfnJob.DatabaseTableOutputOptionsProperty.TableName`.
TableName *string `json:"tableName" yaml:"tableName"`
// `CfnJob.DatabaseTableOutputOptionsProperty.TempDirectory`.
TempDirectory interface{} `json:"tempDirectory" yaml:"tempDirectory"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
databaseTableOutputOptionsProperty := &databaseTableOutputOptionsProperty{
tableName: jsii.String("tableName"),
// the properties below are optional
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
}
type CfnJob_EntityDetectorConfigurationProperty ¶
type CfnJob_EntityDetectorConfigurationProperty struct {
// `CfnJob.EntityDetectorConfigurationProperty.EntityTypes`.
EntityTypes *[]*string `json:"entityTypes" yaml:"entityTypes"`
// `CfnJob.EntityDetectorConfigurationProperty.AllowedStatistics`.
AllowedStatistics interface{} `json:"allowedStatistics" yaml:"allowedStatistics"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
entityDetectorConfigurationProperty := &entityDetectorConfigurationProperty{
entityTypes: []*string{
jsii.String("entityTypes"),
},
// the properties below are optional
allowedStatistics: &allowedStatisticsProperty{
statistics: []*string{
jsii.String("statistics"),
},
},
}
type CfnJob_JobSampleProperty ¶
type CfnJob_JobSampleProperty struct {
// `CfnJob.JobSampleProperty.Mode`.
Mode *string `json:"mode" yaml:"mode"`
// `CfnJob.JobSampleProperty.Size`.
Size *float64 `json:"size" yaml:"size"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
jobSampleProperty := &jobSampleProperty{
mode: jsii.String("mode"),
size: jsii.Number(123),
}
type CfnJob_OutputFormatOptionsProperty ¶
type CfnJob_OutputFormatOptionsProperty struct {
// `CfnJob.OutputFormatOptionsProperty.Csv`.
Csv interface{} `json:"csv" yaml:"csv"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
outputFormatOptionsProperty := &outputFormatOptionsProperty{
csv: &csvOutputOptionsProperty{
delimiter: jsii.String("delimiter"),
},
}
type CfnJob_OutputLocationProperty ¶
type CfnJob_OutputLocationProperty struct {
// `CfnJob.OutputLocationProperty.Bucket`.
Bucket *string `json:"bucket" yaml:"bucket"`
// `CfnJob.OutputLocationProperty.BucketOwner`.
BucketOwner *string `json:"bucketOwner" yaml:"bucketOwner"`
// `CfnJob.OutputLocationProperty.Key`.
Key *string `json:"key" yaml:"key"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
outputLocationProperty := &outputLocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
}
type CfnJob_OutputProperty ¶
type CfnJob_OutputProperty struct {
// `CfnJob.OutputProperty.Location`.
Location interface{} `json:"location" yaml:"location"`
// `CfnJob.OutputProperty.CompressionFormat`.
CompressionFormat *string `json:"compressionFormat" yaml:"compressionFormat"`
// `CfnJob.OutputProperty.Format`.
Format *string `json:"format" yaml:"format"`
// `CfnJob.OutputProperty.FormatOptions`.
FormatOptions interface{} `json:"formatOptions" yaml:"formatOptions"`
// `CfnJob.OutputProperty.MaxOutputFiles`.
MaxOutputFiles *float64 `json:"maxOutputFiles" yaml:"maxOutputFiles"`
// `CfnJob.OutputProperty.Overwrite`.
Overwrite interface{} `json:"overwrite" yaml:"overwrite"`
// `CfnJob.OutputProperty.PartitionColumns`.
PartitionColumns *[]*string `json:"partitionColumns" yaml:"partitionColumns"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
outputProperty := &outputProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
// the properties below are optional
compressionFormat: jsii.String("compressionFormat"),
format: jsii.String("format"),
formatOptions: &outputFormatOptionsProperty{
csv: &csvOutputOptionsProperty{
delimiter: jsii.String("delimiter"),
},
},
maxOutputFiles: jsii.Number(123),
overwrite: jsii.Boolean(false),
partitionColumns: []*string{
jsii.String("partitionColumns"),
},
}
type CfnJob_ProfileConfigurationProperty ¶
type CfnJob_ProfileConfigurationProperty struct {
// `CfnJob.ProfileConfigurationProperty.ColumnStatisticsConfigurations`.
ColumnStatisticsConfigurations interface{} `json:"columnStatisticsConfigurations" yaml:"columnStatisticsConfigurations"`
// `CfnJob.ProfileConfigurationProperty.DatasetStatisticsConfiguration`.
DatasetStatisticsConfiguration interface{} `json:"datasetStatisticsConfiguration" yaml:"datasetStatisticsConfiguration"`
// `CfnJob.ProfileConfigurationProperty.EntityDetectorConfiguration`.
EntityDetectorConfiguration interface{} `json:"entityDetectorConfiguration" yaml:"entityDetectorConfiguration"`
// `CfnJob.ProfileConfigurationProperty.ProfileColumns`.
ProfileColumns interface{} `json:"profileColumns" yaml:"profileColumns"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
profileConfigurationProperty := &profileConfigurationProperty{
columnStatisticsConfigurations: []interface{}{
&columnStatisticsConfigurationProperty{
statistics: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
// the properties below are optional
selectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
},
},
datasetStatisticsConfiguration: &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
},
entityDetectorConfiguration: &entityDetectorConfigurationProperty{
entityTypes: []*string{
jsii.String("entityTypes"),
},
// the properties below are optional
allowedStatistics: &allowedStatisticsProperty{
statistics: []*string{
jsii.String("statistics"),
},
},
},
profileColumns: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
}
type CfnJob_RecipeProperty ¶
type CfnJob_RecipeProperty struct {
// `CfnJob.RecipeProperty.Name`.
Name *string `json:"name" yaml:"name"`
// `CfnJob.RecipeProperty.Version`.
Version *string `json:"version" yaml:"version"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
recipeProperty := &recipeProperty{
name: jsii.String("name"),
// the properties below are optional
version: jsii.String("version"),
}
type CfnJob_S3LocationProperty ¶
type CfnJob_S3LocationProperty struct {
// `CfnJob.S3LocationProperty.Bucket`.
Bucket *string `json:"bucket" yaml:"bucket"`
// `CfnJob.S3LocationProperty.BucketOwner`.
BucketOwner *string `json:"bucketOwner" yaml:"bucketOwner"`
// `CfnJob.S3LocationProperty.Key`.
Key *string `json:"key" yaml:"key"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
s3LocationProperty := &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
}
type CfnJob_S3TableOutputOptionsProperty ¶
type CfnJob_S3TableOutputOptionsProperty struct {
// `CfnJob.S3TableOutputOptionsProperty.Location`.
Location interface{} `json:"location" yaml:"location"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
s3TableOutputOptionsProperty := &s3TableOutputOptionsProperty{
location: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
bucketOwner: jsii.String("bucketOwner"),
key: jsii.String("key"),
},
}
type CfnJob_StatisticOverrideProperty ¶
type CfnJob_StatisticOverrideProperty struct {
// `CfnJob.StatisticOverrideProperty.Parameters`.
Parameters interface{} `json:"parameters" yaml:"parameters"`
// `CfnJob.StatisticOverrideProperty.Statistic`.
Statistic *string `json:"statistic" yaml:"statistic"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
statisticOverrideProperty := &statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
}
type CfnJob_StatisticsConfigurationProperty ¶
type CfnJob_StatisticsConfigurationProperty struct {
// `CfnJob.StatisticsConfigurationProperty.IncludedStatistics`.
IncludedStatistics *[]*string `json:"includedStatistics" yaml:"includedStatistics"`
// `CfnJob.StatisticsConfigurationProperty.Overrides`.
Overrides interface{} `json:"overrides" yaml:"overrides"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var parameters interface{}
statisticsConfigurationProperty := &statisticsConfigurationProperty{
includedStatistics: []*string{
jsii.String("includedStatistics"),
},
overrides: []interface{}{
&statisticOverrideProperty{
parameters: parameters,
statistic: jsii.String("statistic"),
},
},
}
type CfnJob_ValidationConfigurationProperty ¶
type CfnJob_ValidationConfigurationProperty struct {
// `CfnJob.ValidationConfigurationProperty.RulesetArn`.
RulesetArn *string `json:"rulesetArn" yaml:"rulesetArn"`
// `CfnJob.ValidationConfigurationProperty.ValidationMode`.
ValidationMode *string `json:"validationMode" yaml:"validationMode"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
validationConfigurationProperty := &validationConfigurationProperty{
rulesetArn: jsii.String("rulesetArn"),
// the properties below are optional
validationMode: jsii.String("validationMode"),
}
type CfnProject ¶
type CfnProject interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Project.DatasetName`.
DatasetName() *string
SetDatasetName(val *string)
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Project.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::DataBrew::Project.RecipeName`.
RecipeName() *string
SetRecipeName(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// `AWS::DataBrew::Project.RoleArn`.
RoleArn() *string
SetRoleArn(val *string)
// `AWS::DataBrew::Project.Sample`.
Sample() interface{}
SetSample(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Project.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Project`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnProject := databrew.NewCfnProject(this, jsii.String("MyCfnProject"), &cfnProjectProps{
datasetName: jsii.String("datasetName"),
name: jsii.String("name"),
recipeName: jsii.String("recipeName"),
roleArn: jsii.String("roleArn"),
// the properties below are optional
sample: &sampleProperty{
type: jsii.String("type"),
// the properties below are optional
size: jsii.Number(123),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnProject ¶
func NewCfnProject(scope awscdk.Construct, id *string, props *CfnProjectProps) CfnProject
Create a new `AWS::DataBrew::Project`.
type CfnProjectProps ¶
type CfnProjectProps struct {
// `AWS::DataBrew::Project.DatasetName`.
DatasetName *string `json:"datasetName" yaml:"datasetName"`
// `AWS::DataBrew::Project.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Project.RecipeName`.
RecipeName *string `json:"recipeName" yaml:"recipeName"`
// `AWS::DataBrew::Project.RoleArn`.
RoleArn *string `json:"roleArn" yaml:"roleArn"`
// `AWS::DataBrew::Project.Sample`.
Sample interface{} `json:"sample" yaml:"sample"`
// `AWS::DataBrew::Project.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnProject`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnProjectProps := &cfnProjectProps{
datasetName: jsii.String("datasetName"),
name: jsii.String("name"),
recipeName: jsii.String("recipeName"),
roleArn: jsii.String("roleArn"),
// the properties below are optional
sample: &sampleProperty{
type: jsii.String("type"),
// the properties below are optional
size: jsii.Number(123),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnProject_SampleProperty ¶
type CfnProject_SampleProperty struct {
// `CfnProject.SampleProperty.Type`.
Type *string `json:"type" yaml:"type"`
// `CfnProject.SampleProperty.Size`.
Size *float64 `json:"size" yaml:"size"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
sampleProperty := &sampleProperty{
type: jsii.String("type"),
// the properties below are optional
size: jsii.Number(123),
}
type CfnRecipe ¶
type CfnRecipe interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Recipe.Description`.
Description() *string
SetDescription(val *string)
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Recipe.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Recipe.Steps`.
Steps() interface{}
SetSteps(val interface{})
// `AWS::DataBrew::Recipe.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Recipe`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnRecipe := databrew.NewCfnRecipe(this, jsii.String("MyCfnRecipe"), &cfnRecipeProps{
name: jsii.String("name"),
steps: []interface{}{
&recipeStepProperty{
action: &actionProperty{
operation: jsii.String("operation"),
// the properties below are optional
parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
},
// the properties below are optional
conditionExpressions: []interface{}{
&conditionExpressionProperty{
condition: jsii.String("condition"),
targetColumn: jsii.String("targetColumn"),
// the properties below are optional
value: jsii.String("value"),
},
},
},
},
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnRecipe ¶
func NewCfnRecipe(scope awscdk.Construct, id *string, props *CfnRecipeProps) CfnRecipe
Create a new `AWS::DataBrew::Recipe`.
type CfnRecipeProps ¶
type CfnRecipeProps struct {
// `AWS::DataBrew::Recipe.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Recipe.Steps`.
Steps interface{} `json:"steps" yaml:"steps"`
// `AWS::DataBrew::Recipe.Description`.
Description *string `json:"description" yaml:"description"`
// `AWS::DataBrew::Recipe.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRecipe`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnRecipeProps := &cfnRecipeProps{
name: jsii.String("name"),
steps: []interface{}{
&recipeStepProperty{
action: &actionProperty{
operation: jsii.String("operation"),
// the properties below are optional
parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
},
// the properties below are optional
conditionExpressions: []interface{}{
&conditionExpressionProperty{
condition: jsii.String("condition"),
targetColumn: jsii.String("targetColumn"),
// the properties below are optional
value: jsii.String("value"),
},
},
},
},
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnRecipe_ActionProperty ¶
type CfnRecipe_ActionProperty struct {
// `CfnRecipe.ActionProperty.Operation`.
Operation *string `json:"operation" yaml:"operation"`
// `CfnRecipe.ActionProperty.Parameters`.
Parameters interface{} `json:"parameters" yaml:"parameters"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
actionProperty := &actionProperty{
operation: jsii.String("operation"),
// the properties below are optional
parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
}
type CfnRecipe_ConditionExpressionProperty ¶
type CfnRecipe_ConditionExpressionProperty struct {
// `CfnRecipe.ConditionExpressionProperty.Condition`.
Condition *string `json:"condition" yaml:"condition"`
// `CfnRecipe.ConditionExpressionProperty.TargetColumn`.
TargetColumn *string `json:"targetColumn" yaml:"targetColumn"`
// `CfnRecipe.ConditionExpressionProperty.Value`.
Value *string `json:"value" yaml:"value"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
conditionExpressionProperty := &conditionExpressionProperty{
condition: jsii.String("condition"),
targetColumn: jsii.String("targetColumn"),
// the properties below are optional
value: jsii.String("value"),
}
type CfnRecipe_DataCatalogInputDefinitionProperty ¶
type CfnRecipe_DataCatalogInputDefinitionProperty struct {
// `CfnRecipe.DataCatalogInputDefinitionProperty.CatalogId`.
CatalogId *string `json:"catalogId" yaml:"catalogId"`
// `CfnRecipe.DataCatalogInputDefinitionProperty.DatabaseName`.
DatabaseName *string `json:"databaseName" yaml:"databaseName"`
// `CfnRecipe.DataCatalogInputDefinitionProperty.TableName`.
TableName *string `json:"tableName" yaml:"tableName"`
// `CfnRecipe.DataCatalogInputDefinitionProperty.TempDirectory`.
TempDirectory interface{} `json:"tempDirectory" yaml:"tempDirectory"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
dataCatalogInputDefinitionProperty := &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
}
type CfnRecipe_RecipeParametersProperty ¶
type CfnRecipe_RecipeParametersProperty struct {
// `CfnRecipe.RecipeParametersProperty.AggregateFunction`.
AggregateFunction *string `json:"aggregateFunction" yaml:"aggregateFunction"`
// `CfnRecipe.RecipeParametersProperty.Base`.
Base *string `json:"base" yaml:"base"`
// `CfnRecipe.RecipeParametersProperty.CaseStatement`.
CaseStatement *string `json:"caseStatement" yaml:"caseStatement"`
// `CfnRecipe.RecipeParametersProperty.CategoryMap`.
CategoryMap *string `json:"categoryMap" yaml:"categoryMap"`
// `CfnRecipe.RecipeParametersProperty.CharsToRemove`.
CharsToRemove *string `json:"charsToRemove" yaml:"charsToRemove"`
// `CfnRecipe.RecipeParametersProperty.CollapseConsecutiveWhitespace`.
CollapseConsecutiveWhitespace *string `json:"collapseConsecutiveWhitespace" yaml:"collapseConsecutiveWhitespace"`
// `CfnRecipe.RecipeParametersProperty.ColumnDataType`.
ColumnDataType *string `json:"columnDataType" yaml:"columnDataType"`
// `CfnRecipe.RecipeParametersProperty.ColumnRange`.
ColumnRange *string `json:"columnRange" yaml:"columnRange"`
// `CfnRecipe.RecipeParametersProperty.Count`.
Count *string `json:"count" yaml:"count"`
// `CfnRecipe.RecipeParametersProperty.CustomCharacters`.
CustomCharacters *string `json:"customCharacters" yaml:"customCharacters"`
// `CfnRecipe.RecipeParametersProperty.CustomStopWords`.
CustomStopWords *string `json:"customStopWords" yaml:"customStopWords"`
// `CfnRecipe.RecipeParametersProperty.CustomValue`.
CustomValue *string `json:"customValue" yaml:"customValue"`
// `CfnRecipe.RecipeParametersProperty.DatasetsColumns`.
DatasetsColumns *string `json:"datasetsColumns" yaml:"datasetsColumns"`
// `CfnRecipe.RecipeParametersProperty.DateAddValue`.
DateAddValue *string `json:"dateAddValue" yaml:"dateAddValue"`
// `CfnRecipe.RecipeParametersProperty.DateTimeFormat`.
DateTimeFormat *string `json:"dateTimeFormat" yaml:"dateTimeFormat"`
// `CfnRecipe.RecipeParametersProperty.DateTimeParameters`.
DateTimeParameters *string `json:"dateTimeParameters" yaml:"dateTimeParameters"`
// `CfnRecipe.RecipeParametersProperty.DeleteOtherRows`.
DeleteOtherRows *string `json:"deleteOtherRows" yaml:"deleteOtherRows"`
// `CfnRecipe.RecipeParametersProperty.Delimiter`.
Delimiter *string `json:"delimiter" yaml:"delimiter"`
// `CfnRecipe.RecipeParametersProperty.EndPattern`.
EndPattern *string `json:"endPattern" yaml:"endPattern"`
// `CfnRecipe.RecipeParametersProperty.EndPosition`.
EndPosition *string `json:"endPosition" yaml:"endPosition"`
// `CfnRecipe.RecipeParametersProperty.EndValue`.
EndValue *string `json:"endValue" yaml:"endValue"`
// `CfnRecipe.RecipeParametersProperty.ExpandContractions`.
ExpandContractions *string `json:"expandContractions" yaml:"expandContractions"`
// `CfnRecipe.RecipeParametersProperty.Exponent`.
Exponent *string `json:"exponent" yaml:"exponent"`
// `CfnRecipe.RecipeParametersProperty.FalseString`.
FalseString *string `json:"falseString" yaml:"falseString"`
// `CfnRecipe.RecipeParametersProperty.GroupByAggFunctionOptions`.
GroupByAggFunctionOptions *string `json:"groupByAggFunctionOptions" yaml:"groupByAggFunctionOptions"`
// `CfnRecipe.RecipeParametersProperty.GroupByColumns`.
GroupByColumns *string `json:"groupByColumns" yaml:"groupByColumns"`
// `CfnRecipe.RecipeParametersProperty.HiddenColumns`.
HiddenColumns *string `json:"hiddenColumns" yaml:"hiddenColumns"`
// `CfnRecipe.RecipeParametersProperty.IgnoreCase`.
IgnoreCase *string `json:"ignoreCase" yaml:"ignoreCase"`
// `CfnRecipe.RecipeParametersProperty.IncludeInSplit`.
IncludeInSplit *string `json:"includeInSplit" yaml:"includeInSplit"`
// `CfnRecipe.RecipeParametersProperty.Input`.
Input interface{} `json:"input" yaml:"input"`
// `CfnRecipe.RecipeParametersProperty.Interval`.
Interval *string `json:"interval" yaml:"interval"`
// `CfnRecipe.RecipeParametersProperty.IsText`.
IsText *string `json:"isText" yaml:"isText"`
// `CfnRecipe.RecipeParametersProperty.JoinKeys`.
JoinKeys *string `json:"joinKeys" yaml:"joinKeys"`
// `CfnRecipe.RecipeParametersProperty.JoinType`.
JoinType *string `json:"joinType" yaml:"joinType"`
// `CfnRecipe.RecipeParametersProperty.LeftColumns`.
LeftColumns *string `json:"leftColumns" yaml:"leftColumns"`
// `CfnRecipe.RecipeParametersProperty.Limit`.
Limit *string `json:"limit" yaml:"limit"`
// `CfnRecipe.RecipeParametersProperty.LowerBound`.
LowerBound *string `json:"lowerBound" yaml:"lowerBound"`
// `CfnRecipe.RecipeParametersProperty.MapType`.
MapType *string `json:"mapType" yaml:"mapType"`
// `CfnRecipe.RecipeParametersProperty.ModeType`.
ModeType *string `json:"modeType" yaml:"modeType"`
// `CfnRecipe.RecipeParametersProperty.MultiLine`.
MultiLine interface{} `json:"multiLine" yaml:"multiLine"`
// `CfnRecipe.RecipeParametersProperty.NumRows`.
NumRows *string `json:"numRows" yaml:"numRows"`
// `CfnRecipe.RecipeParametersProperty.NumRowsAfter`.
NumRowsAfter *string `json:"numRowsAfter" yaml:"numRowsAfter"`
// `CfnRecipe.RecipeParametersProperty.NumRowsBefore`.
NumRowsBefore *string `json:"numRowsBefore" yaml:"numRowsBefore"`
// `CfnRecipe.RecipeParametersProperty.OrderByColumn`.
OrderByColumn *string `json:"orderByColumn" yaml:"orderByColumn"`
// `CfnRecipe.RecipeParametersProperty.OrderByColumns`.
OrderByColumns *string `json:"orderByColumns" yaml:"orderByColumns"`
// `CfnRecipe.RecipeParametersProperty.Other`.
Other *string `json:"other" yaml:"other"`
// `CfnRecipe.RecipeParametersProperty.Pattern`.
Pattern *string `json:"pattern" yaml:"pattern"`
// `CfnRecipe.RecipeParametersProperty.PatternOption1`.
PatternOption1 *string `json:"patternOption1" yaml:"patternOption1"`
// `CfnRecipe.RecipeParametersProperty.PatternOption2`.
PatternOption2 *string `json:"patternOption2" yaml:"patternOption2"`
// `CfnRecipe.RecipeParametersProperty.PatternOptions`.
PatternOptions *string `json:"patternOptions" yaml:"patternOptions"`
// `CfnRecipe.RecipeParametersProperty.Period`.
Period *string `json:"period" yaml:"period"`
// `CfnRecipe.RecipeParametersProperty.Position`.
Position *string `json:"position" yaml:"position"`
// `CfnRecipe.RecipeParametersProperty.RemoveAllPunctuation`.
RemoveAllPunctuation *string `json:"removeAllPunctuation" yaml:"removeAllPunctuation"`
// `CfnRecipe.RecipeParametersProperty.RemoveAllQuotes`.
RemoveAllQuotes *string `json:"removeAllQuotes" yaml:"removeAllQuotes"`
// `CfnRecipe.RecipeParametersProperty.RemoveAllWhitespace`.
RemoveAllWhitespace *string `json:"removeAllWhitespace" yaml:"removeAllWhitespace"`
// `CfnRecipe.RecipeParametersProperty.RemoveCustomCharacters`.
RemoveCustomCharacters *string `json:"removeCustomCharacters" yaml:"removeCustomCharacters"`
// `CfnRecipe.RecipeParametersProperty.RemoveCustomValue`.
RemoveCustomValue *string `json:"removeCustomValue" yaml:"removeCustomValue"`
// `CfnRecipe.RecipeParametersProperty.RemoveLeadingAndTrailingPunctuation`.
RemoveLeadingAndTrailingPunctuation *string `json:"removeLeadingAndTrailingPunctuation" yaml:"removeLeadingAndTrailingPunctuation"`
// `CfnRecipe.RecipeParametersProperty.RemoveLeadingAndTrailingQuotes`.
RemoveLeadingAndTrailingQuotes *string `json:"removeLeadingAndTrailingQuotes" yaml:"removeLeadingAndTrailingQuotes"`
// `CfnRecipe.RecipeParametersProperty.RemoveLeadingAndTrailingWhitespace`.
RemoveLeadingAndTrailingWhitespace *string `json:"removeLeadingAndTrailingWhitespace" yaml:"removeLeadingAndTrailingWhitespace"`
// `CfnRecipe.RecipeParametersProperty.RemoveLetters`.
RemoveLetters *string `json:"removeLetters" yaml:"removeLetters"`
// `CfnRecipe.RecipeParametersProperty.RemoveNumbers`.
RemoveNumbers *string `json:"removeNumbers" yaml:"removeNumbers"`
// `CfnRecipe.RecipeParametersProperty.RemoveSourceColumn`.
RemoveSourceColumn *string `json:"removeSourceColumn" yaml:"removeSourceColumn"`
// `CfnRecipe.RecipeParametersProperty.RemoveSpecialCharacters`.
RemoveSpecialCharacters *string `json:"removeSpecialCharacters" yaml:"removeSpecialCharacters"`
// `CfnRecipe.RecipeParametersProperty.RightColumns`.
RightColumns *string `json:"rightColumns" yaml:"rightColumns"`
// `CfnRecipe.RecipeParametersProperty.SampleSize`.
SampleSize *string `json:"sampleSize" yaml:"sampleSize"`
// `CfnRecipe.RecipeParametersProperty.SampleType`.
SampleType *string `json:"sampleType" yaml:"sampleType"`
// `CfnRecipe.RecipeParametersProperty.SecondaryInputs`.
SecondaryInputs interface{} `json:"secondaryInputs" yaml:"secondaryInputs"`
// `CfnRecipe.RecipeParametersProperty.SecondInput`.
SecondInput *string `json:"secondInput" yaml:"secondInput"`
// `CfnRecipe.RecipeParametersProperty.SheetIndexes`.
SheetIndexes interface{} `json:"sheetIndexes" yaml:"sheetIndexes"`
// `CfnRecipe.RecipeParametersProperty.SheetNames`.
SheetNames *[]*string `json:"sheetNames" yaml:"sheetNames"`
// `CfnRecipe.RecipeParametersProperty.SourceColumn`.
SourceColumn *string `json:"sourceColumn" yaml:"sourceColumn"`
// `CfnRecipe.RecipeParametersProperty.SourceColumn1`.
SourceColumn1 *string `json:"sourceColumn1" yaml:"sourceColumn1"`
// `CfnRecipe.RecipeParametersProperty.SourceColumn2`.
SourceColumn2 *string `json:"sourceColumn2" yaml:"sourceColumn2"`
// `CfnRecipe.RecipeParametersProperty.SourceColumns`.
SourceColumns *string `json:"sourceColumns" yaml:"sourceColumns"`
// `CfnRecipe.RecipeParametersProperty.StartColumnIndex`.
StartColumnIndex *string `json:"startColumnIndex" yaml:"startColumnIndex"`
// `CfnRecipe.RecipeParametersProperty.StartPattern`.
StartPattern *string `json:"startPattern" yaml:"startPattern"`
// `CfnRecipe.RecipeParametersProperty.StartPosition`.
StartPosition *string `json:"startPosition" yaml:"startPosition"`
// `CfnRecipe.RecipeParametersProperty.StartValue`.
StartValue *string `json:"startValue" yaml:"startValue"`
// `CfnRecipe.RecipeParametersProperty.StemmingMode`.
StemmingMode *string `json:"stemmingMode" yaml:"stemmingMode"`
// `CfnRecipe.RecipeParametersProperty.StepCount`.
StepCount *string `json:"stepCount" yaml:"stepCount"`
// `CfnRecipe.RecipeParametersProperty.StepIndex`.
StepIndex *string `json:"stepIndex" yaml:"stepIndex"`
// `CfnRecipe.RecipeParametersProperty.StopWordsMode`.
StopWordsMode *string `json:"stopWordsMode" yaml:"stopWordsMode"`
// `CfnRecipe.RecipeParametersProperty.Strategy`.
Strategy *string `json:"strategy" yaml:"strategy"`
// `CfnRecipe.RecipeParametersProperty.TargetColumn`.
TargetColumn *string `json:"targetColumn" yaml:"targetColumn"`
// `CfnRecipe.RecipeParametersProperty.TargetColumnNames`.
TargetColumnNames *string `json:"targetColumnNames" yaml:"targetColumnNames"`
// `CfnRecipe.RecipeParametersProperty.TargetDateFormat`.
TargetDateFormat *string `json:"targetDateFormat" yaml:"targetDateFormat"`
// `CfnRecipe.RecipeParametersProperty.TargetIndex`.
TargetIndex *string `json:"targetIndex" yaml:"targetIndex"`
// `CfnRecipe.RecipeParametersProperty.TimeZone`.
TimeZone *string `json:"timeZone" yaml:"timeZone"`
// `CfnRecipe.RecipeParametersProperty.TokenizerPattern`.
TokenizerPattern *string `json:"tokenizerPattern" yaml:"tokenizerPattern"`
// `CfnRecipe.RecipeParametersProperty.TrueString`.
TrueString *string `json:"trueString" yaml:"trueString"`
// `CfnRecipe.RecipeParametersProperty.UdfLang`.
UdfLang *string `json:"udfLang" yaml:"udfLang"`
// `CfnRecipe.RecipeParametersProperty.Units`.
Units *string `json:"units" yaml:"units"`
// `CfnRecipe.RecipeParametersProperty.UnpivotColumn`.
UnpivotColumn *string `json:"unpivotColumn" yaml:"unpivotColumn"`
// `CfnRecipe.RecipeParametersProperty.UpperBound`.
UpperBound *string `json:"upperBound" yaml:"upperBound"`
// `CfnRecipe.RecipeParametersProperty.UseNewDataFrame`.
UseNewDataFrame *string `json:"useNewDataFrame" yaml:"useNewDataFrame"`
// `CfnRecipe.RecipeParametersProperty.Value`.
Value *string `json:"value" yaml:"value"`
// `CfnRecipe.RecipeParametersProperty.Value1`.
Value1 *string `json:"value1" yaml:"value1"`
// `CfnRecipe.RecipeParametersProperty.Value2`.
Value2 *string `json:"value2" yaml:"value2"`
// `CfnRecipe.RecipeParametersProperty.ValueColumn`.
ValueColumn *string `json:"valueColumn" yaml:"valueColumn"`
// `CfnRecipe.RecipeParametersProperty.ViewFrame`.
ViewFrame *string `json:"viewFrame" yaml:"viewFrame"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
var input interface{}
recipeParametersProperty := &recipeParametersProperty{
aggregateFunction: jsii.String("aggregateFunction"),
base: jsii.String("base"),
caseStatement: jsii.String("caseStatement"),
categoryMap: jsii.String("categoryMap"),
charsToRemove: jsii.String("charsToRemove"),
collapseConsecutiveWhitespace: jsii.String("collapseConsecutiveWhitespace"),
columnDataType: jsii.String("columnDataType"),
columnRange: jsii.String("columnRange"),
count: jsii.String("count"),
customCharacters: jsii.String("customCharacters"),
customStopWords: jsii.String("customStopWords"),
customValue: jsii.String("customValue"),
datasetsColumns: jsii.String("datasetsColumns"),
dateAddValue: jsii.String("dateAddValue"),
dateTimeFormat: jsii.String("dateTimeFormat"),
dateTimeParameters: jsii.String("dateTimeParameters"),
deleteOtherRows: jsii.String("deleteOtherRows"),
delimiter: jsii.String("delimiter"),
endPattern: jsii.String("endPattern"),
endPosition: jsii.String("endPosition"),
endValue: jsii.String("endValue"),
expandContractions: jsii.String("expandContractions"),
exponent: jsii.String("exponent"),
falseString: jsii.String("falseString"),
groupByAggFunctionOptions: jsii.String("groupByAggFunctionOptions"),
groupByColumns: jsii.String("groupByColumns"),
hiddenColumns: jsii.String("hiddenColumns"),
ignoreCase: jsii.String("ignoreCase"),
includeInSplit: jsii.String("includeInSplit"),
input: input,
interval: jsii.String("interval"),
isText: jsii.String("isText"),
joinKeys: jsii.String("joinKeys"),
joinType: jsii.String("joinType"),
leftColumns: jsii.String("leftColumns"),
limit: jsii.String("limit"),
lowerBound: jsii.String("lowerBound"),
mapType: jsii.String("mapType"),
modeType: jsii.String("modeType"),
multiLine: jsii.Boolean(false),
numRows: jsii.String("numRows"),
numRowsAfter: jsii.String("numRowsAfter"),
numRowsBefore: jsii.String("numRowsBefore"),
orderByColumn: jsii.String("orderByColumn"),
orderByColumns: jsii.String("orderByColumns"),
other: jsii.String("other"),
pattern: jsii.String("pattern"),
patternOption1: jsii.String("patternOption1"),
patternOption2: jsii.String("patternOption2"),
patternOptions: jsii.String("patternOptions"),
period: jsii.String("period"),
position: jsii.String("position"),
removeAllPunctuation: jsii.String("removeAllPunctuation"),
removeAllQuotes: jsii.String("removeAllQuotes"),
removeAllWhitespace: jsii.String("removeAllWhitespace"),
removeCustomCharacters: jsii.String("removeCustomCharacters"),
removeCustomValue: jsii.String("removeCustomValue"),
removeLeadingAndTrailingPunctuation: jsii.String("removeLeadingAndTrailingPunctuation"),
removeLeadingAndTrailingQuotes: jsii.String("removeLeadingAndTrailingQuotes"),
removeLeadingAndTrailingWhitespace: jsii.String("removeLeadingAndTrailingWhitespace"),
removeLetters: jsii.String("removeLetters"),
removeNumbers: jsii.String("removeNumbers"),
removeSourceColumn: jsii.String("removeSourceColumn"),
removeSpecialCharacters: jsii.String("removeSpecialCharacters"),
rightColumns: jsii.String("rightColumns"),
sampleSize: jsii.String("sampleSize"),
sampleType: jsii.String("sampleType"),
secondaryInputs: []interface{}{
&secondaryInputProperty{
dataCatalogInputDefinition: &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
s3InputDefinition: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
},
secondInput: jsii.String("secondInput"),
sheetIndexes: []interface{}{
jsii.Number(123),
},
sheetNames: []*string{
jsii.String("sheetNames"),
},
sourceColumn: jsii.String("sourceColumn"),
sourceColumn1: jsii.String("sourceColumn1"),
sourceColumn2: jsii.String("sourceColumn2"),
sourceColumns: jsii.String("sourceColumns"),
startColumnIndex: jsii.String("startColumnIndex"),
startPattern: jsii.String("startPattern"),
startPosition: jsii.String("startPosition"),
startValue: jsii.String("startValue"),
stemmingMode: jsii.String("stemmingMode"),
stepCount: jsii.String("stepCount"),
stepIndex: jsii.String("stepIndex"),
stopWordsMode: jsii.String("stopWordsMode"),
strategy: jsii.String("strategy"),
targetColumn: jsii.String("targetColumn"),
targetColumnNames: jsii.String("targetColumnNames"),
targetDateFormat: jsii.String("targetDateFormat"),
targetIndex: jsii.String("targetIndex"),
timeZone: jsii.String("timeZone"),
tokenizerPattern: jsii.String("tokenizerPattern"),
trueString: jsii.String("trueString"),
udfLang: jsii.String("udfLang"),
units: jsii.String("units"),
unpivotColumn: jsii.String("unpivotColumn"),
upperBound: jsii.String("upperBound"),
useNewDataFrame: jsii.String("useNewDataFrame"),
value: jsii.String("value"),
value1: jsii.String("value1"),
value2: jsii.String("value2"),
valueColumn: jsii.String("valueColumn"),
viewFrame: jsii.String("viewFrame"),
}
type CfnRecipe_RecipeStepProperty ¶
type CfnRecipe_RecipeStepProperty struct {
// `CfnRecipe.RecipeStepProperty.Action`.
Action interface{} `json:"action" yaml:"action"`
// `CfnRecipe.RecipeStepProperty.ConditionExpressions`.
ConditionExpressions interface{} `json:"conditionExpressions" yaml:"conditionExpressions"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
recipeStepProperty := &recipeStepProperty{
action: &actionProperty{
operation: jsii.String("operation"),
// the properties below are optional
parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
},
// the properties below are optional
conditionExpressions: []interface{}{
&conditionExpressionProperty{
condition: jsii.String("condition"),
targetColumn: jsii.String("targetColumn"),
// the properties below are optional
value: jsii.String("value"),
},
},
}
type CfnRecipe_S3LocationProperty ¶
type CfnRecipe_S3LocationProperty struct {
// `CfnRecipe.S3LocationProperty.Bucket`.
Bucket *string `json:"bucket" yaml:"bucket"`
// `CfnRecipe.S3LocationProperty.Key`.
Key *string `json:"key" yaml:"key"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
s3LocationProperty := &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
}
type CfnRecipe_SecondaryInputProperty ¶
type CfnRecipe_SecondaryInputProperty struct {
// `CfnRecipe.SecondaryInputProperty.DataCatalogInputDefinition`.
DataCatalogInputDefinition interface{} `json:"dataCatalogInputDefinition" yaml:"dataCatalogInputDefinition"`
// `CfnRecipe.SecondaryInputProperty.S3InputDefinition`.
S3InputDefinition interface{} `json:"s3InputDefinition" yaml:"s3InputDefinition"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
secondaryInputProperty := &secondaryInputProperty{
dataCatalogInputDefinition: &dataCatalogInputDefinitionProperty{
catalogId: jsii.String("catalogId"),
databaseName: jsii.String("databaseName"),
tableName: jsii.String("tableName"),
tempDirectory: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
},
s3InputDefinition: &s3LocationProperty{
bucket: jsii.String("bucket"),
// the properties below are optional
key: jsii.String("key"),
},
}
type CfnRuleset ¶
type CfnRuleset interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Ruleset.Description`.
Description() *string
SetDescription(val *string)
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Ruleset.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// `AWS::DataBrew::Ruleset.Rules`.
Rules() interface{}
SetRules(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Ruleset.Tags`.
Tags() awscdk.TagManager
// `AWS::DataBrew::Ruleset.TargetArn`.
TargetArn() *string
SetTargetArn(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Ruleset`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnRuleset := databrew.NewCfnRuleset(this, jsii.String("MyCfnRuleset"), &cfnRulesetProps{
name: jsii.String("name"),
rules: []interface{}{
&ruleProperty{
checkExpression: jsii.String("checkExpression"),
name: jsii.String("name"),
// the properties below are optional
columnSelectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
disabled: jsii.Boolean(false),
substitutionMap: []interface{}{
&substitutionValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
threshold: &thresholdProperty{
value: jsii.Number(123),
// the properties below are optional
type: jsii.String("type"),
unit: jsii.String("unit"),
},
},
},
targetArn: jsii.String("targetArn"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnRuleset ¶
func NewCfnRuleset(scope awscdk.Construct, id *string, props *CfnRulesetProps) CfnRuleset
Create a new `AWS::DataBrew::Ruleset`.
type CfnRulesetProps ¶
type CfnRulesetProps struct {
// `AWS::DataBrew::Ruleset.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Ruleset.Rules`.
Rules interface{} `json:"rules" yaml:"rules"`
// `AWS::DataBrew::Ruleset.TargetArn`.
TargetArn *string `json:"targetArn" yaml:"targetArn"`
// `AWS::DataBrew::Ruleset.Description`.
Description *string `json:"description" yaml:"description"`
// `AWS::DataBrew::Ruleset.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRuleset`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnRulesetProps := &cfnRulesetProps{
name: jsii.String("name"),
rules: []interface{}{
&ruleProperty{
checkExpression: jsii.String("checkExpression"),
name: jsii.String("name"),
// the properties below are optional
columnSelectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
disabled: jsii.Boolean(false),
substitutionMap: []interface{}{
&substitutionValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
threshold: &thresholdProperty{
value: jsii.Number(123),
// the properties below are optional
type: jsii.String("type"),
unit: jsii.String("unit"),
},
},
},
targetArn: jsii.String("targetArn"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnRuleset_ColumnSelectorProperty ¶
type CfnRuleset_ColumnSelectorProperty struct {
// `CfnRuleset.ColumnSelectorProperty.Name`.
Name *string `json:"name" yaml:"name"`
// `CfnRuleset.ColumnSelectorProperty.Regex`.
Regex *string `json:"regex" yaml:"regex"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
columnSelectorProperty := &columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
}
type CfnRuleset_RuleProperty ¶
type CfnRuleset_RuleProperty struct {
// `CfnRuleset.RuleProperty.CheckExpression`.
CheckExpression *string `json:"checkExpression" yaml:"checkExpression"`
// `CfnRuleset.RuleProperty.Name`.
Name *string `json:"name" yaml:"name"`
// `CfnRuleset.RuleProperty.ColumnSelectors`.
ColumnSelectors interface{} `json:"columnSelectors" yaml:"columnSelectors"`
// `CfnRuleset.RuleProperty.Disabled`.
Disabled interface{} `json:"disabled" yaml:"disabled"`
// `CfnRuleset.RuleProperty.SubstitutionMap`.
SubstitutionMap interface{} `json:"substitutionMap" yaml:"substitutionMap"`
// `CfnRuleset.RuleProperty.Threshold`.
Threshold interface{} `json:"threshold" yaml:"threshold"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
ruleProperty := &ruleProperty{
checkExpression: jsii.String("checkExpression"),
name: jsii.String("name"),
// the properties below are optional
columnSelectors: []interface{}{
&columnSelectorProperty{
name: jsii.String("name"),
regex: jsii.String("regex"),
},
},
disabled: jsii.Boolean(false),
substitutionMap: []interface{}{
&substitutionValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
},
},
threshold: &thresholdProperty{
value: jsii.Number(123),
// the properties below are optional
type: jsii.String("type"),
unit: jsii.String("unit"),
},
}
type CfnRuleset_SubstitutionValueProperty ¶
type CfnRuleset_SubstitutionValueProperty struct {
// `CfnRuleset.SubstitutionValueProperty.Value`.
Value *string `json:"value" yaml:"value"`
// `CfnRuleset.SubstitutionValueProperty.ValueReference`.
ValueReference *string `json:"valueReference" yaml:"valueReference"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
substitutionValueProperty := &substitutionValueProperty{
value: jsii.String("value"),
valueReference: jsii.String("valueReference"),
}
type CfnRuleset_ThresholdProperty ¶
type CfnRuleset_ThresholdProperty struct {
// `CfnRuleset.ThresholdProperty.Value`.
Value *float64 `json:"value" yaml:"value"`
// `CfnRuleset.ThresholdProperty.Type`.
Type *string `json:"type" yaml:"type"`
// `CfnRuleset.ThresholdProperty.Unit`.
Unit *string `json:"unit" yaml:"unit"`
}
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
thresholdProperty := &thresholdProperty{
value: jsii.Number(123),
// the properties below are optional
type: jsii.String("type"),
unit: jsii.String("unit"),
}
type CfnSchedule ¶
type CfnSchedule interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::DataBrew::Schedule.CronExpression`.
CronExpression() *string
SetCronExpression(val *string)
// `AWS::DataBrew::Schedule.JobNames`.
JobNames() *[]*string
SetJobNames(val *[]*string)
// 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)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::DataBrew::Schedule.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::DataBrew::Schedule.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// 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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// 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.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DataBrew::Schedule`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnSchedule := databrew.NewCfnSchedule(this, jsii.String("MyCfnSchedule"), &cfnScheduleProps{
cronExpression: jsii.String("cronExpression"),
name: jsii.String("name"),
// the properties below are optional
jobNames: []*string{
jsii.String("jobNames"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnSchedule ¶
func NewCfnSchedule(scope awscdk.Construct, id *string, props *CfnScheduleProps) CfnSchedule
Create a new `AWS::DataBrew::Schedule`.
type CfnScheduleProps ¶
type CfnScheduleProps struct {
// `AWS::DataBrew::Schedule.CronExpression`.
CronExpression *string `json:"cronExpression" yaml:"cronExpression"`
// `AWS::DataBrew::Schedule.Name`.
Name *string `json:"name" yaml:"name"`
// `AWS::DataBrew::Schedule.JobNames`.
JobNames *[]*string `json:"jobNames" yaml:"jobNames"`
// `AWS::DataBrew::Schedule.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSchedule`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import databrew "github.com/aws/aws-cdk-go/awscdk/aws_databrew"
cfnScheduleProps := &cfnScheduleProps{
cronExpression: jsii.String("cronExpression"),
name: jsii.String("name"),
// the properties below are optional
jobNames: []*string{
jsii.String("jobNames"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}