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 constructs.Construct, id *string, props *CfnDatasetProps)
- func NewCfnJob_Override(c CfnJob, scope constructs.Construct, id *string, props *CfnJobProps)
- func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
- func NewCfnRecipe_Override(c CfnRecipe, scope constructs.Construct, id *string, props *CfnRecipeProps)
- func NewCfnRuleset_Override(c CfnRuleset, scope constructs.Construct, id *string, props *CfnRulesetProps)
- func NewCfnSchedule_Override(c CfnSchedule, scope constructs.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_InputProperty
- 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.
func CfnDataset_IsCfnResource ¶
func CfnDataset_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDataset_IsConstruct ¶
func CfnDataset_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnJob_IsCfnResource ¶
func CfnJob_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnJob_IsConstruct ¶
func CfnJob_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnProject_IsCfnResource ¶
func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnProject_IsConstruct ¶
func CfnProject_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnRecipe_IsCfnResource ¶
func CfnRecipe_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRecipe_IsConstruct ¶
func CfnRecipe_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnRuleset_IsCfnResource ¶
func CfnRuleset_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRuleset_IsConstruct ¶
func CfnRuleset_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnSchedule_IsCfnResource ¶
func CfnSchedule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSchedule_IsConstruct ¶
func CfnSchedule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnDataset_Override ¶
func NewCfnDataset_Override(c CfnDataset, scope constructs.Construct, id *string, props *CfnDatasetProps)
Create a new `AWS::DataBrew::Dataset`.
func NewCfnJob_Override ¶
func NewCfnJob_Override(c CfnJob, scope constructs.Construct, id *string, props *CfnJobProps)
Create a new `AWS::DataBrew::Job`.
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
Create a new `AWS::DataBrew::Project`.
func NewCfnRecipe_Override ¶
func NewCfnRecipe_Override(c CfnRecipe, scope constructs.Construct, id *string, props *CfnRecipeProps)
Create a new `AWS::DataBrew::Recipe`.
func NewCfnRuleset_Override ¶
func NewCfnRuleset_Override(c CfnRuleset, scope constructs.Construct, id *string, props *CfnRulesetProps)
Create a new `AWS::DataBrew::Ruleset`.
func NewCfnSchedule_Override ¶
func NewCfnSchedule_Override(c CfnSchedule, scope constructs.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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // The file format of a dataset that is created from an Amazon S3 file or folder. Format() *string SetFormat(val *string) // A set of options that define how DataBrew interprets the data in the dataset. FormatOptions() interface{} SetFormatOptions(val interface{}) // Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 . 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. LogicalId() *string // The unique name of the dataset. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata tags that have been applied to the dataset. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Dataset`.
Specifies a new DataBrew dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataset := awscdk.Aws_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 constructs.Construct, id *string, props *CfnDatasetProps) CfnDataset
Create a new `AWS::DataBrew::Dataset`.
type CfnDatasetProps ¶
type CfnDatasetProps struct { // Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 . Input interface{} `field:"required" json:"input" yaml:"input"` // The unique name of the dataset. Name *string `field:"required" json:"name" yaml:"name"` // The file format of a dataset that is created from an Amazon S3 file or folder. Format *string `field:"optional" json:"format" yaml:"format"` // A set of options that define how DataBrew interprets the data in the dataset. FormatOptions interface{} `field:"optional" json:"formatOptions" yaml:"formatOptions"` // A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. PathOptions interface{} `field:"optional" json:"pathOptions" yaml:"pathOptions"` // Metadata tags that have been applied to the dataset. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDataset`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A single character that specifies the delimiter being used in the CSV file. Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"` // A variable that specifies whether the first row in the file is parsed as the header. // // If this value is false, column names are auto-generated. HeaderRow interface{} `field:"optional" json:"headerRow" yaml:"headerRow"` }
Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvOptionsProperty := &CsvOptionsProperty{ Delimiter: jsii.String("delimiter"), HeaderRow: jsii.Boolean(false), }
type CfnDataset_DataCatalogInputDefinitionProperty ¶
type CfnDataset_DataCatalogInputDefinitionProperty struct { // The unique identifier of the AWS account that holds the Data Catalog that stores the data. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of a database in the Data Catalog. DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of a database table in the Data Catalog. // // This table corresponds to a DataBrew dataset. TableName *string `field:"optional" json:"tableName" yaml:"tableName"` // An Amazon location that AWS Glue Data Catalog can use as a temporary directory. TempDirectory interface{} `field:"optional" json:"tempDirectory" yaml:"tempDirectory"` }
Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The AWS Glue Connection that stores the connection information for the target database. GlueConnectionName *string `field:"required" json:"glueConnectionName" yaml:"glueConnectionName"` // The table within the target database. DatabaseTableName *string `field:"optional" json:"databaseTableName" yaml:"databaseTableName"` // Custom SQL to run against the provided AWS Glue connection. // // This SQL will be used as the input for DataBrew projects and jobs. QueryString *string `field:"optional" json:"queryString" yaml:"queryString"` // An Amazon location that AWS Glue Data Catalog can use as a temporary directory. TempDirectory interface{} `field:"optional" json:"tempDirectory" yaml:"tempDirectory"` }
Connection information for dataset input files stored in a database.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The name of the parameter that is used in the dataset's Amazon S3 path. Name *string `field:"required" json:"name" yaml:"name"` // The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'. Type *string `field:"required" json:"type" yaml:"type"` // Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset. CreateColumn interface{} `field:"optional" json:"createColumn" yaml:"createColumn"` // Additional parameter options such as a format and a timezone. // // Required for datetime parameters. DatetimeOptions interface{} `field:"optional" json:"datetimeOptions" yaml:"datetimeOptions"` // The optional filter expression structure to apply additional matching criteria to the parameter. Filter interface{} `field:"optional" json:"filter" yaml:"filter"` }
Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. // // Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm". Format *string `field:"required" json:"format" yaml:"format"` // Optional value for a non-US locale code, needed for correct interpretation of some date formats. LocaleCode *string `field:"optional" json:"localeCode" yaml:"localeCode"` // Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. // // Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed. TimezoneOffset *string `field:"optional" json:"timezoneOffset" yaml:"timezoneOffset"` }
Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A variable that specifies whether the first row in the file is parsed as the header. // // If this value is false, column names are auto-generated. HeaderRow interface{} `field:"optional" json:"headerRow" yaml:"headerRow"` // One or more sheet numbers in the Excel file that will be included in the dataset. SheetIndexes interface{} `field:"optional" json:"sheetIndexes" yaml:"sheetIndexes"` // One or more named sheets in the Excel file that will be included in the dataset. SheetNames *[]*string `field:"optional" json:"sheetNames" yaml:"sheetNames"` }
Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" excelOptionsProperty := &ExcelOptionsProperty{ HeaderRow: jsii.Boolean(false), SheetIndexes: []interface{}{ jsii.Number(123), }, SheetNames: []*string{ jsii.String("sheetNames"), }, }
type CfnDataset_FilesLimitProperty ¶
type CfnDataset_FilesLimitProperty struct { // The number of Amazon S3 files to select. MaxFiles *float64 `field:"required" json:"maxFiles" yaml:"maxFiles"` // A criteria to use for Amazon S3 files sorting before their selection. // // By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING. Order *string `field:"optional" json:"order" yaml:"order"` // A criteria to use for Amazon S3 files sorting before their selection. // // By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value. OrderedBy *string `field:"optional" json:"orderedBy" yaml:"orderedBy"` }
Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. // // For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol. Expression *string `field:"required" json:"expression" yaml:"expression"` // The map of substitution variable names to their values used in this filter expression. ValuesMap interface{} `field:"required" json:"valuesMap" yaml:"valuesMap"` }
Represents a structure for defining parameter conditions.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" filterExpressionProperty := &FilterExpressionProperty{ Expression: jsii.String("expression"), ValuesMap: []interface{}{ &FilterValueProperty{ Value: jsii.String("value"), ValueReference: jsii.String("valueReference"), }, }, }
type CfnDataset_FilterValueProperty ¶
type CfnDataset_FilterValueProperty struct { // The value to be associated with the substitution variable. Value *string `field:"required" json:"value" yaml:"value"` // The substitution variable reference. ValueReference *string `field:"required" json:"valueReference" yaml:"valueReference"` }
Represents a single entry in the `ValuesMap` of a `FilterExpression` .
A `FilterValue` associates the name of a substitution variable in an expression to its value.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" filterValueProperty := &FilterValueProperty{ Value: jsii.String("value"), ValueReference: jsii.String("valueReference"), }
type CfnDataset_FormatOptionsProperty ¶
type CfnDataset_FormatOptionsProperty struct { // Options that define how CSV input is to be interpreted by DataBrew. Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // Options that define how Excel input is to be interpreted by DataBrew. Excel interface{} `field:"optional" json:"excel" yaml:"excel"` // Options that define how JSON input is to be interpreted by DataBrew. Json interface{} `field:"optional" json:"json" yaml:"json"` }
Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // Connection information for dataset input files stored in a database. DatabaseInputDefinition interface{} `field:"optional" json:"databaseInputDefinition" yaml:"databaseInputDefinition"` // The AWS Glue Data Catalog parameters for the data. DataCatalogInputDefinition interface{} `field:"optional" json:"dataCatalogInputDefinition" yaml:"dataCatalogInputDefinition"` // Contains additional resource information needed for specific datasets. Metadata interface{} `field:"optional" json:"metadata" yaml:"metadata"` // The Amazon S3 location where the data is stored. S3InputDefinition interface{} `field:"optional" json:"s3InputDefinition" yaml:"s3InputDefinition"` }
Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 {
// A value that specifies whether JSON input contains embedded new line characters.
MultiLine interface{} `field:"optional" json:"multiLine" yaml:"multiLine"`
}
Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonOptionsProperty := &JsonOptionsProperty{ MultiLine: jsii.Boolean(false), }
type CfnDataset_MetadataProperty ¶
type CfnDataset_MetadataProperty struct { // The Amazon Resource Name (ARN) associated with the dataset. // // Currently, DataBrew only supports ARNs from Amazon AppFlow. SourceArn *string `field:"optional" json:"sourceArn" yaml:"sourceArn"` }
Contains additional resource information needed for specific datasets.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metadataProperty := &MetadataProperty{ SourceArn: jsii.String("sourceArn"), }
type CfnDataset_PathOptionsProperty ¶
type CfnDataset_PathOptionsProperty struct { // If provided, this structure imposes a limit on a number of files that should be selected. FilesLimit interface{} `field:"optional" json:"filesLimit" yaml:"filesLimit"` // If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 . LastModifiedDateCondition interface{} `field:"optional" json:"lastModifiedDateCondition" yaml:"lastModifiedDateCondition"` // A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` }
Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The path parameter definition. DatasetParameter interface{} `field:"required" json:"datasetParameter" yaml:"datasetParameter"` // The name of the path parameter. PathParameterName *string `field:"required" json:"pathParameterName" yaml:"pathParameterName"` }
Represents a single entry in the path parameters of a dataset.
Each `PathParameter` consists of a name and a parameter definition.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The Amazon S3 bucket name. Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The unique name of the object in the bucket. Key *string `field:"optional" json:"key" yaml:"key"` }
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. DatabaseOutputs() interface{} SetDatabaseOutputs(val interface{}) // One or more artifacts that represent the AWS Glue Data Catalog output from running the job. DataCatalogOutputs() interface{} SetDataCatalogOutputs(val interface{}) // A dataset that the job is to process. DatasetName() *string SetDatasetName(val *string) // The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. // // For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) EncryptionKeyArn() *string SetEncryptionKeyArn(val *string) // The encryption mode for the job, which can be one of the following:. // // - `SSE-KMS` - Server-side encryption with keys managed by AWS KMS . // - `SSE-S3` - Server-side encryption with keys managed by Amazon S3. EncryptionMode() *string SetEncryptionMode(val *string) // A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. // // If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. 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. LogicalId() *string // The current status of Amazon CloudWatch logging for the job. LogSubscription() *string SetLogSubscription(val *string) // The maximum number of nodes that can be consumed when the job processes data. MaxCapacity() *float64 SetMaxCapacity(val *float64) // The maximum number of times to retry the job after a job run fails. MaxRetries() *float64 SetMaxRetries(val *float64) // The unique name of the job. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // `AWS::DataBrew::Job.OutputLocation`. OutputLocation() interface{} SetOutputLocation(val interface{}) // One or more artifacts that represent output from running the job. Outputs() interface{} SetOutputs(val interface{}) // Configuration for profile jobs. // // Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. ProfileConfiguration() interface{} SetProfileConfiguration(val interface{}) // The name of the project that the job is associated with. ProjectName() *string SetProjectName(val *string) // A series of data transformation steps that the job runs. 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 })`. Ref() *string // The Amazon Resource Name (ARN) of the role to be assumed for this job. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata tags that have been applied to the job. Tags() awscdk.TagManager // The job's timeout in minutes. // // A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` . Timeout() *float64 SetTimeout(val *float64) // The job type of the job, which must be one of the following:. // // - `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. // - `RECIPE` - A job to apply one or more transformations to a dataset. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // List of validation configurations that are applied to the profile job. ValidationConfigurations() interface{} SetValidationConfigurations(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Job`.
Specifies a new DataBrew job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnJob := awscdk.Aws_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: map[string]*string{ "parametersKey": jsii.String("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: map[string]*string{ "parametersKey": jsii.String("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"), }, }, })
func NewCfnJob ¶
func NewCfnJob(scope constructs.Construct, id *string, props *CfnJobProps) CfnJob
Create a new `AWS::DataBrew::Job`.
type CfnJobProps ¶
type CfnJobProps struct { // The unique name of the job. Name *string `field:"required" json:"name" yaml:"name"` // The Amazon Resource Name (ARN) of the role to be assumed for this job. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The job type of the job, which must be one of the following:. // // - `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. // - `RECIPE` - A job to apply one or more transformations to a dataset. Type *string `field:"required" json:"type" yaml:"type"` // Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. DatabaseOutputs interface{} `field:"optional" json:"databaseOutputs" yaml:"databaseOutputs"` // One or more artifacts that represent the AWS Glue Data Catalog output from running the job. DataCatalogOutputs interface{} `field:"optional" json:"dataCatalogOutputs" yaml:"dataCatalogOutputs"` // A dataset that the job is to process. DatasetName *string `field:"optional" json:"datasetName" yaml:"datasetName"` // The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. // // For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) EncryptionKeyArn *string `field:"optional" json:"encryptionKeyArn" yaml:"encryptionKeyArn"` // The encryption mode for the job, which can be one of the following:. // // - `SSE-KMS` - Server-side encryption with keys managed by AWS KMS . // - `SSE-S3` - Server-side encryption with keys managed by Amazon S3. EncryptionMode *string `field:"optional" json:"encryptionMode" yaml:"encryptionMode"` // A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. // // If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. JobSample interface{} `field:"optional" json:"jobSample" yaml:"jobSample"` // The current status of Amazon CloudWatch logging for the job. LogSubscription *string `field:"optional" json:"logSubscription" yaml:"logSubscription"` // The maximum number of nodes that can be consumed when the job processes data. MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"` // The maximum number of times to retry the job after a job run fails. MaxRetries *float64 `field:"optional" json:"maxRetries" yaml:"maxRetries"` // `AWS::DataBrew::Job.OutputLocation`. OutputLocation interface{} `field:"optional" json:"outputLocation" yaml:"outputLocation"` // One or more artifacts that represent output from running the job. Outputs interface{} `field:"optional" json:"outputs" yaml:"outputs"` // Configuration for profile jobs. // // Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. ProfileConfiguration interface{} `field:"optional" json:"profileConfiguration" yaml:"profileConfiguration"` // The name of the project that the job is associated with. ProjectName *string `field:"optional" json:"projectName" yaml:"projectName"` // A series of data transformation steps that the job runs. Recipe interface{} `field:"optional" json:"recipe" yaml:"recipe"` // Metadata tags that have been applied to the job. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The job's timeout in minutes. // // A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` . Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` // List of validation configurations that are applied to the profile job. ValidationConfigurations interface{} `field:"optional" json:"validationConfigurations" yaml:"validationConfigurations"` }
Properties for defining a `CfnJob`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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: map[string]*string{ "parametersKey": jsii.String("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: map[string]*string{ "parametersKey": jsii.String("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 { // One or more column statistics to allow for columns that contain detected entities. Statistics *[]*string `field:"required" json:"statistics" yaml:"statistics"` }
Configuration of statistics that are allowed to be run on columns that contain detected entities.
When undefined, no statistics will be computed on columns that contain detected entities.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" allowedStatisticsProperty := &AllowedStatisticsProperty{ Statistics: []*string{ jsii.String("statistics"), }, }
type CfnJob_ColumnSelectorProperty ¶
type CfnJob_ColumnSelectorProperty struct { // The name of a column from a dataset. Name *string `field:"optional" json:"name" yaml:"name"` // A regular expression for selecting a column from a dataset. Regex *string `field:"optional" json:"regex" yaml:"regex"` }
Selector of a column from a dataset for profile job configuration.
One selector includes either a column name or a regular expression.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" columnSelectorProperty := &ColumnSelectorProperty{ Name: jsii.String("name"), Regex: jsii.String("regex"), }
type CfnJob_ColumnStatisticsConfigurationProperty ¶
type CfnJob_ColumnStatisticsConfigurationProperty struct { // Configuration for evaluations. // // Statistics can be used to select evaluations and override parameters of evaluations. Statistics interface{} `field:"required" json:"statistics" yaml:"statistics"` // List of column selectors. // // Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns. Selectors interface{} `field:"optional" json:"selectors" yaml:"selectors"` }
Configuration for column evaluations for a profile job.
ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" columnStatisticsConfigurationProperty := &ColumnStatisticsConfigurationProperty{ Statistics: &StatisticsConfigurationProperty{ IncludedStatistics: []*string{ jsii.String("includedStatistics"), }, Overrides: []interface{}{ &StatisticOverrideProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("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 { // A single character that specifies the delimiter used to create CSV job output. Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"` }
Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvOutputOptionsProperty := &CsvOutputOptionsProperty{ Delimiter: jsii.String("delimiter"), }
type CfnJob_DataCatalogOutputProperty ¶
type CfnJob_DataCatalogOutputProperty struct { // The name of a database in the Data Catalog. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of a table in the Data Catalog. TableName *string `field:"required" json:"tableName" yaml:"tableName"` // The unique identifier of the AWS account that holds the Data Catalog that stores the data. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. DatabaseOptions interface{} `field:"optional" json:"databaseOptions" yaml:"databaseOptions"` // A value that, if true, means that any data in the location specified for output is overwritten with new output. // // Not supported with DatabaseOptions. Overwrite interface{} `field:"optional" json:"overwrite" yaml:"overwrite"` // Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. S3Options interface{} `field:"optional" json:"s3Options" yaml:"s3Options"` }
Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. DatabaseOptions interface{} `field:"required" json:"databaseOptions" yaml:"databaseOptions"` // The AWS Glue connection that stores the connection information for the target database. GlueConnectionName *string `field:"required" json:"glueConnectionName" yaml:"glueConnectionName"` // The output mode to write into the database. // // Currently supported option: NEW_TABLE. DatabaseOutputMode *string `field:"optional" json:"databaseOutputMode" yaml:"databaseOutputMode"` }
Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A prefix for the name of a table DataBrew will create in the database. TableName *string `field:"required" json:"tableName" yaml:"tableName"` // Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results. TempDirectory interface{} `field:"optional" json:"tempDirectory" yaml:"tempDirectory"` }
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // Entity types to detect. Can be any of the following:. // // - USA_SSN // - EMAIL // - USA_ITIN // - USA_PASSPORT_NUMBER // - PHONE_NUMBER // - USA_DRIVING_LICENSE // - BANK_ACCOUNT // - CREDIT_CARD // - IP_ADDRESS // - MAC_ADDRESS // - USA_DEA_NUMBER // - USA_HCPCS_CODE // - USA_NATIONAL_PROVIDER_IDENTIFIER // - USA_NATIONAL_DRUG_CODE // - USA_HEALTH_INSURANCE_CLAIM_NUMBER // - USA_MEDICARE_BENEFICIARY_IDENTIFIER // - USA_CPT_CODE // - PERSON_NAME // - DATE // // The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE. EntityTypes *[]*string `field:"required" json:"entityTypes" yaml:"entityTypes"` // Configuration of statistics that are allowed to be run on columns that contain detected entities. // // When undefined, no statistics will be computed on columns that contain detected entities. AllowedStatistics interface{} `field:"optional" json:"allowedStatistics" yaml:"allowedStatistics"` }
Configuration of entity detection for a profile job.
When undefined, entity detection is disabled.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A value that determines whether the profile job is run on the entire dataset or a specified number of rows. // // This value must be one of the following: // // - FULL_DATASET - The profile job is run on the entire dataset. // - CUSTOM_ROWS - The profile job is run on the number of rows specified in the `Size` parameter. Mode *string `field:"optional" json:"mode" yaml:"mode"` // The `Size` parameter is only required when the mode is CUSTOM_ROWS. // // The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE. // // Long.MAX_VALUE = 9223372036854775807 Size *float64 `field:"optional" json:"size" yaml:"size"` }
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
If a `JobSample` value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jobSampleProperty := &JobSampleProperty{ Mode: jsii.String("mode"), Size: jsii.Number(123), }
type CfnJob_OutputFormatOptionsProperty ¶
type CfnJob_OutputFormatOptionsProperty struct {
// Represents a set of options that define the structure of comma-separated value (CSV) job output.
Csv interface{} `field:"optional" json:"csv" yaml:"csv"`
}
Represents a set of options that define the structure of comma-separated (CSV) job output.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" outputFormatOptionsProperty := &OutputFormatOptionsProperty{ Csv: &CsvOutputOptionsProperty{ Delimiter: jsii.String("delimiter"), }, }
type CfnJob_OutputLocationProperty ¶
type CfnJob_OutputLocationProperty struct { // The Amazon S3 bucket name. Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // `CfnJob.OutputLocationProperty.BucketOwner`. BucketOwner *string `field:"optional" json:"bucketOwner" yaml:"bucketOwner"` // The unique name of the object in the bucket. Key *string `field:"optional" json:"key" yaml:"key"` }
The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The location in Amazon S3 where the job writes its output. Location interface{} `field:"required" json:"location" yaml:"location"` // The compression algorithm used to compress the output text of the job. CompressionFormat *string `field:"optional" json:"compressionFormat" yaml:"compressionFormat"` // The data format of the output of the job. Format *string `field:"optional" json:"format" yaml:"format"` // Represents options that define how DataBrew formats job output files. FormatOptions interface{} `field:"optional" json:"formatOptions" yaml:"formatOptions"` // The maximum number of files to be generated by the job and written to the output folder. MaxOutputFiles *float64 `field:"optional" json:"maxOutputFiles" yaml:"maxOutputFiles"` // A value that, if true, means that any data in the location specified for output is overwritten with new output. Overwrite interface{} `field:"optional" json:"overwrite" yaml:"overwrite"` // The names of one or more partition columns for the output of the job. PartitionColumns *[]*string `field:"optional" json:"partitionColumns" yaml:"partitionColumns"` }
Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // List of configurations for column evaluations. // // ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. ColumnStatisticsConfigurations interface{} `field:"optional" json:"columnStatisticsConfigurations" yaml:"columnStatisticsConfigurations"` // Configuration for inter-column evaluations. // // Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. DatasetStatisticsConfiguration interface{} `field:"optional" json:"datasetStatisticsConfiguration" yaml:"datasetStatisticsConfiguration"` // Configuration of entity detection for a profile job. // // When undefined, entity detection is disabled. EntityDetectorConfiguration interface{} `field:"optional" json:"entityDetectorConfiguration" yaml:"entityDetectorConfiguration"` // List of column selectors. // // ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. ProfileColumns interface{} `field:"optional" json:"profileColumns" yaml:"profileColumns"` }
Configuration for profile jobs.
Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" profileConfigurationProperty := &ProfileConfigurationProperty{ ColumnStatisticsConfigurations: []interface{}{ &ColumnStatisticsConfigurationProperty{ Statistics: &StatisticsConfigurationProperty{ IncludedStatistics: []*string{ jsii.String("includedStatistics"), }, Overrides: []interface{}{ &StatisticOverrideProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("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: map[string]*string{ "parametersKey": jsii.String("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 { // The unique name for the recipe. Name *string `field:"required" json:"name" yaml:"name"` // The identifier for the version for the recipe. Version *string `field:"optional" json:"version" yaml:"version"` }
Represents one or more actions to be performed on a DataBrew dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" recipeProperty := &RecipeProperty{ Name: jsii.String("name"), // the properties below are optional Version: jsii.String("version"), }
type CfnJob_S3LocationProperty ¶
type CfnJob_S3LocationProperty struct { // The Amazon S3 bucket name. Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The AWS account ID of the bucket owner. BucketOwner *string `field:"optional" json:"bucketOwner" yaml:"bucketOwner"` // The unique name of the object in the bucket. Key *string `field:"optional" json:"key" yaml:"key"` }
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 {
// Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
Location interface{} `field:"required" json:"location" yaml:"location"`
}
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A map that includes overrides of an evaluation’s parameters. Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"` // The name of an evaluation. Statistic *string `field:"required" json:"statistic" yaml:"statistic"` }
Override of a particular evaluation for a profile job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statisticOverrideProperty := &StatisticOverrideProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Statistic: jsii.String("statistic"), }
type CfnJob_StatisticsConfigurationProperty ¶
type CfnJob_StatisticsConfigurationProperty struct { // List of included evaluations. // // When the list is undefined, all supported evaluations will be included. IncludedStatistics *[]*string `field:"optional" json:"includedStatistics" yaml:"includedStatistics"` // List of overrides for evaluations. Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"` }
Configuration of evaluations for a profile job.
This configuration can be used to select evaluations and override the parameters of selected evaluations.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statisticsConfigurationProperty := &StatisticsConfigurationProperty{ IncludedStatistics: []*string{ jsii.String("includedStatistics"), }, Overrides: []interface{}{ &StatisticOverrideProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Statistic: jsii.String("statistic"), }, }, }
type CfnJob_ValidationConfigurationProperty ¶
type CfnJob_ValidationConfigurationProperty struct { // The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. // // The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job. RulesetArn *string `field:"required" json:"rulesetArn" yaml:"rulesetArn"` // Mode of data quality validation. // // Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset. ValidationMode *string `field:"optional" json:"validationMode" yaml:"validationMode"` }
Configuration for data quality validation.
Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // The dataset that the project is to act upon. 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. LogicalId() *string // The unique name of a project. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The name of a recipe that will be developed during a project session. 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 })`. Ref() *string // The Amazon Resource Name (ARN) of the role that will be assumed for this project. RoleArn() *string SetRoleArn(val *string) // The sample size and sampling type to apply to the data. // // If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset. Sample() interface{} SetSample(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata tags that have been applied to the project. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Project`.
Specifies a new AWS Glue DataBrew project.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnProject := awscdk.Aws_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 constructs.Construct, id *string, props *CfnProjectProps) CfnProject
Create a new `AWS::DataBrew::Project`.
type CfnProjectProps ¶
type CfnProjectProps struct { // The dataset that the project is to act upon. DatasetName *string `field:"required" json:"datasetName" yaml:"datasetName"` // The unique name of a project. Name *string `field:"required" json:"name" yaml:"name"` // The name of a recipe that will be developed during a project session. RecipeName *string `field:"required" json:"recipeName" yaml:"recipeName"` // The Amazon Resource Name (ARN) of the role that will be assumed for this project. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The sample size and sampling type to apply to the data. // // If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset. Sample interface{} `field:"optional" json:"sample" yaml:"sample"` // Metadata tags that have been applied to the project. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnProject`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The way in which DataBrew obtains rows from a dataset. Type *string `field:"required" json:"type" yaml:"type"` // The number of rows in the sample. Size *float64 `field:"optional" json:"size" yaml:"size"` }
Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // The description of the recipe. 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. LogicalId() *string // The unique name for the recipe. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of steps that are defined by the recipe. Steps() interface{} SetSteps(val interface{}) // Metadata tags that have been applied to the recipe. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Recipe`.
Specifies a new AWS Glue DataBrew transformation recipe.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRecipe := awscdk.Aws_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 constructs.Construct, id *string, props *CfnRecipeProps) CfnRecipe
Create a new `AWS::DataBrew::Recipe`.
type CfnRecipeProps ¶
type CfnRecipeProps struct { // The unique name for the recipe. Name *string `field:"required" json:"name" yaml:"name"` // A list of steps that are defined by the recipe. Steps interface{} `field:"required" json:"steps" yaml:"steps"` // The description of the recipe. Description *string `field:"optional" json:"description" yaml:"description"` // Metadata tags that have been applied to the recipe. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRecipe`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The name of a valid DataBrew transformation to be performed on the data. Operation *string `field:"required" json:"operation" yaml:"operation"` // Contextual parameters for the transformation. Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` }
Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // A specific condition to apply to a recipe action. // // For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer Guide* . Condition *string `field:"required" json:"condition" yaml:"condition"` // A column to apply this condition to. TargetColumn *string `field:"required" json:"targetColumn" yaml:"targetColumn"` // A value that the condition must evaluate to for the condition to succeed. Value *string `field:"optional" json:"value" yaml:"value"` }
Represents an individual condition that evaluates to true or false.
Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.
If a recipe requires more than one condition, then the recipe must specify multiple `ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The unique identifier of the AWS account that holds the Data Catalog that stores the data. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of a database in the Data Catalog. DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of a database table in the Data Catalog. // // This table corresponds to a DataBrew dataset. TableName *string `field:"optional" json:"tableName" yaml:"tableName"` // Represents an Amazon location where DataBrew can store intermediate results. TempDirectory interface{} `field:"optional" json:"tempDirectory" yaml:"tempDirectory"` }
Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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_InputProperty ¶ added in v2.55.0
type CfnRecipe_InputProperty struct { // `CfnRecipe.InputProperty.DataCatalogInputDefinition`. DataCatalogInputDefinition interface{} `field:"optional" json:"dataCatalogInputDefinition" yaml:"dataCatalogInputDefinition"` // `CfnRecipe.InputProperty.S3InputDefinition`. S3InputDefinition interface{} `field:"optional" json:"s3InputDefinition" yaml:"s3InputDefinition"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inputProperty := &InputProperty{ 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 CfnRecipe_RecipeParametersProperty ¶
type CfnRecipe_RecipeParametersProperty struct { // The name of an aggregation function to apply. AggregateFunction *string `field:"optional" json:"aggregateFunction" yaml:"aggregateFunction"` // The number of digits used in a counting system. Base *string `field:"optional" json:"base" yaml:"base"` // A case statement associated with a recipe. CaseStatement *string `field:"optional" json:"caseStatement" yaml:"caseStatement"` // A category map used for one-hot encoding. CategoryMap *string `field:"optional" json:"categoryMap" yaml:"categoryMap"` // Characters to remove from a step that applies one-hot encoding or tokenization. CharsToRemove *string `field:"optional" json:"charsToRemove" yaml:"charsToRemove"` // Remove any non-word non-punctuation character. CollapseConsecutiveWhitespace *string `field:"optional" json:"collapseConsecutiveWhitespace" yaml:"collapseConsecutiveWhitespace"` // The data type of the column. ColumnDataType *string `field:"optional" json:"columnDataType" yaml:"columnDataType"` // A range of columns to which a step is applied. ColumnRange *string `field:"optional" json:"columnRange" yaml:"columnRange"` // The number of times a string needs to be repeated. Count *string `field:"optional" json:"count" yaml:"count"` // One or more characters that can be substituted or removed, depending on the context. CustomCharacters *string `field:"optional" json:"customCharacters" yaml:"customCharacters"` // A list of words to ignore in a step that applies word tokenization. CustomStopWords *string `field:"optional" json:"customStopWords" yaml:"customStopWords"` // A list of custom values to use in a step that requires that you provide a value to finish the operation. CustomValue *string `field:"optional" json:"customValue" yaml:"customValue"` // A list of the dataset columns included in a project. DatasetsColumns *string `field:"optional" json:"datasetsColumns" yaml:"datasetsColumns"` // A value that specifies how many units of time to add or subtract for a date math operation. DateAddValue *string `field:"optional" json:"dateAddValue" yaml:"dateAddValue"` // A date format to apply to a date. DateTimeFormat *string `field:"optional" json:"dateTimeFormat" yaml:"dateTimeFormat"` // A set of parameters associated with a datetime. DateTimeParameters *string `field:"optional" json:"dateTimeParameters" yaml:"dateTimeParameters"` // Determines whether unmapped rows in a categorical mapping should be deleted. DeleteOtherRows *string `field:"optional" json:"deleteOtherRows" yaml:"deleteOtherRows"` // The delimiter to use when parsing separated values in a text file. Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"` // The end pattern to locate. EndPattern *string `field:"optional" json:"endPattern" yaml:"endPattern"` // The end position to locate. EndPosition *string `field:"optional" json:"endPosition" yaml:"endPosition"` // The end value to locate. EndValue *string `field:"optional" json:"endValue" yaml:"endValue"` // A list of word contractions and what they expand to. // // For eample: *can't* ; *cannot* ; *can not* . ExpandContractions *string `field:"optional" json:"expandContractions" yaml:"expandContractions"` // The exponent to apply in an exponential operation. Exponent *string `field:"optional" json:"exponent" yaml:"exponent"` // A value that represents `FALSE` . FalseString *string `field:"optional" json:"falseString" yaml:"falseString"` // Specifies options to apply to the `GROUP BY` used in an aggregation. GroupByAggFunctionOptions *string `field:"optional" json:"groupByAggFunctionOptions" yaml:"groupByAggFunctionOptions"` // The columns to use in the `GROUP BY` clause. GroupByColumns *string `field:"optional" json:"groupByColumns" yaml:"groupByColumns"` // A list of columns to hide. HiddenColumns *string `field:"optional" json:"hiddenColumns" yaml:"hiddenColumns"` // Indicates that lower and upper case letters are treated equally. IgnoreCase *string `field:"optional" json:"ignoreCase" yaml:"ignoreCase"` // Indicates if this column is participating in a split transform. IncludeInSplit *string `field:"optional" json:"includeInSplit" yaml:"includeInSplit"` // The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog . Input interface{} `field:"optional" json:"input" yaml:"input"` // The number of characters to split by. Interval *string `field:"optional" json:"interval" yaml:"interval"` // Indicates if the content is text. IsText *string `field:"optional" json:"isText" yaml:"isText"` // The keys or columns involved in a join. JoinKeys *string `field:"optional" json:"joinKeys" yaml:"joinKeys"` // The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on. JoinType *string `field:"optional" json:"joinType" yaml:"joinType"` // The columns on the left side of the join. LeftColumns *string `field:"optional" json:"leftColumns" yaml:"leftColumns"` // The number of times to perform `split` or `replaceBy` in a string. Limit *string `field:"optional" json:"limit" yaml:"limit"` // The lower boundary for a value. LowerBound *string `field:"optional" json:"lowerBound" yaml:"lowerBound"` // The type of mappings to apply to construct a new dynamic frame. MapType *string `field:"optional" json:"mapType" yaml:"mapType"` // Determines the manner in which mode value is calculated, in case there is more than one mode value. // // Valid values: `NONE` | `AVERAGE` | `MINIMUM` | `MAXIMUM`. ModeType *string `field:"optional" json:"modeType" yaml:"modeType"` // Specifies whether JSON input contains embedded new line characters. MultiLine interface{} `field:"optional" json:"multiLine" yaml:"multiLine"` // The number of rows to consider in a window. NumRows *string `field:"optional" json:"numRows" yaml:"numRows"` // The number of rows to consider after the current row in a window. NumRowsAfter *string `field:"optional" json:"numRowsAfter" yaml:"numRowsAfter"` // The number of rows to consider before the current row in a window. NumRowsBefore *string `field:"optional" json:"numRowsBefore" yaml:"numRowsBefore"` // A column to sort the results by. OrderByColumn *string `field:"optional" json:"orderByColumn" yaml:"orderByColumn"` // The columns to sort the results by. OrderByColumns *string `field:"optional" json:"orderByColumns" yaml:"orderByColumns"` // The value to assign to unmapped cells, in categorical mapping. Other *string `field:"optional" json:"other" yaml:"other"` // The pattern to locate. Pattern *string `field:"optional" json:"pattern" yaml:"pattern"` // The starting pattern to split between. PatternOption1 *string `field:"optional" json:"patternOption1" yaml:"patternOption1"` // The ending pattern to split between. PatternOption2 *string `field:"optional" json:"patternOption2" yaml:"patternOption2"` // For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. // // For example: `[{\"pattern\":\"1\",\"includeInSplit\":true}]`. PatternOptions *string `field:"optional" json:"patternOptions" yaml:"patternOptions"` // The size of the rolling window. Period *string `field:"optional" json:"period" yaml:"period"` // The character index within a string. Position *string `field:"optional" json:"position" yaml:"position"` // If `true` , removes all of the following characters: `.` `.!` `.,` `.?`. RemoveAllPunctuation *string `field:"optional" json:"removeAllPunctuation" yaml:"removeAllPunctuation"` // If `true` , removes all single quotes and double quotes. RemoveAllQuotes *string `field:"optional" json:"removeAllQuotes" yaml:"removeAllQuotes"` // If `true` , removes all whitespaces from the value. RemoveAllWhitespace *string `field:"optional" json:"removeAllWhitespace" yaml:"removeAllWhitespace"` // If `true` , removes all chraracters specified by `CustomCharacters` . RemoveCustomCharacters *string `field:"optional" json:"removeCustomCharacters" yaml:"removeCustomCharacters"` // If `true` , removes all chraracters specified by `CustomValue` . RemoveCustomValue *string `field:"optional" json:"removeCustomValue" yaml:"removeCustomValue"` // If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`. RemoveLeadingAndTrailingPunctuation *string `field:"optional" json:"removeLeadingAndTrailingPunctuation" yaml:"removeLeadingAndTrailingPunctuation"` // If `true` , removes single quotes and double quotes from the beginning and end of the value. RemoveLeadingAndTrailingQuotes *string `field:"optional" json:"removeLeadingAndTrailingQuotes" yaml:"removeLeadingAndTrailingQuotes"` // If `true` , removes all whitespaces from the beginning and end of the value. RemoveLeadingAndTrailingWhitespace *string `field:"optional" json:"removeLeadingAndTrailingWhitespace" yaml:"removeLeadingAndTrailingWhitespace"` // If `true` , removes all uppercase and lowercase alphabetic characters (A through Z; // // a through z). RemoveLetters *string `field:"optional" json:"removeLetters" yaml:"removeLetters"` // If `true` , removes all numeric characters (0 through 9). RemoveNumbers *string `field:"optional" json:"removeNumbers" yaml:"removeNumbers"` // If `true` , the source column will be removed after un-nesting that column. // // (Used with nested column types, such as Map, Struct, or Array.) RemoveSourceColumn *string `field:"optional" json:"removeSourceColumn" yaml:"removeSourceColumn"` // If `true` , removes all of the following characters: `! // // " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~` RemoveSpecialCharacters *string `field:"optional" json:"removeSpecialCharacters" yaml:"removeSpecialCharacters"` // The columns on the right side of a join. RightColumns *string `field:"optional" json:"rightColumns" yaml:"rightColumns"` // The number of rows in the sample. SampleSize *string `field:"optional" json:"sampleSize" yaml:"sampleSize"` // The sampling type to apply to the dataset. // // Valid values: `FIRST_N` | `LAST_N` | `RANDOM`. SampleType *string `field:"optional" json:"sampleType" yaml:"sampleType"` // A list of secondary inputs in a UNION transform. SecondaryInputs interface{} `field:"optional" json:"secondaryInputs" yaml:"secondaryInputs"` // A object value to indicate the second dataset used in a join. SecondInput *string `field:"optional" json:"secondInput" yaml:"secondInput"` // One or more sheet numbers in the Excel file, which will be included in a dataset. SheetIndexes interface{} `field:"optional" json:"sheetIndexes" yaml:"sheetIndexes"` // Oone or more named sheets in the Excel file, which will be included in a dataset. SheetNames *[]*string `field:"optional" json:"sheetNames" yaml:"sheetNames"` // A source column needed for an operation, step, or transform. SourceColumn *string `field:"optional" json:"sourceColumn" yaml:"sourceColumn"` // A source column needed for an operation, step, or transform. SourceColumn1 *string `field:"optional" json:"sourceColumn1" yaml:"sourceColumn1"` // A source column needed for an operation, step, or transform. SourceColumn2 *string `field:"optional" json:"sourceColumn2" yaml:"sourceColumn2"` // A list of source columns needed for an operation, step, or transform. SourceColumns *string `field:"optional" json:"sourceColumns" yaml:"sourceColumns"` // The index number of the first column used by an operation, step, or transform. StartColumnIndex *string `field:"optional" json:"startColumnIndex" yaml:"startColumnIndex"` // The starting pattern to locate. StartPattern *string `field:"optional" json:"startPattern" yaml:"startPattern"` // The starting position to locate. StartPosition *string `field:"optional" json:"startPosition" yaml:"startPosition"` // The starting value to locate. StartValue *string `field:"optional" json:"startValue" yaml:"startValue"` // Indicates this operation uses stems and lemmas (base words) for word tokenization. StemmingMode *string `field:"optional" json:"stemmingMode" yaml:"stemmingMode"` // The total number of transforms in this recipe. StepCount *string `field:"optional" json:"stepCount" yaml:"stepCount"` // The index ID of a step. StepIndex *string `field:"optional" json:"stepIndex" yaml:"stepIndex"` // Indicates this operation uses stop words as part of word tokenization. StopWordsMode *string `field:"optional" json:"stopWordsMode" yaml:"stopWordsMode"` // The resolution strategy to apply in resolving ambiguities. Strategy *string `field:"optional" json:"strategy" yaml:"strategy"` // The column targeted by this operation. TargetColumn *string `field:"optional" json:"targetColumn" yaml:"targetColumn"` // The names to give columns altered by this operation. TargetColumnNames *string `field:"optional" json:"targetColumnNames" yaml:"targetColumnNames"` // The date format to convert to. TargetDateFormat *string `field:"optional" json:"targetDateFormat" yaml:"targetDateFormat"` // The index number of an object that is targeted by this operation. TargetIndex *string `field:"optional" json:"targetIndex" yaml:"targetIndex"` // The current timezone that you want to use for dates. TimeZone *string `field:"optional" json:"timeZone" yaml:"timeZone"` // A regex expression to use when splitting text into terms, also called words or tokens. TokenizerPattern *string `field:"optional" json:"tokenizerPattern" yaml:"tokenizerPattern"` // A value to use to represent `TRUE` . TrueString *string `field:"optional" json:"trueString" yaml:"trueString"` // The language that's used in the user-defined function. UdfLang *string `field:"optional" json:"udfLang" yaml:"udfLang"` // Specifies a unit of time. // // For example: `MINUTES` ; `SECONDS` ; `HOURS` ; etc. Units *string `field:"optional" json:"units" yaml:"units"` // Cast columns as rows, so that each value is a different row in a single column. UnpivotColumn *string `field:"optional" json:"unpivotColumn" yaml:"unpivotColumn"` // The upper boundary for a value. UpperBound *string `field:"optional" json:"upperBound" yaml:"upperBound"` // Create a new container to hold a dataset. UseNewDataFrame *string `field:"optional" json:"useNewDataFrame" yaml:"useNewDataFrame"` // A static value that can be used in a comparison, a substitution, or in another context-specific way. // // A `Value` can be a number, string, or other datatype, depending on the recipe action in which it's used. Value *string `field:"optional" json:"value" yaml:"value"` // A value that's used by this operation. Value1 *string `field:"optional" json:"value1" yaml:"value1"` // A value that's used by this operation. Value2 *string `field:"optional" json:"value2" yaml:"value2"` // The column that is provided as a value that's used by this operation. ValueColumn *string `field:"optional" json:"valueColumn" yaml:"valueColumn"` // The subset of rows currently available for viewing. ViewFrame *string `field:"optional" json:"viewFrame" yaml:"viewFrame"` }
Parameters that are used as inputs for various recipe actions.
The parameters are specific to the context in which they're used.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The particular action to be performed in the recipe step. Action interface{} `field:"required" json:"action" yaml:"action"` // One or more conditions that must be met for the recipe step to succeed. // // > All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation. ConditionExpressions interface{} `field:"optional" json:"conditionExpressions" yaml:"conditionExpressions"` }
Represents a single step from a DataBrew recipe to be performed.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The Amazon S3 bucket name. Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The unique name of the object in the bucket. Key *string `field:"optional" json:"key" yaml:"key"` }
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), // the properties below are optional Key: jsii.String("key"), }
type CfnRecipe_SecondaryInputProperty ¶
type CfnRecipe_SecondaryInputProperty struct { // The AWS Glue Data Catalog parameters for the data. DataCatalogInputDefinition interface{} `field:"optional" json:"dataCatalogInputDefinition" yaml:"dataCatalogInputDefinition"` // The Amazon S3 location where the data is stored. S3InputDefinition interface{} `field:"optional" json:"s3InputDefinition" yaml:"s3InputDefinition"` }
Represents secondary inputs in a UNION transform.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // The description of the ruleset. 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. LogicalId() *string // The name of the ruleset. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // Contains metadata about the ruleset. Rules() interface{} SetRules(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags() awscdk.TagManager // The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. TargetArn() *string SetTargetArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Ruleset`.
Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRuleset := awscdk.Aws_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 constructs.Construct, id *string, props *CfnRulesetProps) CfnRuleset
Create a new `AWS::DataBrew::Ruleset`.
type CfnRulesetProps ¶
type CfnRulesetProps struct { // The name of the ruleset. Name *string `field:"required" json:"name" yaml:"name"` // Contains metadata about the ruleset. Rules interface{} `field:"required" json:"rules" yaml:"rules"` // The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"` // The description of the ruleset. Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRuleset`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // The name of a column from a dataset. Name *string `field:"optional" json:"name" yaml:"name"` // A regular expression for selecting a column from a dataset. Regex *string `field:"optional" json:"regex" yaml:"regex"` }
Selector of a column from a dataset for profile job configuration.
One selector includes either a column name or a regular expression.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" columnSelectorProperty := &ColumnSelectorProperty{ Name: jsii.String("name"), Regex: jsii.String("regex"), }
type CfnRuleset_RuleProperty ¶
type CfnRuleset_RuleProperty struct { // The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. // // For example, `(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)` . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, `is_between :val1 and :val2` . CheckExpression *string `field:"required" json:"checkExpression" yaml:"checkExpression"` // The name of the rule. Name *string `field:"required" json:"name" yaml:"name"` // List of column selectors. // // Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns. ColumnSelectors interface{} `field:"optional" json:"columnSelectors" yaml:"columnSelectors"` // A value that specifies whether the rule is disabled. // // Once a rule is disabled, a profile job will not validate it during a job run. Default value is false. Disabled interface{} `field:"optional" json:"disabled" yaml:"disabled"` // The map of substitution variable names to their values used in a check expression. // // Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, `":col1": "`Column A`".` SubstitutionMap interface{} `field:"optional" json:"substitutionMap" yaml:"substitutionMap"` // The threshold used with a non-aggregate check expression. // // Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds. Threshold interface{} `field:"optional" json:"threshold" yaml:"threshold"` }
Represents a single data quality requirement that should be validated in the scope of this dataset.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 { // Value or column name. Value *string `field:"required" json:"value" yaml:"value"` // Variable name. ValueReference *string `field:"required" json:"valueReference" yaml:"valueReference"` }
A key-value pair to associate an expression's substitution variable names with their values.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" substitutionValueProperty := &SubstitutionValueProperty{ Value: jsii.String("value"), ValueReference: jsii.String("valueReference"), }
type CfnRuleset_ThresholdProperty ¶
type CfnRuleset_ThresholdProperty struct { // The value of a threshold. Value *float64 `field:"required" json:"value" yaml:"value"` // The type of a threshold. // // Used for comparison of an actual count of rows that satisfy the rule to the threshold value. Type *string `field:"optional" json:"type" yaml:"type"` // Unit of threshold value. // // Can be either a COUNT or PERCENTAGE of the full sample size used for validation. Unit *string `field:"optional" json:"unit" yaml:"unit"` }
The threshold used with a non-aggregate check expression.
The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. CreationStack() *[]*string // The dates and times when the job is to run. // // For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer Guide* . CronExpression() *string SetCronExpression(val *string) // A list of jobs to be run, according to the schedule. 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. LogicalId() *string // The name of the schedule. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata tags that have been applied to the schedule. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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. // 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DataBrew::Schedule`.
Specifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSchedule := awscdk.Aws_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 constructs.Construct, id *string, props *CfnScheduleProps) CfnSchedule
Create a new `AWS::DataBrew::Schedule`.
type CfnScheduleProps ¶
type CfnScheduleProps struct { // The dates and times when the job is to run. // // For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer Guide* . CronExpression *string `field:"required" json:"cronExpression" yaml:"cronExpression"` // The name of the schedule. Name *string `field:"required" json:"name" yaml:"name"` // A list of jobs to be run, according to the schedule. JobNames *[]*string `field:"optional" json:"jobNames" yaml:"jobNames"` // Metadata tags that have been applied to the schedule. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSchedule`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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"), }, }, }
Source Files ¶
- CfnDataset.go
- CfnDatasetProps.go
- CfnDataset_CsvOptionsProperty.go
- CfnDataset_DataCatalogInputDefinitionProperty.go
- CfnDataset_DatabaseInputDefinitionProperty.go
- CfnDataset_DatasetParameterProperty.go
- CfnDataset_DatetimeOptionsProperty.go
- CfnDataset_ExcelOptionsProperty.go
- CfnDataset_FilesLimitProperty.go
- CfnDataset_FilterExpressionProperty.go
- CfnDataset_FilterValueProperty.go
- CfnDataset_FormatOptionsProperty.go
- CfnDataset_InputProperty.go
- CfnDataset_JsonOptionsProperty.go
- CfnDataset_MetadataProperty.go
- CfnDataset_PathOptionsProperty.go
- CfnDataset_PathParameterProperty.go
- CfnDataset_S3LocationProperty.go
- CfnDataset__checks.go
- CfnJob.go
- CfnJobProps.go
- CfnJob_AllowedStatisticsProperty.go
- CfnJob_ColumnSelectorProperty.go
- CfnJob_ColumnStatisticsConfigurationProperty.go
- CfnJob_CsvOutputOptionsProperty.go
- CfnJob_DataCatalogOutputProperty.go
- CfnJob_DatabaseOutputProperty.go
- CfnJob_DatabaseTableOutputOptionsProperty.go
- CfnJob_EntityDetectorConfigurationProperty.go
- CfnJob_JobSampleProperty.go
- CfnJob_OutputFormatOptionsProperty.go
- CfnJob_OutputLocationProperty.go
- CfnJob_OutputProperty.go
- CfnJob_ProfileConfigurationProperty.go
- CfnJob_RecipeProperty.go
- CfnJob_S3LocationProperty.go
- CfnJob_S3TableOutputOptionsProperty.go
- CfnJob_StatisticOverrideProperty.go
- CfnJob_StatisticsConfigurationProperty.go
- CfnJob_ValidationConfigurationProperty.go
- CfnJob__checks.go
- CfnProject.go
- CfnProjectProps.go
- CfnProject_SampleProperty.go
- CfnProject__checks.go
- CfnRecipe.go
- CfnRecipeProps.go
- CfnRecipe_ActionProperty.go
- CfnRecipe_ConditionExpressionProperty.go
- CfnRecipe_DataCatalogInputDefinitionProperty.go
- CfnRecipe_InputProperty.go
- CfnRecipe_RecipeParametersProperty.go
- CfnRecipe_RecipeStepProperty.go
- CfnRecipe_S3LocationProperty.go
- CfnRecipe_SecondaryInputProperty.go
- CfnRecipe__checks.go
- CfnRuleset.go
- CfnRulesetProps.go
- CfnRuleset_ColumnSelectorProperty.go
- CfnRuleset_RuleProperty.go
- CfnRuleset_SubstitutionValueProperty.go
- CfnRuleset_ThresholdProperty.go
- CfnRuleset__checks.go
- CfnSchedule.go
- CfnScheduleProps.go
- CfnSchedule__checks.go
- main.go